| 1 | Guile NEWS --- history of user-visible changes. -*- text -*- |
| 2 | Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. |
| 3 | See the end for copying conditions. |
| 4 | |
| 5 | Please send Guile bug reports to bug-guile@gnu.org. |
| 6 | \f |
| 7 | Changes since the stable branch: |
| 8 | |
| 9 | ** Variables have no longer a special behavior for `equal?'. |
| 10 | |
| 11 | Previously, comparing two variables with `equal?' would recursivly |
| 12 | compare their values. This is no longer done. Variables are now only |
| 13 | `equal?' if they are `eq?'. |
| 14 | |
| 15 | Changes since Guile 1.4: |
| 16 | |
| 17 | * Changes to the distribution |
| 18 | |
| 19 | ** A top-level TODO file is included. |
| 20 | |
| 21 | ** Guile now uses a versioning scheme similar to that of the Linux kernel. |
| 22 | |
| 23 | Guile now always uses three numbers to represent the version, |
| 24 | i.e. "1.6.5". The first number, 1, is the major version number, the |
| 25 | second number, 6, is the minor version number, and the third number, |
| 26 | 5, is the micro version number. Changes in major version number |
| 27 | indicate major changes in Guile. |
| 28 | |
| 29 | Minor version numbers that are even denote stable releases, and odd |
| 30 | minor version numbers denote development versions (which may be |
| 31 | unstable). The micro version number indicates a minor sub-revision of |
| 32 | a given MAJOR.MINOR release. |
| 33 | |
| 34 | In keeping with the new scheme, (minor-version) and scm_minor_version |
| 35 | no longer return everything but the major version number. They now |
| 36 | just return the minor version number. Two new functions |
| 37 | (micro-version) and scm_micro_version have been added to report the |
| 38 | micro version number. |
| 39 | |
| 40 | In addition, ./GUILE-VERSION now defines GUILE_MICRO_VERSION. |
| 41 | |
| 42 | ** Guile now actively warns about deprecated features. |
| 43 | |
| 44 | The new configure option `--enable-deprecated=LEVEL' and the |
| 45 | environment variable GUILE_WARN_DEPRECATED control this mechanism. |
| 46 | See INSTALL and README for more information. |
| 47 | |
| 48 | ** New functions: setitimer and getitimer. |
| 49 | |
| 50 | These implement a fairly direct interface to the libc functions of the |
| 51 | same name. |
| 52 | |
| 53 | ** The #. reader extension is now disabled by default. |
| 54 | |
| 55 | For safety reasons, #. evaluation is disabled by default. To |
| 56 | re-enable it, set the fluid read-eval? to #t. For example: |
| 57 | |
| 58 | (fluid-set! read-eval? #t) |
| 59 | |
| 60 | but make sure you realize the potential security risks involved. With |
| 61 | read-eval? enabled, reading a data file from an untrusted source can |
| 62 | be dangerous. |
| 63 | |
| 64 | ** New SRFI modules have been added: |
| 65 | |
| 66 | SRFI-0 `cond-expand' is now supported in Guile, without requiring |
| 67 | using a module. |
| 68 | |
| 69 | (srfi srfi-1) is a library containing many useful pair- and list-processing |
| 70 | procedures. |
| 71 | |
| 72 | (srfi srfi-2) exports and-let*. |
| 73 | |
| 74 | (srfi srfi-4) implements homogeneous numeric vector datatypes. |
| 75 | |
| 76 | (srfi srfi-6) is a dummy module for now, since guile already provides |
| 77 | all of the srfi-6 procedures by default: open-input-string, |
| 78 | open-output-string, get-output-string. |
| 79 | |
| 80 | (srfi srfi-8) exports receive. |
| 81 | |
| 82 | (srfi srfi-9) exports define-record-type. |
| 83 | |
| 84 | (srfi srfi-10) exports define-reader-ctor and implements the reader |
| 85 | extension #,(). |
| 86 | |
| 87 | (srfi srfi-11) exports let-values and let*-values. |
| 88 | |
| 89 | (srfi srfi-13) implements the SRFI String Library. |
| 90 | |
| 91 | (srfi srfi-14) implements the SRFI Character-Set Library. |
| 92 | |
| 93 | (srfi srfi-17) implements setter and getter-with-setter and redefines |
| 94 | some accessor procedures as procedures with getters. (such as car, |
| 95 | cdr, vector-ref etc.) |
| 96 | |
| 97 | (srfi srfi-19) implements the SRFI Time/Date Library. |
| 98 | |
| 99 | ** New scripts / "executable modules" |
| 100 | |
| 101 | Subdirectory "scripts" contains Scheme modules that are packaged to |
| 102 | also be executable as scripts. At this time, these scripts are available: |
| 103 | |
| 104 | display-commentary |
| 105 | doc-snarf |
| 106 | generate-autoload |
| 107 | punify |
| 108 | read-scheme-source |
| 109 | use2dot |
| 110 | |
| 111 | See README there for more info. |
| 112 | |
| 113 | These scripts can be invoked from the shell with the new program |
| 114 | "guile-tools", which keeps track of installation directory for you. |
| 115 | For example: |
| 116 | |
| 117 | $ guile-tools display-commentary srfi/*.scm |
| 118 | |
| 119 | guile-tools is copied to the standard $bindir on "make install". |
| 120 | |
| 121 | ** New module (ice-9 stack-catch): |
| 122 | |
| 123 | stack-catch is like catch, but saves the current state of the stack in |
| 124 | the fluid the-last-stack. This fluid can be useful when using the |
| 125 | debugger and when re-throwing an error. |
| 126 | |
| 127 | ** The module (ice-9 and-let*) has been renamed to (ice-9 and-let-star) |
| 128 | |
| 129 | This has been done to prevent problems on lesser operating systems |
| 130 | that can't tolerate `*'s in file names. The exported macro continues |
| 131 | to be named `and-let*', of course. |
| 132 | |
| 133 | On systems that support it, there is also a compatibility module named |
| 134 | (ice-9 and-let*). It will go away in the next release. |
| 135 | |
| 136 | ** New modules (oop goops) etc.: |
| 137 | |
| 138 | (oop goops) |
| 139 | (oop goops describe) |
| 140 | (oop goops save) |
| 141 | (oop goops active-slot) |
| 142 | (oop goops composite-slot) |
| 143 | |
| 144 | The Guile Object Oriented Programming System (GOOPS) has been |
| 145 | integrated into Guile. For further information, consult the GOOPS |
| 146 | manual and tutorial in the `doc' directory. |
| 147 | |
| 148 | ** New module (ice-9 rdelim). |
| 149 | |
| 150 | This exports the following procedures which were previously defined |
| 151 | in the default environment: |
| 152 | |
| 153 | read-line read-line! read-delimited read-delimited! %read-delimited! |
| 154 | %read-line write-line |
| 155 | |
| 156 | For backwards compatibility the definitions are still imported into the |
| 157 | default environment in this version of Guile. However you should add: |
| 158 | |
| 159 | (use-modules (ice-9 rdelim)) |
| 160 | |
| 161 | to any program which uses the definitions, since this may change in |
| 162 | future. |
| 163 | |
| 164 | Alternatively, if guile-scsh is installed, the (scsh rdelim) module |
| 165 | can be used for similar functionality. |
| 166 | |
| 167 | ** New module (ice-9 rw) |
| 168 | |
| 169 | This is a subset of the (scsh rw) module from guile-scsh. Currently |
| 170 | it defines two procedures: |
| 171 | |
| 172 | *** New function: read-string!/partial str [port_or_fdes [start [end]]] |
| 173 | |
| 174 | Read characters from a port or file descriptor into a string STR. |
| 175 | A port must have an underlying file descriptor -- a so-called |
| 176 | fport. This procedure is scsh-compatible and can efficiently read |
| 177 | large strings. |
| 178 | |
| 179 | *** New function: write-string/partial str [port_or_fdes [start [end]]] |
| 180 | |
| 181 | Write characters from a string STR to a port or file descriptor. |
| 182 | A port must have an underlying file descriptor -- a so-called |
| 183 | fport. This procedure is mostly compatible and can efficiently |
| 184 | write large strings. |
| 185 | |
| 186 | ** New module (ice-9 match) |
| 187 | |
| 188 | This module includes Andrew K. Wright's pattern matcher. See |
| 189 | ice-9/match.scm for brief description or |
| 190 | |
| 191 | http://www.star-lab.com/wright/code.html |
| 192 | |
| 193 | for complete documentation. |
| 194 | |
| 195 | ** New module (ice-9 buffered-input) |
| 196 | |
| 197 | This module provides procedures to construct an input port from an |
| 198 | underlying source of input that reads and returns its input in chunks. |
| 199 | The underlying input source is a Scheme procedure, specified by the |
| 200 | caller, which the port invokes whenever it needs more input. |
| 201 | |
| 202 | This is useful when building an input port whose back end is Readline |
| 203 | or a UI element such as the GtkEntry widget. |
| 204 | |
| 205 | ** Documentation |
| 206 | |
| 207 | The reference and tutorial documentation that was previously |
| 208 | distributed separately, as `guile-doc', is now included in the core |
| 209 | Guile distribution. The documentation consists of the following |
| 210 | manuals. |
| 211 | |
| 212 | - The Guile Tutorial (guile-tut.texi) contains a tutorial introduction |
| 213 | to using Guile. |
| 214 | |
| 215 | - The Guile Reference Manual (guile.texi) contains (or is intended to |
| 216 | contain) reference documentation on all aspects of Guile. |
| 217 | |
| 218 | - The GOOPS Manual (goops.texi) contains both tutorial-style and |
| 219 | reference documentation for using GOOPS, Guile's Object Oriented |
| 220 | Programming System. |
| 221 | |
| 222 | - The Revised^5 Report on the Algorithmic Language Scheme |
| 223 | (r5rs.texi). |
| 224 | |
| 225 | See the README file in the `doc' directory for more details. |
| 226 | |
| 227 | ** There are a couple of examples in the examples/ directory now. |
| 228 | |
| 229 | * Changes to the stand-alone interpreter |
| 230 | |
| 231 | ** New command line option `--use-srfi' |
| 232 | |
| 233 | Using this option, SRFI modules can be loaded on startup and be |
| 234 | available right from the beginning. This makes programming portable |
| 235 | Scheme programs easier. |
| 236 | |
| 237 | The option `--use-srfi' expects a comma-separated list of numbers, |
| 238 | each representing a SRFI number to be loaded into the interpreter |
| 239 | before starting evaluating a script file or the REPL. Additionally, |
| 240 | the feature identifier for the loaded SRFIs is recognized by |
| 241 | `cond-expand' when using this option. |
| 242 | |
| 243 | Example: |
| 244 | $ guile --use-srfi=8,13 |
| 245 | guile> (receive (x z) (values 1 2) (+ 1 2)) |
| 246 | 3 |
| 247 | guile> (string-pad "bla" 20) |
| 248 | " bla" |
| 249 | |
| 250 | ** Guile now always starts up in the `(guile-user)' module. |
| 251 | |
| 252 | Previously, scripts executed via the `-s' option would run in the |
| 253 | `(guile)' module and the repl would run in the `(guile-user)' module. |
| 254 | Now every user action takes place in the `(guile-user)' module by |
| 255 | default. |
| 256 | |
| 257 | * Changes to Scheme functions and syntax |
| 258 | |
| 259 | ** Character classifiers work for non-ASCII characters. |
| 260 | |
| 261 | The predicates `char-alphabetic?', `char-numeric?', |
| 262 | `char-whitespace?', `char-lower?', `char-upper?' and `char-is-both?' |
| 263 | no longer check whether their arguments are ASCII characters. |
| 264 | Previously, a character would only be considered alphabetic when it |
| 265 | was also ASCII, for example. |
| 266 | |
| 267 | ** Previously deprecated Scheme functions have been removed: |
| 268 | |
| 269 | tag - no replacement. |
| 270 | fseek - replaced by seek. |
| 271 | list* - replaced by cons*. |
| 272 | |
| 273 | ** It's now possible to create modules with controlled environments |
| 274 | |
| 275 | Example: |
| 276 | |
| 277 | (use-modules (ice-9 safe)) |
| 278 | (define m (make-safe-module)) |
| 279 | ;;; m will now be a module containing only a safe subset of R5RS |
| 280 | (eval '(+ 1 2) m) --> 3 |
| 281 | (eval 'load m) --> ERROR: Unbound variable: load |
| 282 | |
| 283 | ** Evaluation of "()", the empty list, is now an error. |
| 284 | |
| 285 | Previously, the expression "()" evaluated to the empty list. This has |
| 286 | been changed to signal a "missing expression" error. The correct way |
| 287 | to write the empty list as a literal constant is to use quote: "'()". |
| 288 | |
| 289 | ** New concept of `Guile Extensions'. |
| 290 | |
| 291 | A Guile Extension is just a ordinary shared library that can be linked |
| 292 | at run-time. We found it advantageous to give this simple concept a |
| 293 | dedicated name to distinguish the issues related to shared libraries |
| 294 | from the issues related to the module system. |
| 295 | |
| 296 | *** New function: load-extension |
| 297 | |
| 298 | Executing (load-extension lib init) is mostly equivalent to |
| 299 | |
| 300 | (dynamic-call init (dynamic-link lib)) |
| 301 | |
| 302 | except when scm_register_extension has been called previously. |
| 303 | Whenever appropriate, you should use `load-extension' instead of |
| 304 | dynamic-link and dynamic-call. |
| 305 | |
| 306 | *** New C function: scm_c_register_extension |
| 307 | |
| 308 | This function registers a initialization function for use by |
| 309 | `load-extension'. Use it when you don't want specific extensions to |
| 310 | be loaded as shared libraries (for example on platforms that don't |
| 311 | support dynamic linking). |
| 312 | |
| 313 | ** Auto-loading of compiled-code modules is deprecated. |
| 314 | |
| 315 | Guile used to be able to automatically find and link a shared |
| 316 | library to satisfy requests for a module. For example, the module |
| 317 | `(foo bar)' could be implemented by placing a shared library named |
| 318 | "foo/libbar.so" (or with a different extension) in a directory on the |
| 319 | load path of Guile. |
| 320 | |
| 321 | This has been found to be too tricky, and is no longer supported. The |
| 322 | shared libraries are now called "extensions". You should now write a |
| 323 | small Scheme file that calls `load-extension' to load the shared |
| 324 | library and initialize it explicitely. |
| 325 | |
| 326 | The shared libraries themselves should be installed in the usual |
| 327 | places for shared libraries, with names like "libguile-foo-bar". |
| 328 | |
| 329 | For example, place this into a file "foo/bar.scm" |
| 330 | |
| 331 | (define-module (foo bar)) |
| 332 | |
| 333 | (load-extension "libguile-foo-bar" "foobar_init") |
| 334 | |
| 335 | ** Backward incompatible change: eval EXP ENVIRONMENT-SPECIFIER |
| 336 | |
| 337 | `eval' is now R5RS, that is it takes two arguments. |
| 338 | The second argument is an environment specifier, i.e. either |
| 339 | |
| 340 | (scheme-report-environment 5) |
| 341 | (null-environment 5) |
| 342 | (interaction-environment) |
| 343 | |
| 344 | or |
| 345 | |
| 346 | any module. |
| 347 | |
| 348 | ** The module system has been made more disciplined. |
| 349 | |
| 350 | The function `eval' will save and restore the current module around |
| 351 | the evaluation of the specified expression. While this expression is |
| 352 | evaluated, `(current-module)' will now return the right module, which |
| 353 | is the module specified as the second argument to `eval'. |
| 354 | |
| 355 | A consequence of this change is that `eval' is not particularly |
| 356 | useful when you want allow the evaluated code to change what module is |
| 357 | designated as the current module and have this change persist from one |
| 358 | call to `eval' to the next. The read-eval-print-loop is an example |
| 359 | where `eval' is now inadequate. To compensate, there is a new |
| 360 | function `primitive-eval' that does not take a module specifier and |
| 361 | that does not save/restore the current module. You should use this |
| 362 | function together with `set-current-module', `current-module', etc |
| 363 | when you want to have more control over the state that is carried from |
| 364 | one eval to the next. |
| 365 | |
| 366 | Additionally, it has been made sure that forms that are evaluated at |
| 367 | the top level are always evaluated with respect to the current module. |
| 368 | Previously, subforms of top-level forms such as `begin', `case', |
| 369 | etc. did not respect changes to the current module although these |
| 370 | subforms are at the top-level as well. |
| 371 | |
| 372 | To prevent strange behavior, the forms `define-module', |
| 373 | `use-modules', `use-syntax', and `export' have been restricted to only |
| 374 | work on the top level. The forms `define-public' and |
| 375 | `defmacro-public' only export the new binding on the top level. They |
| 376 | behave just like `define' and `defmacro', respectively, when they are |
| 377 | used in a lexical environment. |
| 378 | |
| 379 | Also, `export' will no longer silently re-export bindings imported |
| 380 | from a used module. It will emit a `deprecation' warning and will |
| 381 | cease to perform any re-export in the next version. If you actually |
| 382 | want to re-export bindings, use the new `re-export' in place of |
| 383 | `export'. The new `re-export' will not make copies of variables when |
| 384 | rexporting them, as `export' did wrongly. |
| 385 | |
| 386 | ** Module system now allows selection and renaming of imported bindings |
| 387 | |
| 388 | Previously, when using `use-modules' or the `#:use-module' clause in |
| 389 | the `define-module' form, all the bindings (association of symbols to |
| 390 | values) for imported modules were added to the "current module" on an |
| 391 | as-is basis. This has been changed to allow finer control through two |
| 392 | new facilities: selection and renaming. |
| 393 | |
| 394 | You can now select which of the imported module's bindings are to be |
| 395 | visible in the current module by using the `:select' clause. This |
| 396 | clause also can be used to rename individual bindings. For example: |
| 397 | |
| 398 | ;; import all bindings no questions asked |
| 399 | (use-modules (ice-9 common-list)) |
| 400 | |
| 401 | ;; import four bindings, renaming two of them; |
| 402 | ;; the current module sees: every some zonk-y zonk-n |
| 403 | (use-modules ((ice-9 common-list) |
| 404 | :select (every some |
| 405 | (remove-if . zonk-y) |
| 406 | (remove-if-not . zonk-n)))) |
| 407 | |
| 408 | You can also programmatically rename all selected bindings using the |
| 409 | `:renamer' clause, which specifies a proc that takes a symbol and |
| 410 | returns another symbol. Because it is common practice to use a prefix, |
| 411 | we now provide the convenience procedure `symbol-prefix-proc'. For |
| 412 | example: |
| 413 | |
| 414 | ;; import four bindings, renaming two of them specifically, |
| 415 | ;; and all four w/ prefix "CL:"; |
| 416 | ;; the current module sees: CL:every CL:some CL:zonk-y CL:zonk-n |
| 417 | (use-modules ((ice-9 common-list) |
| 418 | :select (every some |
| 419 | (remove-if . zonk-y) |
| 420 | (remove-if-not . zonk-n)) |
| 421 | :renamer (symbol-prefix-proc 'CL:))) |
| 422 | |
| 423 | ;; import four bindings, renaming two of them specifically, |
| 424 | ;; and all four by upcasing. |
| 425 | ;; the current module sees: EVERY SOME ZONK-Y ZONK-N |
| 426 | (define (upcase-symbol sym) |
| 427 | (string->symbol (string-upcase (symbol->string sym)))) |
| 428 | |
| 429 | (use-modules ((ice-9 common-list) |
| 430 | :select (every some |
| 431 | (remove-if . zonk-y) |
| 432 | (remove-if-not . zonk-n)) |
| 433 | :renamer upcase-symbol)) |
| 434 | |
| 435 | Note that programmatic renaming is done *after* individual renaming. |
| 436 | Also, the above examples show `use-modules', but the same facilities are |
| 437 | available for the `#:use-module' clause of `define-module'. |
| 438 | |
| 439 | See manual for more info. |
| 440 | |
| 441 | ** The semantics of guardians have changed. |
| 442 | |
| 443 | The changes are for the most part compatible. An important criterion |
| 444 | was to keep the typical usage of guardians as simple as before, but to |
| 445 | make the semantics safer and (as a result) more useful. |
| 446 | |
| 447 | *** All objects returned from guardians are now properly alive. |
| 448 | |
| 449 | It is now guaranteed that any object referenced by an object returned |
| 450 | from a guardian is alive. It's now impossible for a guardian to |
| 451 | return a "contained" object before its "containing" object. |
| 452 | |
| 453 | One incompatible (but probably not very important) change resulting |
| 454 | from this is that it is no longer possible to guard objects that |
| 455 | indirectly reference themselves (i.e. are parts of cycles). If you do |
| 456 | so accidentally, you'll get a warning. |
| 457 | |
| 458 | *** There are now two types of guardians: greedy and sharing. |
| 459 | |
| 460 | If you call (make-guardian #t) or just (make-guardian), you'll get a |
| 461 | greedy guardian, and for (make-guardian #f) a sharing guardian. |
| 462 | |
| 463 | Greedy guardians are the default because they are more "defensive". |
| 464 | You can only greedily guard an object once. If you guard an object |
| 465 | more than once, once in a greedy guardian and the rest of times in |
| 466 | sharing guardians, then it is guaranteed that the object won't be |
| 467 | returned from sharing guardians as long as it is greedily guarded |
| 468 | and/or alive. |
| 469 | |
| 470 | Guardians returned by calls to `make-guardian' can now take one more |
| 471 | optional parameter, which says whether to throw an error in case an |
| 472 | attempt is made to greedily guard an object that is already greedily |
| 473 | guarded. The default is true, i.e. throw an error. If the parameter |
| 474 | is false, the guardian invocation returns #t if guarding was |
| 475 | successful and #f if it wasn't. |
| 476 | |
| 477 | Also, since greedy guarding is, in effect, a side-effecting operation |
| 478 | on objects, a new function is introduced: `destroy-guardian!'. |
| 479 | Invoking this function on a guardian renders it unoperative and, if |
| 480 | the guardian is greedy, clears the "greedily guarded" property of the |
| 481 | objects that were guarded by it, thus undoing the side effect. |
| 482 | |
| 483 | Note that all this hair is hardly very important, since guardian |
| 484 | objects are usually permanent. |
| 485 | |
| 486 | ** Continuations created by call-with-current-continuation now accept |
| 487 | any number of arguments, as required by R5RS. |
| 488 | |
| 489 | ** New function `issue-deprecation-warning' |
| 490 | |
| 491 | This function is used to display the deprecation messages that are |
| 492 | controlled by GUILE_WARN_DEPRECATION as explained in the README. |
| 493 | |
| 494 | (define (id x) |
| 495 | (issue-deprecation-warning "`id' is deprecated. Use `identity' instead.") |
| 496 | (identity x)) |
| 497 | |
| 498 | guile> (id 1) |
| 499 | ;; `id' is deprecated. Use `identity' instead. |
| 500 | 1 |
| 501 | guile> (id 1) |
| 502 | 1 |
| 503 | |
| 504 | ** New syntax `begin-deprecated' |
| 505 | |
| 506 | When deprecated features are included (as determined by the configure |
| 507 | option --enable-deprecated), `begin-deprecated' is identical to |
| 508 | `begin'. When deprecated features are excluded, it always evaluates |
| 509 | to `#f', ignoring the body forms. |
| 510 | |
| 511 | ** New function `make-object-property' |
| 512 | |
| 513 | This function returns a new `procedure with setter' P that can be used |
| 514 | to attach a property to objects. When calling P as |
| 515 | |
| 516 | (set! (P obj) val) |
| 517 | |
| 518 | where `obj' is any kind of object, it attaches `val' to `obj' in such |
| 519 | a way that it can be retrieved by calling P as |
| 520 | |
| 521 | (P obj) |
| 522 | |
| 523 | This function will replace procedure properties, symbol properties and |
| 524 | source properties eventually. |
| 525 | |
| 526 | ** Module (ice-9 optargs) now uses keywords instead of `#&'. |
| 527 | |
| 528 | Instead of #&optional, #&key, etc you should now use #:optional, |
| 529 | #:key, etc. Since #:optional is a keyword, you can write it as just |
| 530 | :optional when (read-set! keywords 'prefix) is active. |
| 531 | |
| 532 | The old reader syntax `#&' is still supported, but deprecated. It |
| 533 | will be removed in the next release. |
| 534 | |
| 535 | ** New define-module option: pure |
| 536 | |
| 537 | Tells the module system not to include any bindings from the root |
| 538 | module. |
| 539 | |
| 540 | Example: |
| 541 | |
| 542 | (define-module (totally-empty-module) |
| 543 | :pure) |
| 544 | |
| 545 | ** New define-module option: export NAME1 ... |
| 546 | |
| 547 | Export names NAME1 ... |
| 548 | |
| 549 | This option is required if you want to be able to export bindings from |
| 550 | a module which doesn't import one of `define-public' or `export'. |
| 551 | |
| 552 | Example: |
| 553 | |
| 554 | (define-module (foo) |
| 555 | :pure |
| 556 | :use-module (ice-9 r5rs) |
| 557 | :export (bar)) |
| 558 | |
| 559 | ;;; Note that we're pure R5RS below this point! |
| 560 | |
| 561 | (define (bar) |
| 562 | ...) |
| 563 | |
| 564 | ** New function: object->string OBJ |
| 565 | |
| 566 | Return a Scheme string obtained by printing a given object. |
| 567 | |
| 568 | ** New function: port? X |
| 569 | |
| 570 | Returns a boolean indicating whether X is a port. Equivalent to |
| 571 | `(or (input-port? X) (output-port? X))'. |
| 572 | |
| 573 | ** New function: file-port? |
| 574 | |
| 575 | Determines whether a given object is a port that is related to a file. |
| 576 | |
| 577 | ** New function: port-for-each proc |
| 578 | |
| 579 | Apply PROC to each port in the Guile port table in turn. The return |
| 580 | value is unspecified. More specifically, PROC is applied exactly once |
| 581 | to every port that exists in the system at the time PORT-FOR-EACH is |
| 582 | invoked. Changes to the port table while PORT-FOR-EACH is running |
| 583 | have no effect as far as PORT-FOR-EACH is concerned. |
| 584 | |
| 585 | ** New function: dup2 oldfd newfd |
| 586 | |
| 587 | A simple wrapper for the `dup2' system call. Copies the file |
| 588 | descriptor OLDFD to descriptor number NEWFD, replacing the |
| 589 | previous meaning of NEWFD. Both OLDFD and NEWFD must be integers. |
| 590 | Unlike for dup->fdes or primitive-move->fdes, no attempt is made |
| 591 | to move away ports which are using NEWFD. The return value is |
| 592 | unspecified. |
| 593 | |
| 594 | ** New function: close-fdes fd |
| 595 | |
| 596 | A simple wrapper for the `close' system call. Close file |
| 597 | descriptor FD, which must be an integer. Unlike close (*note |
| 598 | close: Ports and File Descriptors.), the file descriptor will be |
| 599 | closed even if a port is using it. The return value is |
| 600 | unspecified. |
| 601 | |
| 602 | ** New function: crypt password salt |
| 603 | |
| 604 | Encrypts `password' using the standard unix password encryption |
| 605 | algorithm. |
| 606 | |
| 607 | ** New function: chroot path |
| 608 | |
| 609 | Change the root directory of the running process to `path'. |
| 610 | |
| 611 | ** New functions: getlogin, cuserid |
| 612 | |
| 613 | Return the login name or the user name of the current effective user |
| 614 | id, respectively. |
| 615 | |
| 616 | ** New functions: getpriority which who, setpriority which who prio |
| 617 | |
| 618 | Get or set the priority of the running process. |
| 619 | |
| 620 | ** New function: getpass prompt |
| 621 | |
| 622 | Read a password from the terminal, first displaying `prompt' and |
| 623 | disabling echoing. |
| 624 | |
| 625 | ** New function: flock file operation |
| 626 | |
| 627 | Set/remove an advisory shared or exclusive lock on `file'. |
| 628 | |
| 629 | ** New functions: sethostname name, gethostname |
| 630 | |
| 631 | Set or get the hostname of the machine the current process is running |
| 632 | on. |
| 633 | |
| 634 | ** New function: mkstemp! tmpl |
| 635 | |
| 636 | mkstemp creates a new unique file in the file system and returns a |
| 637 | new buffered port open for reading and writing to the file. TMPL |
| 638 | is a string specifying where the file should be created: it must |
| 639 | end with `XXXXXX' and will be changed in place to return the name |
| 640 | of the temporary file. |
| 641 | |
| 642 | ** New function: open-input-string string |
| 643 | |
| 644 | Return an input string port which delivers the characters from |
| 645 | `string'. This procedure, together with `open-output-string' and |
| 646 | `get-output-string' implements SRFI-6. |
| 647 | |
| 648 | ** New function: open-output-string |
| 649 | |
| 650 | Return an output string port which collects all data written to it. |
| 651 | The data can then be retrieved by `get-output-string'. |
| 652 | |
| 653 | ** New function: get-output-string |
| 654 | |
| 655 | Return the contents of an output string port. |
| 656 | |
| 657 | ** New function: identity |
| 658 | |
| 659 | Return the argument. |
| 660 | |
| 661 | ** socket, connect, accept etc., now have support for IPv6. IPv6 addresses |
| 662 | are represented in Scheme as integers with normal host byte ordering. |
| 663 | |
| 664 | ** New function: inet-pton family address |
| 665 | |
| 666 | Convert a printable string network address into an integer. Note that |
| 667 | unlike the C version of this function, the result is an integer with |
| 668 | normal host byte ordering. FAMILY can be `AF_INET' or `AF_INET6'. |
| 669 | e.g., |
| 670 | |
| 671 | (inet-pton AF_INET "127.0.0.1") => 2130706433 |
| 672 | (inet-pton AF_INET6 "::1") => 1 |
| 673 | |
| 674 | ** New function: inet-ntop family address |
| 675 | |
| 676 | Convert an integer network address into a printable string. Note that |
| 677 | unlike the C version of this function, the input is an integer with |
| 678 | normal host byte ordering. FAMILY can be `AF_INET' or `AF_INET6'. |
| 679 | e.g., |
| 680 | |
| 681 | (inet-ntop AF_INET 2130706433) => "127.0.0.1" |
| 682 | (inet-ntop AF_INET6 (- (expt 2 128) 1)) => |
| 683 | ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff |
| 684 | |
| 685 | ** Deprecated: id |
| 686 | |
| 687 | Use `identity' instead. |
| 688 | |
| 689 | ** Deprecated: -1+ |
| 690 | |
| 691 | Use `1-' instead. |
| 692 | |
| 693 | ** Deprecated: return-it |
| 694 | |
| 695 | Do without it. |
| 696 | |
| 697 | ** Deprecated: string-character-length |
| 698 | |
| 699 | Use `string-length' instead. |
| 700 | |
| 701 | ** Deprecated: flags |
| 702 | |
| 703 | Use `logior' instead. |
| 704 | |
| 705 | ** Deprecated: close-all-ports-except. |
| 706 | |
| 707 | This was intended for closing ports in a child process after a fork, |
| 708 | but it has the undesirable side effect of flushing buffers. |
| 709 | port-for-each is more flexible. |
| 710 | |
| 711 | ** The (ice-9 popen) module now attempts to set up file descriptors in |
| 712 | the child process from the current Scheme ports, instead of using the |
| 713 | current values of file descriptors 0, 1, and 2 in the parent process. |
| 714 | |
| 715 | ** Removed function: builtin-weak-bindings |
| 716 | |
| 717 | There is no such concept as a weak binding any more. |
| 718 | |
| 719 | ** Removed constants: bignum-radix, scm-line-incrementors |
| 720 | |
| 721 | ** define-method: New syntax mandatory. |
| 722 | |
| 723 | The new method syntax is now mandatory: |
| 724 | |
| 725 | (define-method (NAME ARG-SPEC ...) BODY ...) |
| 726 | (define-method (NAME ARG-SPEC ... . REST-ARG) BODY ...) |
| 727 | |
| 728 | ARG-SPEC ::= ARG-NAME | (ARG-NAME TYPE) |
| 729 | REST-ARG ::= ARG-NAME |
| 730 | |
| 731 | If you have old code using the old syntax, import |
| 732 | (oop goops old-define-method) before (oop goops) as in: |
| 733 | |
| 734 | (use-modules (oop goops old-define-method) (oop goops)) |
| 735 | |
| 736 | ** Deprecated function: builtin-variable |
| 737 | Removed function: builtin-bindings |
| 738 | |
| 739 | There is no longer a distinction between builtin or other variables. |
| 740 | Use module system operations for all variables. |
| 741 | |
| 742 | ** Lazy-catch handlers are no longer allowed to return. |
| 743 | |
| 744 | That is, a call to `throw', `error', etc is now guaranteed to not |
| 745 | return. |
| 746 | |
| 747 | ** Bugfixes for (ice-9 getopt-long) |
| 748 | |
| 749 | This module is now tested using test-suite/tests/getopt-long.test. |
| 750 | The following bugs have been fixed: |
| 751 | |
| 752 | *** Parsing for options that are specified to have `optional' args now checks |
| 753 | if the next element is an option instead of unconditionally taking it as the |
| 754 | option arg. |
| 755 | |
| 756 | *** An error is now thrown for `--opt=val' when the option description |
| 757 | does not specify `(value #t)' or `(value optional)'. This condition used to |
| 758 | be accepted w/o error, contrary to the documentation. |
| 759 | |
| 760 | *** The error message for unrecognized options is now more informative. |
| 761 | It used to be "not a record", an artifact of the implementation. |
| 762 | |
| 763 | *** The error message for `--opt' terminating the arg list (no value), when |
| 764 | `(value #t)' is specified, is now more informative. It used to be "not enough |
| 765 | args". |
| 766 | |
| 767 | *** "Clumped" single-char args now preserve trailing string, use it as arg. |
| 768 | The expansion used to be like so: |
| 769 | |
| 770 | ("-abc5d" "--xyz") => ("-a" "-b" "-c" "--xyz") |
| 771 | |
| 772 | Note that the "5d" is dropped. Now it is like so: |
| 773 | |
| 774 | ("-abc5d" "--xyz") => ("-a" "-b" "-c" "5d" "--xyz") |
| 775 | |
| 776 | This enables single-char options to have adjoining arguments as long as their |
| 777 | constituent characters are not potential single-char options. |
| 778 | |
| 779 | * Changes to the C interface |
| 780 | |
| 781 | ** Types have been renamed from scm_*_t to scm_t_*. |
| 782 | |
| 783 | This has been done for POSIX sake. It reserves identifiers ending |
| 784 | with "_t". What a concept. |
| 785 | |
| 786 | The old names are still available with status `deprecated'. |
| 787 | |
| 788 | ** scm_t_bits (former scm_bits_t) is now a unsigned type. |
| 789 | |
| 790 | ** Deprecated features have been removed. |
| 791 | |
| 792 | *** Macros removed |
| 793 | |
| 794 | SCM_INPORTP, SCM_OUTPORTP SCM_ICHRP, SCM_ICHR, SCM_MAKICHR |
| 795 | SCM_SETJMPBUF SCM_NSTRINGP SCM_NRWSTRINGP SCM_NVECTORP SCM_DOUBLE_CELLP |
| 796 | |
| 797 | *** C Functions removed |
| 798 | |
| 799 | scm_sysmissing scm_tag scm_tc16_flo scm_tc_flo |
| 800 | scm_fseek - replaced by scm_seek. |
| 801 | gc-thunk - replaced by after-gc-hook. |
| 802 | gh_int2scmb - replaced by gh_bool2scm. |
| 803 | scm_tc_dblr - replaced by scm_tc16_real. |
| 804 | scm_tc_dblc - replaced by scm_tc16_complex. |
| 805 | scm_list_star - replaced by scm_cons_star. |
| 806 | |
| 807 | ** Deprecated: scm_makfromstr |
| 808 | |
| 809 | Use scm_mem2string instead. |
| 810 | |
| 811 | ** Deprecated: scm_make_shared_substring |
| 812 | |
| 813 | Explicit shared substrings will disappear from Guile. |
| 814 | |
| 815 | Instead, "normal" strings will be implemented using sharing |
| 816 | internally, combined with a copy-on-write strategy. |
| 817 | |
| 818 | ** Deprecated: scm_read_only_string_p |
| 819 | |
| 820 | The concept of read-only strings will disappear in next release of |
| 821 | Guile. |
| 822 | |
| 823 | ** Deprecated: scm_sloppy_memq, scm_sloppy_memv, scm_sloppy_member |
| 824 | |
| 825 | Instead, use scm_c_memq or scm_memq, scm_memv, scm_member. |
| 826 | |
| 827 | ** New functions: scm_call_0, scm_call_1, scm_call_2, scm_call_3 |
| 828 | |
| 829 | Call a procedure with the indicated number of arguments. |
| 830 | |
| 831 | Example: |
| 832 | |
| 833 | scm_call_1 (proc, arg1); |
| 834 | |
| 835 | ** New functions: scm_apply_0, scm_apply_1, scm_apply_2, scm_apply_3 |
| 836 | |
| 837 | Call a procedure with the indicated number of arguments and a list |
| 838 | of arguments. |
| 839 | |
| 840 | Example: |
| 841 | |
| 842 | scm_apply_1 (proc, arg1, args); |
| 843 | |
| 844 | ** New functions: scm_list_1, scm_list_2, scm_list_3, scm_list_4, scm_list_5 |
| 845 | |
| 846 | Create a list of the given number of elements. |
| 847 | |
| 848 | ** Renamed function: scm_listify has been replaced by scm_list_n. |
| 849 | |
| 850 | ** Deprecated macros: SCM_LIST0, SCM_LIST1, SCM_LIST2, SCM_LIST3, SCM_LIST4, |
| 851 | SCM_LIST5, SCM_LIST6, SCM_LIST7, SCM_LIST8, SCM_LIST9. |
| 852 | |
| 853 | Use functions scm_list_N instead. |
| 854 | |
| 855 | ** New function: scm_c_read (SCM port, void *buffer, scm_sizet size) |
| 856 | |
| 857 | Used by an application to read arbitrary number of bytes from a port. |
| 858 | Same semantics as libc read, except that scm_c_read only returns less |
| 859 | than SIZE bytes if at end-of-file. |
| 860 | |
| 861 | Warning: Doesn't update port line and column counts! |
| 862 | |
| 863 | ** New function: scm_c_write (SCM port, const void *ptr, scm_sizet size) |
| 864 | |
| 865 | Used by an application to write arbitrary number of bytes to an SCM |
| 866 | port. Similar semantics as libc write. However, unlike libc |
| 867 | write, scm_c_write writes the requested number of bytes and has no |
| 868 | return value. |
| 869 | |
| 870 | Warning: Doesn't update port line and column counts! |
| 871 | |
| 872 | ** New function: scm_init_guile () |
| 873 | |
| 874 | In contrast to scm_boot_guile, scm_init_guile will return normally |
| 875 | after initializing Guile. It is not available on all systems, tho. |
| 876 | |
| 877 | ** New functions: scm_str2symbol, scm_mem2symbol |
| 878 | |
| 879 | The function scm_str2symbol takes a const char* pointing to a zero-terminated |
| 880 | field of characters and creates a scheme symbol object from that C string. |
| 881 | The function scm_mem2symbol takes a const char* and a number of characters and |
| 882 | creates a symbol from the characters in that memory area. |
| 883 | |
| 884 | ** New functions: scm_primitive_make_property |
| 885 | scm_primitive_property_ref |
| 886 | scm_primitive_property_set_x |
| 887 | scm_primitive_property_del_x |
| 888 | |
| 889 | These functions implement a new way to deal with object properties. |
| 890 | See libguile/properties.c for their documentation. |
| 891 | |
| 892 | ** New function: scm_done_free (long size) |
| 893 | |
| 894 | This function is the inverse of scm_done_malloc. Use it to report the |
| 895 | amount of smob memory you free. The previous method, which involved |
| 896 | calling scm_done_malloc with negative argument, was somewhat |
| 897 | unintuitive (and is still available, of course). |
| 898 | |
| 899 | ** New function: scm_c_memq (SCM obj, SCM list) |
| 900 | |
| 901 | This function provides a fast C level alternative for scm_memq for the case |
| 902 | that the list parameter is known to be a proper list. The function is a |
| 903 | replacement for scm_sloppy_memq, but is stricter in its requirements on its |
| 904 | list input parameter, since for anything else but a proper list the function's |
| 905 | behaviour is undefined - it may even crash or loop endlessly. Further, for |
| 906 | the case that the object is not found in the list, scm_c_memq returns #f which |
| 907 | is similar to scm_memq, but different from scm_sloppy_memq's behaviour. |
| 908 | |
| 909 | ** New functions: scm_remember_upto_here_1, scm_remember_upto_here_2, |
| 910 | scm_remember_upto_here |
| 911 | |
| 912 | These functions replace the function scm_remember. |
| 913 | |
| 914 | ** Deprecated function: scm_remember |
| 915 | |
| 916 | Use one of the new functions scm_remember_upto_here_1, |
| 917 | scm_remember_upto_here_2 or scm_remember_upto_here instead. |
| 918 | |
| 919 | ** New function: scm_allocate_string |
| 920 | |
| 921 | This function replaces the function scm_makstr. |
| 922 | |
| 923 | ** Deprecated function: scm_makstr |
| 924 | |
| 925 | Use the new function scm_allocate_string instead. |
| 926 | |
| 927 | ** New global variable scm_gc_running_p introduced. |
| 928 | |
| 929 | Use this variable to find out if garbage collection is being executed. Up to |
| 930 | now applications have used scm_gc_heap_lock to test if garbage collection was |
| 931 | running, which also works because of the fact that up to know only the garbage |
| 932 | collector has set this variable. But, this is an implementation detail that |
| 933 | may change. Further, scm_gc_heap_lock is not set throughout gc, thus the use |
| 934 | of this variable is (and has been) not fully safe anyway. |
| 935 | |
| 936 | ** New macros: SCM_BITVECTOR_MAX_LENGTH, SCM_UVECTOR_MAX_LENGTH |
| 937 | |
| 938 | Use these instead of SCM_LENGTH_MAX. |
| 939 | |
| 940 | ** New macros: SCM_CONTINUATION_LENGTH, SCM_CCLO_LENGTH, SCM_STACK_LENGTH, |
| 941 | SCM_STRING_LENGTH, SCM_SYMBOL_LENGTH, SCM_UVECTOR_LENGTH, |
| 942 | SCM_BITVECTOR_LENGTH, SCM_VECTOR_LENGTH. |
| 943 | |
| 944 | Use these instead of SCM_LENGTH. |
| 945 | |
| 946 | ** New macros: SCM_SET_CONTINUATION_LENGTH, SCM_SET_STRING_LENGTH, |
| 947 | SCM_SET_SYMBOL_LENGTH, SCM_SET_VECTOR_LENGTH, SCM_SET_UVECTOR_LENGTH, |
| 948 | SCM_SET_BITVECTOR_LENGTH |
| 949 | |
| 950 | Use these instead of SCM_SETLENGTH |
| 951 | |
| 952 | ** New macros: SCM_STRING_CHARS, SCM_SYMBOL_CHARS, SCM_CCLO_BASE, |
| 953 | SCM_VECTOR_BASE, SCM_UVECTOR_BASE, SCM_BITVECTOR_BASE, SCM_COMPLEX_MEM, |
| 954 | SCM_ARRAY_MEM |
| 955 | |
| 956 | Use these instead of SCM_CHARS, SCM_UCHARS, SCM_ROCHARS, SCM_ROUCHARS or |
| 957 | SCM_VELTS. |
| 958 | |
| 959 | ** New macros: SCM_SET_BIGNUM_BASE, SCM_SET_STRING_CHARS, |
| 960 | SCM_SET_SYMBOL_CHARS, SCM_SET_UVECTOR_BASE, SCM_SET_BITVECTOR_BASE, |
| 961 | SCM_SET_VECTOR_BASE |
| 962 | |
| 963 | Use these instead of SCM_SETCHARS. |
| 964 | |
| 965 | ** New macro: SCM_BITVECTOR_P |
| 966 | |
| 967 | ** New macro: SCM_STRING_COERCE_0TERMINATION_X |
| 968 | |
| 969 | Use instead of SCM_COERCE_SUBSTR. |
| 970 | |
| 971 | ** New macros: SCM_DIR_OPEN_P, SCM_DIR_FLAG_OPEN |
| 972 | |
| 973 | For directory objects, use these instead of SCM_OPDIRP and SCM_OPN. |
| 974 | |
| 975 | ** Deprecated macros: SCM_OUTOFRANGE, SCM_NALLOC, SCM_HUP_SIGNAL, |
| 976 | SCM_INT_SIGNAL, SCM_FPE_SIGNAL, SCM_BUS_SIGNAL, SCM_SEGV_SIGNAL, |
| 977 | SCM_ALRM_SIGNAL, SCM_GC_SIGNAL, SCM_TICK_SIGNAL, SCM_SIG_ORD, |
| 978 | SCM_ORD_SIG, SCM_NUM_SIGS, SCM_SYMBOL_SLOTS, SCM_SLOTS, SCM_SLOPPY_STRINGP, |
| 979 | SCM_VALIDATE_STRINGORSUBSTR, SCM_FREEP, SCM_NFREEP, SCM_CHARS, SCM_UCHARS, |
| 980 | SCM_VALIDATE_ROSTRING, SCM_VALIDATE_ROSTRING_COPY, |
| 981 | SCM_VALIDATE_NULLORROSTRING_COPY, SCM_ROLENGTH, SCM_LENGTH, SCM_HUGE_LENGTH, |
| 982 | SCM_SUBSTRP, SCM_SUBSTR_STR, SCM_SUBSTR_OFFSET, SCM_COERCE_SUBSTR, |
| 983 | SCM_ROSTRINGP, SCM_RWSTRINGP, SCM_VALIDATE_RWSTRING, SCM_ROCHARS, |
| 984 | SCM_ROUCHARS, SCM_SETLENGTH, SCM_SETCHARS, SCM_LENGTH_MAX, SCM_GC8MARKP, |
| 985 | SCM_SETGC8MARK, SCM_CLRGC8MARK, SCM_GCTYP16, SCM_GCCDR, SCM_SUBR_DOC, |
| 986 | SCM_OPDIRP, SCM_VALIDATE_OPDIR, SCM_WTA, RETURN_SCM_WTA, SCM_CONST_LONG, |
| 987 | SCM_WNA, SCM_FUNC_NAME, SCM_VALIDATE_NUMBER_COPY, |
| 988 | SCM_VALIDATE_NUMBER_DEF_COPY, SCM_SLOPPY_CONSP, SCM_SLOPPY_NCONSP, |
| 989 | SCM_SETAND_CDR, SCM_SETOR_CDR, SCM_SETAND_CAR, SCM_SETOR_CAR |
| 990 | |
| 991 | Use SCM_ASSERT_RANGE or SCM_VALIDATE_XXX_RANGE instead of SCM_OUTOFRANGE. |
| 992 | Use scm_memory_error instead of SCM_NALLOC. |
| 993 | Use SCM_STRINGP instead of SCM_SLOPPY_STRINGP. |
| 994 | Use SCM_VALIDATE_STRING instead of SCM_VALIDATE_STRINGORSUBSTR. |
| 995 | Use SCM_FREE_CELL_P instead of SCM_FREEP/SCM_NFREEP |
| 996 | Use a type specific accessor macro instead of SCM_CHARS/SCM_UCHARS. |
| 997 | Use a type specific accessor instead of SCM(_|_RO|_HUGE_)LENGTH. |
| 998 | Use SCM_VALIDATE_(SYMBOL|STRING) instead of SCM_VALIDATE_ROSTRING. |
| 999 | Use SCM_STRING_COERCE_0TERMINATION_X instead of SCM_COERCE_SUBSTR. |
| 1000 | Use SCM_STRINGP or SCM_SYMBOLP instead of SCM_ROSTRINGP. |
| 1001 | Use SCM_STRINGP instead of SCM_RWSTRINGP. |
| 1002 | Use SCM_VALIDATE_STRING instead of SCM_VALIDATE_RWSTRING. |
| 1003 | Use SCM_STRING_CHARS instead of SCM_ROCHARS. |
| 1004 | Use SCM_STRING_UCHARS instead of SCM_ROUCHARS. |
| 1005 | Use a type specific setter macro instead of SCM_SETLENGTH. |
| 1006 | Use a type specific setter macro instead of SCM_SETCHARS. |
| 1007 | Use a type specific length macro instead of SCM_LENGTH_MAX. |
| 1008 | Use SCM_GCMARKP instead of SCM_GC8MARKP. |
| 1009 | Use SCM_SETGCMARK instead of SCM_SETGC8MARK. |
| 1010 | Use SCM_CLRGCMARK instead of SCM_CLRGC8MARK. |
| 1011 | Use SCM_TYP16 instead of SCM_GCTYP16. |
| 1012 | Use SCM_CDR instead of SCM_GCCDR. |
| 1013 | Use SCM_DIR_OPEN_P instead of SCM_OPDIRP. |
| 1014 | Use SCM_MISC_ERROR or SCM_WRONG_TYPE_ARG instead of SCM_WTA. |
| 1015 | Use SCM_MISC_ERROR or SCM_WRONG_TYPE_ARG instead of RETURN_SCM_WTA. |
| 1016 | Use SCM_VCELL_INIT instead of SCM_CONST_LONG. |
| 1017 | Use SCM_WRONG_NUM_ARGS instead of SCM_WNA. |
| 1018 | Use SCM_CONSP instead of SCM_SLOPPY_CONSP. |
| 1019 | Use !SCM_CONSP instead of SCM_SLOPPY_NCONSP. |
| 1020 | |
| 1021 | ** Removed function: scm_struct_init |
| 1022 | |
| 1023 | ** Removed variable: scm_symhash_dim |
| 1024 | |
| 1025 | ** Renamed function: scm_make_cont has been replaced by |
| 1026 | scm_make_continuation, which has a different interface. |
| 1027 | |
| 1028 | ** Deprecated function: scm_call_catching_errors |
| 1029 | |
| 1030 | Use scm_catch or scm_lazy_catch from throw.[ch] instead. |
| 1031 | |
| 1032 | ** Deprecated function: scm_strhash |
| 1033 | |
| 1034 | Use scm_string_hash instead. |
| 1035 | |
| 1036 | ** Deprecated function: scm_vector_set_length_x |
| 1037 | |
| 1038 | Instead, create a fresh vector of the desired size and copy the contents. |
| 1039 | |
| 1040 | ** scm_gensym has changed prototype |
| 1041 | |
| 1042 | scm_gensym now only takes one argument. |
| 1043 | |
| 1044 | ** Deprecated type tags: scm_tc7_ssymbol, scm_tc7_msymbol, scm_tcs_symbols, |
| 1045 | scm_tc7_lvector |
| 1046 | |
| 1047 | There is now only a single symbol type scm_tc7_symbol. |
| 1048 | The tag scm_tc7_lvector was not used anyway. |
| 1049 | |
| 1050 | ** Deprecated function: scm_make_smob_type_mfpe, scm_set_smob_mfpe. |
| 1051 | |
| 1052 | Use scm_make_smob_type and scm_set_smob_XXX instead. |
| 1053 | |
| 1054 | ** New function scm_set_smob_apply. |
| 1055 | |
| 1056 | This can be used to set an apply function to a smob type. |
| 1057 | |
| 1058 | ** Deprecated function: scm_strprint_obj |
| 1059 | |
| 1060 | Use scm_object_to_string instead. |
| 1061 | |
| 1062 | ** Deprecated function: scm_wta |
| 1063 | |
| 1064 | Use scm_wrong_type_arg, or another appropriate error signalling function |
| 1065 | instead. |
| 1066 | |
| 1067 | ** Explicit support for obarrays has been deprecated. |
| 1068 | |
| 1069 | Use `scm_str2symbol' and the generic hashtable functions instead. |
| 1070 | |
| 1071 | ** The concept of `vcells' has been deprecated. |
| 1072 | |
| 1073 | The data type `variable' is now used exclusively. `Vcells' have been |
| 1074 | a low-level concept so you are likely not affected by this change. |
| 1075 | |
| 1076 | *** Deprecated functions: scm_sym2vcell, scm_sysintern, |
| 1077 | scm_sysintern0, scm_symbol_value0, scm_intern, scm_intern0. |
| 1078 | |
| 1079 | Use scm_c_define or scm_c_lookup instead, as appropriate. |
| 1080 | |
| 1081 | *** New functions: scm_c_module_lookup, scm_c_lookup, |
| 1082 | scm_c_module_define, scm_c_define, scm_module_lookup, scm_lookup, |
| 1083 | scm_module_define, scm_define. |
| 1084 | |
| 1085 | These functions work with variables instead of with vcells. |
| 1086 | |
| 1087 | ** New functions for creating and defining `subr's and `gsubr's. |
| 1088 | |
| 1089 | The new functions more clearly distinguish between creating a subr (or |
| 1090 | gsubr) object and adding it to the current module. |
| 1091 | |
| 1092 | These new functions are available: scm_c_make_subr, scm_c_define_subr, |
| 1093 | scm_c_make_subr_with_generic, scm_c_define_subr_with_generic, |
| 1094 | scm_c_make_gsubr, scm_c_define_gsubr, scm_c_make_gsubr_with_generic, |
| 1095 | scm_c_define_gsubr_with_generic. |
| 1096 | |
| 1097 | ** Deprecated functions: scm_make_subr, scm_make_subr_opt, |
| 1098 | scm_make_subr_with_generic, scm_make_gsubr, |
| 1099 | scm_make_gsubr_with_generic. |
| 1100 | |
| 1101 | Use the new ones from above instead. |
| 1102 | |
| 1103 | ** C interface to the module system has changed. |
| 1104 | |
| 1105 | While we suggest that you avoid as many explicit module system |
| 1106 | operations from C as possible for the time being, the C interface has |
| 1107 | been made more similar to the high-level Scheme module system. |
| 1108 | |
| 1109 | *** New functions: scm_c_define_module, scm_c_use_module, |
| 1110 | scm_c_export, scm_c_resolve_module. |
| 1111 | |
| 1112 | They mostly work like their Scheme namesakes. scm_c_define_module |
| 1113 | takes a function that is called a context where the new module is |
| 1114 | current. |
| 1115 | |
| 1116 | *** Deprecated functions: scm_the_root_module, scm_make_module, |
| 1117 | scm_ensure_user_module, scm_load_scheme_module. |
| 1118 | |
| 1119 | Use the new functions instead. |
| 1120 | |
| 1121 | ** Renamed function: scm_internal_with_fluids becomes |
| 1122 | scm_c_with_fluids. |
| 1123 | |
| 1124 | scm_internal_with_fluids is available as a deprecated function. |
| 1125 | |
| 1126 | ** New function: scm_c_with_fluid. |
| 1127 | |
| 1128 | Just like scm_c_with_fluids, but takes one fluid and one value instead |
| 1129 | of lists of same. |
| 1130 | |
| 1131 | ** Deprecated typedefs: long_long, ulong_long. |
| 1132 | |
| 1133 | They are of questionable utility and they pollute the global |
| 1134 | namespace. |
| 1135 | |
| 1136 | ** Deprecated typedef: scm_sizet |
| 1137 | |
| 1138 | It is of questionable utility now that Guile requires ANSI C, and is |
| 1139 | oddly named. |
| 1140 | |
| 1141 | ** Deprecated typedefs: scm_port_rw_active, scm_port, |
| 1142 | scm_ptob_descriptor, scm_debug_info, scm_debug_frame, scm_fport, |
| 1143 | scm_option, scm_rstate, scm_rng, scm_array, scm_array_dim. |
| 1144 | |
| 1145 | Made more compliant with the naming policy by adding a _t at the end. |
| 1146 | |
| 1147 | ** Deprecated functions: scm_mkbig, scm_big2num, scm_adjbig, |
| 1148 | scm_normbig, scm_copybig, scm_2ulong2big, scm_dbl2big, scm_big2dbl |
| 1149 | |
| 1150 | With the exception of the mysterious scm_2ulong2big, they are still |
| 1151 | available under new names (scm_i_mkbig etc). These functions are not |
| 1152 | intended to be used in user code. You should avoid dealing with |
| 1153 | bignums directly, and should deal with numbers in general (which can |
| 1154 | be bignums). |
| 1155 | |
| 1156 | ** New functions: scm_short2num, scm_ushort2num, scm_int2num, |
| 1157 | scm_uint2num, scm_size2num, scm_ptrdiff2num, scm_num2short, |
| 1158 | scm_num2ushort, scm_num2int, scm_num2uint, scm_num2ptrdiff, |
| 1159 | scm_num2size. |
| 1160 | |
| 1161 | These are conversion functions between the various ANSI C integral |
| 1162 | types and Scheme numbers. |
| 1163 | |
| 1164 | ** New number validation macros: |
| 1165 | SCM_NUM2{SIZE,PTRDIFF,SHORT,USHORT,INT,UINT}[_DEF] |
| 1166 | |
| 1167 | See above. |
| 1168 | |
| 1169 | ** New functions: scm_gc_protect_object, scm_gc_unprotect_object |
| 1170 | |
| 1171 | These are just nicer-named old scm_protect_object and |
| 1172 | scm_unprotect_object. |
| 1173 | |
| 1174 | ** Deprecated functions: scm_protect_object, scm_unprotect_object |
| 1175 | |
| 1176 | ** New functions: scm_gc_[un]register_root, scm_gc_[un]register_roots |
| 1177 | |
| 1178 | These functions can be used to register pointers to locations that |
| 1179 | hold SCM values. |
| 1180 | |
| 1181 | ** Deprecated function: scm_create_hook. |
| 1182 | |
| 1183 | Its sins are: misleading name, non-modularity and lack of general |
| 1184 | usefulness. |
| 1185 | |
| 1186 | \f |
| 1187 | Changes since Guile 1.3.4: |
| 1188 | |
| 1189 | * Changes to the distribution |
| 1190 | |
| 1191 | ** Trees from nightly snapshots and CVS now require you to run autogen.sh. |
| 1192 | |
| 1193 | We've changed the way we handle generated files in the Guile source |
| 1194 | repository. As a result, the procedure for building trees obtained |
| 1195 | from the nightly FTP snapshots or via CVS has changed: |
| 1196 | - You must have appropriate versions of autoconf, automake, and |
| 1197 | libtool installed on your system. See README for info on how to |
| 1198 | obtain these programs. |
| 1199 | - Before configuring the tree, you must first run the script |
| 1200 | `autogen.sh' at the top of the source tree. |
| 1201 | |
| 1202 | The Guile repository used to contain not only source files, written by |
| 1203 | humans, but also some generated files, like configure scripts and |
| 1204 | Makefile.in files. Even though the contents of these files could be |
| 1205 | derived mechanically from other files present, we thought it would |
| 1206 | make the tree easier to build if we checked them into CVS. |
| 1207 | |
| 1208 | However, this approach means that minor differences between |
| 1209 | developer's installed tools and habits affected the whole team. |
| 1210 | So we have removed the generated files from the repository, and |
| 1211 | added the autogen.sh script, which will reconstruct them |
| 1212 | appropriately. |
| 1213 | |
| 1214 | |
| 1215 | ** configure now has experimental options to remove support for certain |
| 1216 | features: |
| 1217 | |
| 1218 | --disable-arrays omit array and uniform array support |
| 1219 | --disable-posix omit posix interfaces |
| 1220 | --disable-networking omit networking interfaces |
| 1221 | --disable-regex omit regular expression interfaces |
| 1222 | |
| 1223 | These are likely to become separate modules some day. |
| 1224 | |
| 1225 | ** New configure option --enable-debug-freelist |
| 1226 | |
| 1227 | This enables a debugging version of SCM_NEWCELL(), and also registers |
| 1228 | an extra primitive, the setter `gc-set-debug-check-freelist!'. |
| 1229 | |
| 1230 | Configure with the --enable-debug-freelist option to enable |
| 1231 | the gc-set-debug-check-freelist! primitive, and then use: |
| 1232 | |
| 1233 | (gc-set-debug-check-freelist! #t) # turn on checking of the freelist |
| 1234 | (gc-set-debug-check-freelist! #f) # turn off checking |
| 1235 | |
| 1236 | Checking of the freelist forces a traversal of the freelist and |
| 1237 | a garbage collection before each allocation of a cell. This can |
| 1238 | slow down the interpreter dramatically, so the setter should be used to |
| 1239 | turn on this extra processing only when necessary. |
| 1240 | |
| 1241 | ** New configure option --enable-debug-malloc |
| 1242 | |
| 1243 | Include code for debugging of calls to scm_must_malloc/realloc/free. |
| 1244 | |
| 1245 | Checks that |
| 1246 | |
| 1247 | 1. objects freed by scm_must_free has been mallocated by scm_must_malloc |
| 1248 | 2. objects reallocated by scm_must_realloc has been allocated by |
| 1249 | scm_must_malloc |
| 1250 | 3. reallocated objects are reallocated with the same what string |
| 1251 | |
| 1252 | But, most importantly, it records the number of allocated objects of |
| 1253 | each kind. This is useful when searching for memory leaks. |
| 1254 | |
| 1255 | A Guile compiled with this option provides the primitive |
| 1256 | `malloc-stats' which returns an alist with pairs of kind and the |
| 1257 | number of objects of that kind. |
| 1258 | |
| 1259 | ** All includes are now referenced relative to the root directory |
| 1260 | |
| 1261 | Since some users have had problems with mixups between Guile and |
| 1262 | system headers, we have decided to always refer to Guile headers via |
| 1263 | their parent directories. This essentially creates a "private name |
| 1264 | space" for Guile headers. This means that the compiler only is given |
| 1265 | -I options for the root build and root source directory. |
| 1266 | |
| 1267 | ** Header files kw.h and genio.h have been removed. |
| 1268 | |
| 1269 | ** The module (ice-9 getopt-gnu-style) has been removed. |
| 1270 | |
| 1271 | ** New module (ice-9 documentation) |
| 1272 | |
| 1273 | Implements the interface to documentation strings associated with |
| 1274 | objects. |
| 1275 | |
| 1276 | ** New module (ice-9 time) |
| 1277 | |
| 1278 | Provides a macro `time', which displays execution time of a given form. |
| 1279 | |
| 1280 | ** New module (ice-9 history) |
| 1281 | |
| 1282 | Loading this module enables value history in the repl. |
| 1283 | |
| 1284 | * Changes to the stand-alone interpreter |
| 1285 | |
| 1286 | ** New command line option --debug |
| 1287 | |
| 1288 | Start Guile with debugging evaluator and backtraces enabled. |
| 1289 | |
| 1290 | This is useful when debugging your .guile init file or scripts. |
| 1291 | |
| 1292 | ** New help facility |
| 1293 | |
| 1294 | Usage: (help NAME) gives documentation about objects named NAME (a symbol) |
| 1295 | (help REGEXP) ditto for objects with names matching REGEXP (a string) |
| 1296 | (help 'NAME) gives documentation for NAME, even if it is not an object |
| 1297 | (help ,EXPR) gives documentation for object returned by EXPR |
| 1298 | (help (my module)) gives module commentary for `(my module)' |
| 1299 | (help) gives this text |
| 1300 | |
| 1301 | `help' searches among bindings exported from loaded modules, while |
| 1302 | `apropos' searches among bindings visible from the "current" module. |
| 1303 | |
| 1304 | Examples: (help help) |
| 1305 | (help cons) |
| 1306 | (help "output-string") |
| 1307 | |
| 1308 | ** `help' and `apropos' now prints full module names |
| 1309 | |
| 1310 | ** Dynamic linking now uses libltdl from the libtool package. |
| 1311 | |
| 1312 | The old system dependent code for doing dynamic linking has been |
| 1313 | replaced with calls to the libltdl functions which do all the hairy |
| 1314 | details for us. |
| 1315 | |
| 1316 | The major improvement is that you can now directly pass libtool |
| 1317 | library names like "libfoo.la" to `dynamic-link' and `dynamic-link' |
| 1318 | will be able to do the best shared library job you can get, via |
| 1319 | libltdl. |
| 1320 | |
| 1321 | The way dynamic libraries are found has changed and is not really |
| 1322 | portable across platforms, probably. It is therefore recommended to |
| 1323 | use absolute filenames when possible. |
| 1324 | |
| 1325 | If you pass a filename without an extension to `dynamic-link', it will |
| 1326 | try a few appropriate ones. Thus, the most platform ignorant way is |
| 1327 | to specify a name like "libfoo", without any directories and |
| 1328 | extensions. |
| 1329 | |
| 1330 | ** Guile COOP threads are now compatible with LinuxThreads |
| 1331 | |
| 1332 | Previously, COOP threading wasn't possible in applications linked with |
| 1333 | Linux POSIX threads due to their use of the stack pointer to find the |
| 1334 | thread context. This has now been fixed with a workaround which uses |
| 1335 | the pthreads to allocate the stack. |
| 1336 | |
| 1337 | ** New primitives: `pkgdata-dir', `site-dir', `library-dir' |
| 1338 | |
| 1339 | ** Positions of erring expression in scripts |
| 1340 | |
| 1341 | With version 1.3.4, the location of the erring expression in Guile |
| 1342 | scipts is no longer automatically reported. (This should have been |
| 1343 | documented before the 1.3.4 release.) |
| 1344 | |
| 1345 | You can get this information by enabling recording of positions of |
| 1346 | source expressions and running the debugging evaluator. Put this at |
| 1347 | the top of your script (or in your "site" file): |
| 1348 | |
| 1349 | (read-enable 'positions) |
| 1350 | (debug-enable 'debug) |
| 1351 | |
| 1352 | ** Backtraces in scripts |
| 1353 | |
| 1354 | It is now possible to get backtraces in scripts. |
| 1355 | |
| 1356 | Put |
| 1357 | |
| 1358 | (debug-enable 'debug 'backtrace) |
| 1359 | |
| 1360 | at the top of the script. |
| 1361 | |
| 1362 | (The first options enables the debugging evaluator. |
| 1363 | The second enables backtraces.) |
| 1364 | |
| 1365 | ** Part of module system symbol lookup now implemented in C |
| 1366 | |
| 1367 | The eval closure of most modules is now implemented in C. Since this |
| 1368 | was one of the bottlenecks for loading speed, Guile now loads code |
| 1369 | substantially faster than before. |
| 1370 | |
| 1371 | ** Attempting to get the value of an unbound variable now produces |
| 1372 | an exception with a key of 'unbound-variable instead of 'misc-error. |
| 1373 | |
| 1374 | ** The initial default output port is now unbuffered if it's using a |
| 1375 | tty device. Previously in this situation it was line-buffered. |
| 1376 | |
| 1377 | ** New hook: after-gc-hook |
| 1378 | |
| 1379 | after-gc-hook takes over the role of gc-thunk. This hook is run at |
| 1380 | the first SCM_TICK after a GC. (Thus, the code is run at the same |
| 1381 | point during evaluation as signal handlers.) |
| 1382 | |
| 1383 | Note that this hook should be used only for diagnostic and debugging |
| 1384 | purposes. It is not certain that it will continue to be well-defined |
| 1385 | when this hook is run in the future. |
| 1386 | |
| 1387 | C programmers: Note the new C level hooks scm_before_gc_c_hook, |
| 1388 | scm_before_sweep_c_hook, scm_after_gc_c_hook. |
| 1389 | |
| 1390 | ** Improvements to garbage collector |
| 1391 | |
| 1392 | Guile 1.4 has a new policy for triggering heap allocation and |
| 1393 | determining the sizes of heap segments. It fixes a number of problems |
| 1394 | in the old GC. |
| 1395 | |
| 1396 | 1. The new policy can handle two separate pools of cells |
| 1397 | (2-word/4-word) better. (The old policy would run wild, allocating |
| 1398 | more and more memory for certain programs.) |
| 1399 | |
| 1400 | 2. The old code would sometimes allocate far too much heap so that the |
| 1401 | Guile process became gigantic. The new code avoids this. |
| 1402 | |
| 1403 | 3. The old code would sometimes allocate too little so that few cells |
| 1404 | were freed at GC so that, in turn, too much time was spent in GC. |
| 1405 | |
| 1406 | 4. The old code would often trigger heap allocation several times in a |
| 1407 | row. (The new scheme predicts how large the segments needs to be |
| 1408 | in order not to need further allocation.) |
| 1409 | |
| 1410 | All in all, the new GC policy will make larger applications more |
| 1411 | efficient. |
| 1412 | |
| 1413 | The new GC scheme also is prepared for POSIX threading. Threads can |
| 1414 | allocate private pools of cells ("clusters") with just a single |
| 1415 | function call. Allocation of single cells from such a cluster can |
| 1416 | then proceed without any need of inter-thread synchronization. |
| 1417 | |
| 1418 | ** New environment variables controlling GC parameters |
| 1419 | |
| 1420 | GUILE_MAX_SEGMENT_SIZE Maximal segment size |
| 1421 | (default = 2097000) |
| 1422 | |
| 1423 | Allocation of 2-word cell heaps: |
| 1424 | |
| 1425 | GUILE_INIT_SEGMENT_SIZE_1 Size of initial heap segment in bytes |
| 1426 | (default = 360000) |
| 1427 | |
| 1428 | GUILE_MIN_YIELD_1 Minimum number of freed cells at each |
| 1429 | GC in percent of total heap size |
| 1430 | (default = 40) |
| 1431 | |
| 1432 | Allocation of 4-word cell heaps |
| 1433 | (used for real numbers and misc other objects): |
| 1434 | |
| 1435 | GUILE_INIT_SEGMENT_SIZE_2, GUILE_MIN_YIELD_2 |
| 1436 | |
| 1437 | (See entry "Way for application to customize GC parameters" under |
| 1438 | section "Changes to the scm_ interface" below.) |
| 1439 | |
| 1440 | ** Guile now implements reals using 4-word cells |
| 1441 | |
| 1442 | This speeds up computation with reals. (They were earlier allocated |
| 1443 | with `malloc'.) There is still some room for optimizations, however. |
| 1444 | |
| 1445 | ** Some further steps toward POSIX thread support have been taken |
| 1446 | |
| 1447 | *** Guile's critical sections (SCM_DEFER/ALLOW_INTS) |
| 1448 | don't have much effect any longer, and many of them will be removed in |
| 1449 | next release. |
| 1450 | |
| 1451 | *** Signals |
| 1452 | are only handled at the top of the evaluator loop, immediately after |
| 1453 | I/O, and in scm_equalp. |
| 1454 | |
| 1455 | *** The GC can allocate thread private pools of pairs. |
| 1456 | |
| 1457 | * Changes to Scheme functions and syntax |
| 1458 | |
| 1459 | ** close-input-port and close-output-port are now R5RS |
| 1460 | |
| 1461 | These procedures have been turned into primitives and have R5RS behaviour. |
| 1462 | |
| 1463 | ** New procedure: simple-format PORT MESSAGE ARG1 ... |
| 1464 | |
| 1465 | (ice-9 boot) makes `format' an alias for `simple-format' until possibly |
| 1466 | extended by the more sophisticated version in (ice-9 format) |
| 1467 | |
| 1468 | (simple-format port message . args) |
| 1469 | Write MESSAGE to DESTINATION, defaulting to `current-output-port'. |
| 1470 | MESSAGE can contain ~A (was %s) and ~S (was %S) escapes. When printed, |
| 1471 | the escapes are replaced with corresponding members of ARGS: |
| 1472 | ~A formats using `display' and ~S formats using `write'. |
| 1473 | If DESTINATION is #t, then use the `current-output-port', |
| 1474 | if DESTINATION is #f, then return a string containing the formatted text. |
| 1475 | Does not add a trailing newline." |
| 1476 | |
| 1477 | ** string-ref: the second argument is no longer optional. |
| 1478 | |
| 1479 | ** string, list->string: no longer accept strings in their arguments, |
| 1480 | only characters, for compatibility with R5RS. |
| 1481 | |
| 1482 | ** New procedure: port-closed? PORT |
| 1483 | Returns #t if PORT is closed or #f if it is open. |
| 1484 | |
| 1485 | ** Deprecated: list* |
| 1486 | |
| 1487 | The list* functionality is now provided by cons* (SRFI-1 compliant) |
| 1488 | |
| 1489 | ** New procedure: cons* ARG1 ARG2 ... ARGn |
| 1490 | |
| 1491 | Like `list', but the last arg provides the tail of the constructed list, |
| 1492 | returning (cons ARG1 (cons ARG2 (cons ... ARGn))). |
| 1493 | |
| 1494 | Requires at least one argument. If given one argument, that argument |
| 1495 | is returned as result. |
| 1496 | |
| 1497 | This function is called `list*' in some other Schemes and in Common LISP. |
| 1498 | |
| 1499 | ** Removed deprecated: serial-map, serial-array-copy!, serial-array-map! |
| 1500 | |
| 1501 | ** New procedure: object-documentation OBJECT |
| 1502 | |
| 1503 | Returns the documentation string associated with OBJECT. The |
| 1504 | procedure uses a caching mechanism so that subsequent lookups are |
| 1505 | faster. |
| 1506 | |
| 1507 | Exported by (ice-9 documentation). |
| 1508 | |
| 1509 | ** module-name now returns full names of modules |
| 1510 | |
| 1511 | Previously, only the last part of the name was returned (`session' for |
| 1512 | `(ice-9 session)'). Ex: `(ice-9 session)'. |
| 1513 | |
| 1514 | * Changes to the gh_ interface |
| 1515 | |
| 1516 | ** Deprecated: gh_int2scmb |
| 1517 | |
| 1518 | Use gh_bool2scm instead. |
| 1519 | |
| 1520 | * Changes to the scm_ interface |
| 1521 | |
| 1522 | ** Guile primitives now carry docstrings! |
| 1523 | |
| 1524 | Thanks to Greg Badros! |
| 1525 | |
| 1526 | ** Guile primitives are defined in a new way: SCM_DEFINE/SCM_DEFINE1/SCM_PROC |
| 1527 | |
| 1528 | Now Guile primitives are defined using the SCM_DEFINE/SCM_DEFINE1/SCM_PROC |
| 1529 | macros and must contain a docstring that is extracted into foo.doc using a new |
| 1530 | guile-doc-snarf script (that uses guile-doc-snarf.awk). |
| 1531 | |
| 1532 | However, a major overhaul of these macros is scheduled for the next release of |
| 1533 | guile. |
| 1534 | |
| 1535 | ** Guile primitives use a new technique for validation of arguments |
| 1536 | |
| 1537 | SCM_VALIDATE_* macros are defined to ease the redundancy and improve |
| 1538 | the readability of argument checking. |
| 1539 | |
| 1540 | ** All (nearly?) K&R prototypes for functions replaced with ANSI C equivalents. |
| 1541 | |
| 1542 | ** New macros: SCM_PACK, SCM_UNPACK |
| 1543 | |
| 1544 | Compose/decompose an SCM value. |
| 1545 | |
| 1546 | The SCM type is now treated as an abstract data type and may be defined as a |
| 1547 | long, a void* or as a struct, depending on the architecture and compile time |
| 1548 | options. This makes it easier to find several types of bugs, for example when |
| 1549 | SCM values are treated as integers without conversion. Values of the SCM type |
| 1550 | should be treated as "atomic" values. These macros are used when |
| 1551 | composing/decomposing an SCM value, either because you want to access |
| 1552 | individual bits, or because you want to treat it as an integer value. |
| 1553 | |
| 1554 | E.g., in order to set bit 7 in an SCM value x, use the expression |
| 1555 | |
| 1556 | SCM_PACK (SCM_UNPACK (x) | 0x80) |
| 1557 | |
| 1558 | ** The name property of hooks is deprecated. |
| 1559 | Thus, the use of SCM_HOOK_NAME and scm_make_hook_with_name is deprecated. |
| 1560 | |
| 1561 | You can emulate this feature by using object properties. |
| 1562 | |
| 1563 | ** Deprecated macros: SCM_INPORTP, SCM_OUTPORTP, SCM_CRDY, SCM_ICHRP, |
| 1564 | SCM_ICHR, SCM_MAKICHR, SCM_SETJMPBUF, SCM_NSTRINGP, SCM_NRWSTRINGP, |
| 1565 | SCM_NVECTORP |
| 1566 | |
| 1567 | These macros will be removed in a future release of Guile. |
| 1568 | |
| 1569 | ** The following types, functions and macros from numbers.h are deprecated: |
| 1570 | scm_dblproc, SCM_UNEGFIXABLE, SCM_FLOBUFLEN, SCM_INEXP, SCM_CPLXP, SCM_REAL, |
| 1571 | SCM_IMAG, SCM_REALPART, scm_makdbl, SCM_SINGP, SCM_NUM2DBL, SCM_NO_BIGDIG |
| 1572 | |
| 1573 | Further, it is recommended not to rely on implementation details for guile's |
| 1574 | current implementation of bignums. It is planned to replace this |
| 1575 | implementation with gmp in the future. |
| 1576 | |
| 1577 | ** Port internals: the rw_random variable in the scm_port structure |
| 1578 | must be set to non-zero in any random access port. In recent Guile |
| 1579 | releases it was only set for bidirectional random-access ports. |
| 1580 | |
| 1581 | ** Port internals: the seek ptob procedure is now responsible for |
| 1582 | resetting the buffers if required. The change was made so that in the |
| 1583 | special case of reading the current position (i.e., seek p 0 SEEK_CUR) |
| 1584 | the fport and strport ptobs can avoid resetting the buffers, |
| 1585 | in particular to avoid discarding unread chars. An existing port |
| 1586 | type can be fixed by adding something like the following to the |
| 1587 | beginning of the ptob seek procedure: |
| 1588 | |
| 1589 | if (pt->rw_active == SCM_PORT_READ) |
| 1590 | scm_end_input (object); |
| 1591 | else if (pt->rw_active == SCM_PORT_WRITE) |
| 1592 | ptob->flush (object); |
| 1593 | |
| 1594 | although to actually avoid resetting the buffers and discard unread |
| 1595 | chars requires further hacking that depends on the characteristics |
| 1596 | of the ptob. |
| 1597 | |
| 1598 | ** Deprecated functions: scm_fseek, scm_tag |
| 1599 | |
| 1600 | These functions are no longer used and will be removed in a future version. |
| 1601 | |
| 1602 | ** The scm_sysmissing procedure is no longer used in libguile. |
| 1603 | Unless it turns out to be unexpectedly useful to somebody, it will be |
| 1604 | removed in a future version. |
| 1605 | |
| 1606 | ** The format of error message strings has changed |
| 1607 | |
| 1608 | The two C procedures: scm_display_error and scm_error, as well as the |
| 1609 | primitive `scm-error', now use scm_simple_format to do their work. |
| 1610 | This means that the message strings of all code must be updated to use |
| 1611 | ~A where %s was used before, and ~S where %S was used before. |
| 1612 | |
| 1613 | During the period when there still are a lot of old Guiles out there, |
| 1614 | you might want to support both old and new versions of Guile. |
| 1615 | |
| 1616 | There are basically two methods to achieve this. Both methods use |
| 1617 | autoconf. Put |
| 1618 | |
| 1619 | AC_CHECK_FUNCS(scm_simple_format) |
| 1620 | |
| 1621 | in your configure.in. |
| 1622 | |
| 1623 | Method 1: Use the string concatenation features of ANSI C's |
| 1624 | preprocessor. |
| 1625 | |
| 1626 | In C: |
| 1627 | |
| 1628 | #ifdef HAVE_SCM_SIMPLE_FORMAT |
| 1629 | #define FMT_S "~S" |
| 1630 | #else |
| 1631 | #define FMT_S "%S" |
| 1632 | #endif |
| 1633 | |
| 1634 | Then represent each of your error messages using a preprocessor macro: |
| 1635 | |
| 1636 | #define E_SPIDER_ERROR "There's a spider in your " ## FMT_S ## "!!!" |
| 1637 | |
| 1638 | In Scheme: |
| 1639 | |
| 1640 | (define fmt-s (if (defined? 'simple-format) "~S" "%S")) |
| 1641 | (define make-message string-append) |
| 1642 | |
| 1643 | (define e-spider-error (make-message "There's a spider in your " fmt-s "!!!")) |
| 1644 | |
| 1645 | Method 2: Use the oldfmt function found in doc/oldfmt.c. |
| 1646 | |
| 1647 | In C: |
| 1648 | |
| 1649 | scm_misc_error ("picnic", scm_c_oldfmt0 ("There's a spider in your ~S!!!"), |
| 1650 | ...); |
| 1651 | |
| 1652 | In Scheme: |
| 1653 | |
| 1654 | (scm-error 'misc-error "picnic" (oldfmt "There's a spider in your ~S!!!") |
| 1655 | ...) |
| 1656 | |
| 1657 | |
| 1658 | ** Deprecated: coop_mutex_init, coop_condition_variable_init |
| 1659 | |
| 1660 | Don't use the functions coop_mutex_init and |
| 1661 | coop_condition_variable_init. They will change. |
| 1662 | |
| 1663 | Use scm_mutex_init and scm_cond_init instead. |
| 1664 | |
| 1665 | ** New function: int scm_cond_timedwait (scm_cond_t *COND, scm_mutex_t *MUTEX, const struct timespec *ABSTIME) |
| 1666 | `scm_cond_timedwait' atomically unlocks MUTEX and waits on |
| 1667 | COND, as `scm_cond_wait' does, but it also bounds the duration |
| 1668 | of the wait. If COND has not been signaled before time ABSTIME, |
| 1669 | the mutex MUTEX is re-acquired and `scm_cond_timedwait' |
| 1670 | returns the error code `ETIMEDOUT'. |
| 1671 | |
| 1672 | The ABSTIME parameter specifies an absolute time, with the same |
| 1673 | origin as `time' and `gettimeofday': an ABSTIME of 0 corresponds |
| 1674 | to 00:00:00 GMT, January 1, 1970. |
| 1675 | |
| 1676 | ** New function: scm_cond_broadcast (scm_cond_t *COND) |
| 1677 | `scm_cond_broadcast' restarts all the threads that are waiting |
| 1678 | on the condition variable COND. Nothing happens if no threads are |
| 1679 | waiting on COND. |
| 1680 | |
| 1681 | ** New function: scm_key_create (scm_key_t *KEY, void (*destr_function) (void *)) |
| 1682 | `scm_key_create' allocates a new TSD key. The key is stored in |
| 1683 | the location pointed to by KEY. There is no limit on the number |
| 1684 | of keys allocated at a given time. The value initially associated |
| 1685 | with the returned key is `NULL' in all currently executing threads. |
| 1686 | |
| 1687 | The DESTR_FUNCTION argument, if not `NULL', specifies a destructor |
| 1688 | function associated with the key. When a thread terminates, |
| 1689 | DESTR_FUNCTION is called on the value associated with the key in |
| 1690 | that thread. The DESTR_FUNCTION is not called if a key is deleted |
| 1691 | with `scm_key_delete' or a value is changed with |
| 1692 | `scm_setspecific'. The order in which destructor functions are |
| 1693 | called at thread termination time is unspecified. |
| 1694 | |
| 1695 | Destructors are not yet implemented. |
| 1696 | |
| 1697 | ** New function: scm_setspecific (scm_key_t KEY, const void *POINTER) |
| 1698 | `scm_setspecific' changes the value associated with KEY in the |
| 1699 | calling thread, storing the given POINTER instead. |
| 1700 | |
| 1701 | ** New function: scm_getspecific (scm_key_t KEY) |
| 1702 | `scm_getspecific' returns the value currently associated with |
| 1703 | KEY in the calling thread. |
| 1704 | |
| 1705 | ** New function: scm_key_delete (scm_key_t KEY) |
| 1706 | `scm_key_delete' deallocates a TSD key. It does not check |
| 1707 | whether non-`NULL' values are associated with that key in the |
| 1708 | currently executing threads, nor call the destructor function |
| 1709 | associated with the key. |
| 1710 | |
| 1711 | ** New function: scm_c_hook_init (scm_c_hook_t *HOOK, void *HOOK_DATA, scm_c_hook_type_t TYPE) |
| 1712 | |
| 1713 | Initialize a C level hook HOOK with associated HOOK_DATA and type |
| 1714 | TYPE. (See scm_c_hook_run ().) |
| 1715 | |
| 1716 | ** New function: scm_c_hook_add (scm_c_hook_t *HOOK, scm_c_hook_function_t FUNC, void *FUNC_DATA, int APPENDP) |
| 1717 | |
| 1718 | Add hook function FUNC with associated FUNC_DATA to HOOK. If APPENDP |
| 1719 | is true, add it last, otherwise first. The same FUNC can be added |
| 1720 | multiple times if FUNC_DATA differ and vice versa. |
| 1721 | |
| 1722 | ** New function: scm_c_hook_remove (scm_c_hook_t *HOOK, scm_c_hook_function_t FUNC, void *FUNC_DATA) |
| 1723 | |
| 1724 | Remove hook function FUNC with associated FUNC_DATA from HOOK. A |
| 1725 | function is only removed if both FUNC and FUNC_DATA matches. |
| 1726 | |
| 1727 | ** New function: void *scm_c_hook_run (scm_c_hook_t *HOOK, void *DATA) |
| 1728 | |
| 1729 | Run hook HOOK passing DATA to the hook functions. |
| 1730 | |
| 1731 | If TYPE is SCM_C_HOOK_NORMAL, all hook functions are run. The value |
| 1732 | returned is undefined. |
| 1733 | |
| 1734 | If TYPE is SCM_C_HOOK_OR, hook functions are run until a function |
| 1735 | returns a non-NULL value. This value is returned as the result of |
| 1736 | scm_c_hook_run. If all functions return NULL, NULL is returned. |
| 1737 | |
| 1738 | If TYPE is SCM_C_HOOK_AND, hook functions are run until a function |
| 1739 | returns a NULL value, and NULL is returned. If all functions returns |
| 1740 | a non-NULL value, the last value is returned. |
| 1741 | |
| 1742 | ** New C level GC hooks |
| 1743 | |
| 1744 | Five new C level hooks has been added to the garbage collector. |
| 1745 | |
| 1746 | scm_before_gc_c_hook |
| 1747 | scm_after_gc_c_hook |
| 1748 | |
| 1749 | are run before locking and after unlocking the heap. The system is |
| 1750 | thus in a mode where evaluation can take place. (Except that |
| 1751 | scm_before_gc_c_hook must not allocate new cells.) |
| 1752 | |
| 1753 | scm_before_mark_c_hook |
| 1754 | scm_before_sweep_c_hook |
| 1755 | scm_after_sweep_c_hook |
| 1756 | |
| 1757 | are run when the heap is locked. These are intended for extension of |
| 1758 | the GC in a modular fashion. Examples are the weaks and guardians |
| 1759 | modules. |
| 1760 | |
| 1761 | ** Way for application to customize GC parameters |
| 1762 | |
| 1763 | The application can set up other default values for the GC heap |
| 1764 | allocation parameters |
| 1765 | |
| 1766 | GUILE_INIT_HEAP_SIZE_1, GUILE_MIN_YIELD_1, |
| 1767 | GUILE_INIT_HEAP_SIZE_2, GUILE_MIN_YIELD_2, |
| 1768 | GUILE_MAX_SEGMENT_SIZE, |
| 1769 | |
| 1770 | by setting |
| 1771 | |
| 1772 | scm_default_init_heap_size_1, scm_default_min_yield_1, |
| 1773 | scm_default_init_heap_size_2, scm_default_min_yield_2, |
| 1774 | scm_default_max_segment_size |
| 1775 | |
| 1776 | respectively before callong scm_boot_guile. |
| 1777 | |
| 1778 | (See entry "New environment variables ..." in section |
| 1779 | "Changes to the stand-alone interpreter" above.) |
| 1780 | |
| 1781 | ** scm_protect_object/scm_unprotect_object now nest |
| 1782 | |
| 1783 | This means that you can call scm_protect_object multiple times on an |
| 1784 | object and count on the object being protected until |
| 1785 | scm_unprotect_object has been call the same number of times. |
| 1786 | |
| 1787 | The functions also have better time complexity. |
| 1788 | |
| 1789 | Still, it is usually possible to structure the application in a way |
| 1790 | that you don't need to use these functions. For example, if you use a |
| 1791 | protected standard Guile list to keep track of live objects rather |
| 1792 | than some custom data type, objects will die a natural death when they |
| 1793 | are no longer needed. |
| 1794 | |
| 1795 | ** Deprecated type tags: scm_tc16_flo, scm_tc_flo, scm_tc_dblr, scm_tc_dblc |
| 1796 | |
| 1797 | Guile does not provide the float representation for inexact real numbers any |
| 1798 | more. Now, only doubles are used to represent inexact real numbers. Further, |
| 1799 | the tag names scm_tc_dblr and scm_tc_dblc have been changed to scm_tc16_real |
| 1800 | and scm_tc16_complex, respectively. |
| 1801 | |
| 1802 | ** Removed deprecated type scm_smobfuns |
| 1803 | |
| 1804 | ** Removed deprecated function scm_newsmob |
| 1805 | |
| 1806 | ** Warning: scm_make_smob_type_mfpe might become deprecated in a future release |
| 1807 | |
| 1808 | There is an ongoing discussion among the developers whether to |
| 1809 | deprecate `scm_make_smob_type_mfpe' or not. Please use the current |
| 1810 | standard interface (scm_make_smob_type, scm_set_smob_XXX) in new code |
| 1811 | until this issue has been settled. |
| 1812 | |
| 1813 | ** Removed deprecated type tag scm_tc16_kw |
| 1814 | |
| 1815 | ** Added type tag scm_tc16_keyword |
| 1816 | |
| 1817 | (This was introduced already in release 1.3.4 but was not documented |
| 1818 | until now.) |
| 1819 | |
| 1820 | ** gdb_print now prints "*** Guile not initialized ***" until Guile initialized |
| 1821 | |
| 1822 | * Changes to system call interfaces: |
| 1823 | |
| 1824 | ** The "select" procedure now tests port buffers for the ability to |
| 1825 | provide input or accept output. Previously only the underlying file |
| 1826 | descriptors were checked. |
| 1827 | |
| 1828 | ** New variable PIPE_BUF: the maximum number of bytes that can be |
| 1829 | atomically written to a pipe. |
| 1830 | |
| 1831 | ** If a facility is not available on the system when Guile is |
| 1832 | compiled, the corresponding primitive procedure will not be defined. |
| 1833 | Previously it would have been defined but would throw a system-error |
| 1834 | exception if called. Exception handlers which catch this case may |
| 1835 | need minor modification: an error will be thrown with key |
| 1836 | 'unbound-variable instead of 'system-error. Alternatively it's |
| 1837 | now possible to use `defined?' to check whether the facility is |
| 1838 | available. |
| 1839 | |
| 1840 | ** Procedures which depend on the timezone should now give the correct |
| 1841 | result on systems which cache the TZ environment variable, even if TZ |
| 1842 | is changed without calling tzset. |
| 1843 | |
| 1844 | * Changes to the networking interfaces: |
| 1845 | |
| 1846 | ** New functions: htons, ntohs, htonl, ntohl: for converting short and |
| 1847 | long integers between network and host format. For now, it's not |
| 1848 | particularly convenient to do this kind of thing, but consider: |
| 1849 | |
| 1850 | (define write-network-long |
| 1851 | (lambda (value port) |
| 1852 | (let ((v (make-uniform-vector 1 1 0))) |
| 1853 | (uniform-vector-set! v 0 (htonl value)) |
| 1854 | (uniform-vector-write v port)))) |
| 1855 | |
| 1856 | (define read-network-long |
| 1857 | (lambda (port) |
| 1858 | (let ((v (make-uniform-vector 1 1 0))) |
| 1859 | (uniform-vector-read! v port) |
| 1860 | (ntohl (uniform-vector-ref v 0))))) |
| 1861 | |
| 1862 | ** If inet-aton fails, it now throws an error with key 'misc-error |
| 1863 | instead of 'system-error, since errno is not relevant. |
| 1864 | |
| 1865 | ** Certain gethostbyname/gethostbyaddr failures now throw errors with |
| 1866 | specific keys instead of 'system-error. The latter is inappropriate |
| 1867 | since errno will not have been set. The keys are: |
| 1868 | 'host-not-found, 'try-again, 'no-recovery and 'no-data. |
| 1869 | |
| 1870 | ** sethostent, setnetent, setprotoent, setservent: now take an |
| 1871 | optional argument STAYOPEN, which specifies whether the database |
| 1872 | remains open after a database entry is accessed randomly (e.g., using |
| 1873 | gethostbyname for the hosts database.) The default is #f. Previously |
| 1874 | #t was always used. |
| 1875 | |
| 1876 | \f |
| 1877 | Changes since Guile 1.3.2: |
| 1878 | |
| 1879 | * Changes to the stand-alone interpreter |
| 1880 | |
| 1881 | ** Debugger |
| 1882 | |
| 1883 | An initial version of the Guile debugger written by Chris Hanson has |
| 1884 | been added. The debugger is still under development but is included |
| 1885 | in the distribution anyway since it is already quite useful. |
| 1886 | |
| 1887 | Type |
| 1888 | |
| 1889 | (debug) |
| 1890 | |
| 1891 | after an error to enter the debugger. Type `help' inside the debugger |
| 1892 | for a description of available commands. |
| 1893 | |
| 1894 | If you prefer to have stack frames numbered and printed in |
| 1895 | anti-chronological order and prefer up in the stack to be down on the |
| 1896 | screen as is the case in gdb, you can put |
| 1897 | |
| 1898 | (debug-enable 'backwards) |
| 1899 | |
| 1900 | in your .guile startup file. (However, this means that Guile can't |
| 1901 | use indentation to indicate stack level.) |
| 1902 | |
| 1903 | The debugger is autoloaded into Guile at the first use. |
| 1904 | |
| 1905 | ** Further enhancements to backtraces |
| 1906 | |
| 1907 | There is a new debug option `width' which controls the maximum width |
| 1908 | on the screen of printed stack frames. Fancy printing parameters |
| 1909 | ("level" and "length" as in Common LISP) are adaptively adjusted for |
| 1910 | each stack frame to give maximum information while still fitting |
| 1911 | within the bounds. If the stack frame can't be made to fit by |
| 1912 | adjusting parameters, it is simply cut off at the end. This is marked |
| 1913 | with a `$'. |
| 1914 | |
| 1915 | ** Some modules are now only loaded when the repl is started |
| 1916 | |
| 1917 | The modules (ice-9 debug), (ice-9 session), (ice-9 threads) and (ice-9 |
| 1918 | regex) are now loaded into (guile-user) only if the repl has been |
| 1919 | started. The effect is that the startup time for scripts has been |
| 1920 | reduced to 30% of what it was previously. |
| 1921 | |
| 1922 | Correctly written scripts load the modules they require at the top of |
| 1923 | the file and should not be affected by this change. |
| 1924 | |
| 1925 | ** Hooks are now represented as smobs |
| 1926 | |
| 1927 | * Changes to Scheme functions and syntax |
| 1928 | |
| 1929 | ** Readline support has changed again. |
| 1930 | |
| 1931 | The old (readline-activator) module is gone. Use (ice-9 readline) |
| 1932 | instead, which now contains all readline functionality. So the code |
| 1933 | to activate readline is now |
| 1934 | |
| 1935 | (use-modules (ice-9 readline)) |
| 1936 | (activate-readline) |
| 1937 | |
| 1938 | This should work at any time, including from the guile prompt. |
| 1939 | |
| 1940 | To avoid confusion about the terms of Guile's license, please only |
| 1941 | enable readline for your personal use; please don't make it the |
| 1942 | default for others. Here is why we make this rather odd-sounding |
| 1943 | request: |
| 1944 | |
| 1945 | Guile is normally licensed under a weakened form of the GNU General |
| 1946 | Public License, which allows you to link code with Guile without |
| 1947 | placing that code under the GPL. This exception is important to some |
| 1948 | people. |
| 1949 | |
| 1950 | However, since readline is distributed under the GNU General Public |
| 1951 | License, when you link Guile with readline, either statically or |
| 1952 | dynamically, you effectively change Guile's license to the strict GPL. |
| 1953 | Whenever you link any strictly GPL'd code into Guile, uses of Guile |
| 1954 | which are normally permitted become forbidden. This is a rather |
| 1955 | non-obvious consequence of the licensing terms. |
| 1956 | |
| 1957 | So, to make sure things remain clear, please let people choose for |
| 1958 | themselves whether to link GPL'd libraries like readline with Guile. |
| 1959 | |
| 1960 | ** regexp-substitute/global has changed slightly, but incompatibly. |
| 1961 | |
| 1962 | If you include a function in the item list, the string of the match |
| 1963 | object it receives is the same string passed to |
| 1964 | regexp-substitute/global, not some suffix of that string. |
| 1965 | Correspondingly, the match's positions are relative to the entire |
| 1966 | string, not the suffix. |
| 1967 | |
| 1968 | If the regexp can match the empty string, the way matches are chosen |
| 1969 | from the string has changed. regexp-substitute/global recognizes the |
| 1970 | same set of matches that list-matches does; see below. |
| 1971 | |
| 1972 | ** New function: list-matches REGEXP STRING [FLAGS] |
| 1973 | |
| 1974 | Return a list of match objects, one for every non-overlapping, maximal |
| 1975 | match of REGEXP in STRING. The matches appear in left-to-right order. |
| 1976 | list-matches only reports matches of the empty string if there are no |
| 1977 | other matches which begin on, end at, or include the empty match's |
| 1978 | position. |
| 1979 | |
| 1980 | If present, FLAGS is passed as the FLAGS argument to regexp-exec. |
| 1981 | |
| 1982 | ** New function: fold-matches REGEXP STRING INIT PROC [FLAGS] |
| 1983 | |
| 1984 | For each match of REGEXP in STRING, apply PROC to the match object, |
| 1985 | and the last value PROC returned, or INIT for the first call. Return |
| 1986 | the last value returned by PROC. We apply PROC to the matches as they |
| 1987 | appear from left to right. |
| 1988 | |
| 1989 | This function recognizes matches according to the same criteria as |
| 1990 | list-matches. |
| 1991 | |
| 1992 | Thus, you could define list-matches like this: |
| 1993 | |
| 1994 | (define (list-matches regexp string . flags) |
| 1995 | (reverse! (apply fold-matches regexp string '() cons flags))) |
| 1996 | |
| 1997 | If present, FLAGS is passed as the FLAGS argument to regexp-exec. |
| 1998 | |
| 1999 | ** Hooks |
| 2000 | |
| 2001 | *** New function: hook? OBJ |
| 2002 | |
| 2003 | Return #t if OBJ is a hook, otherwise #f. |
| 2004 | |
| 2005 | *** New function: make-hook-with-name NAME [ARITY] |
| 2006 | |
| 2007 | Return a hook with name NAME and arity ARITY. The default value for |
| 2008 | ARITY is 0. The only effect of NAME is that it will appear when the |
| 2009 | hook object is printed to ease debugging. |
| 2010 | |
| 2011 | *** New function: hook-empty? HOOK |
| 2012 | |
| 2013 | Return #t if HOOK doesn't contain any procedures, otherwise #f. |
| 2014 | |
| 2015 | *** New function: hook->list HOOK |
| 2016 | |
| 2017 | Return a list of the procedures that are called when run-hook is |
| 2018 | applied to HOOK. |
| 2019 | |
| 2020 | ** `map' signals an error if its argument lists are not all the same length. |
| 2021 | |
| 2022 | This is the behavior required by R5RS, so this change is really a bug |
| 2023 | fix. But it seems to affect a lot of people's code, so we're |
| 2024 | mentioning it here anyway. |
| 2025 | |
| 2026 | ** Print-state handling has been made more transparent |
| 2027 | |
| 2028 | Under certain circumstances, ports are represented as a port with an |
| 2029 | associated print state. Earlier, this pair was represented as a pair |
| 2030 | (see "Some magic has been added to the printer" below). It is now |
| 2031 | indistinguishable (almost; see `get-print-state') from a port on the |
| 2032 | user level. |
| 2033 | |
| 2034 | *** New function: port-with-print-state OUTPUT-PORT PRINT-STATE |
| 2035 | |
| 2036 | Return a new port with the associated print state PRINT-STATE. |
| 2037 | |
| 2038 | *** New function: get-print-state OUTPUT-PORT |
| 2039 | |
| 2040 | Return the print state associated with this port if it exists, |
| 2041 | otherwise return #f. |
| 2042 | |
| 2043 | *** New function: directory-stream? OBJECT |
| 2044 | |
| 2045 | Returns true iff OBJECT is a directory stream --- the sort of object |
| 2046 | returned by `opendir'. |
| 2047 | |
| 2048 | ** New function: using-readline? |
| 2049 | |
| 2050 | Return #t if readline is in use in the current repl. |
| 2051 | |
| 2052 | ** structs will be removed in 1.4 |
| 2053 | |
| 2054 | Structs will be replaced in Guile 1.4. We will merge GOOPS into Guile |
| 2055 | and use GOOPS objects as the fundamental record type. |
| 2056 | |
| 2057 | * Changes to the scm_ interface |
| 2058 | |
| 2059 | ** structs will be removed in 1.4 |
| 2060 | |
| 2061 | The entire current struct interface (struct.c, struct.h) will be |
| 2062 | replaced in Guile 1.4. We will merge GOOPS into libguile and use |
| 2063 | GOOPS objects as the fundamental record type. |
| 2064 | |
| 2065 | ** The internal representation of subr's has changed |
| 2066 | |
| 2067 | Instead of giving a hint to the subr name, the CAR field of the subr |
| 2068 | now contains an index to a subr entry in scm_subr_table. |
| 2069 | |
| 2070 | *** New variable: scm_subr_table |
| 2071 | |
| 2072 | An array of subr entries. A subr entry contains the name, properties |
| 2073 | and documentation associated with the subr. The properties and |
| 2074 | documentation slots are not yet used. |
| 2075 | |
| 2076 | ** A new scheme for "forwarding" calls to a builtin to a generic function |
| 2077 | |
| 2078 | It is now possible to extend the functionality of some Guile |
| 2079 | primitives by letting them defer a call to a GOOPS generic function on |
| 2080 | argument mismatch. This means that there is no loss of efficiency in |
| 2081 | normal evaluation. |
| 2082 | |
| 2083 | Example: |
| 2084 | |
| 2085 | (use-modules (oop goops)) ; Must be GOOPS version 0.2. |
| 2086 | (define-method + ((x <string>) (y <string>)) |
| 2087 | (string-append x y)) |
| 2088 | |
| 2089 | + will still be as efficient as usual in numerical calculations, but |
| 2090 | can also be used for concatenating strings. |
| 2091 | |
| 2092 | Who will be the first one to extend Guile's numerical tower to |
| 2093 | rationals? :) [OK, there a few other things to fix before this can |
| 2094 | be made in a clean way.] |
| 2095 | |
| 2096 | *** New snarf macros for defining primitives: SCM_GPROC, SCM_GPROC1 |
| 2097 | |
| 2098 | New macro: SCM_GPROC (CNAME, SNAME, REQ, OPT, VAR, CFUNC, GENERIC) |
| 2099 | |
| 2100 | New macro: SCM_GPROC1 (CNAME, SNAME, TYPE, CFUNC, GENERIC) |
| 2101 | |
| 2102 | These do the same job as SCM_PROC and SCM_PROC1, but they also define |
| 2103 | a variable GENERIC which can be used by the dispatch macros below. |
| 2104 | |
| 2105 | [This is experimental code which may change soon.] |
| 2106 | |
| 2107 | *** New macros for forwarding control to a generic on arg type error |
| 2108 | |
| 2109 | New macro: SCM_WTA_DISPATCH_1 (GENERIC, ARG1, POS, SUBR) |
| 2110 | |
| 2111 | New macro: SCM_WTA_DISPATCH_2 (GENERIC, ARG1, ARG2, POS, SUBR) |
| 2112 | |
| 2113 | These correspond to the scm_wta function call, and have the same |
| 2114 | behaviour until the user has called the GOOPS primitive |
| 2115 | `enable-primitive-generic!'. After that, these macros will apply the |
| 2116 | generic function GENERIC to the argument(s) instead of calling |
| 2117 | scm_wta. |
| 2118 | |
| 2119 | [This is experimental code which may change soon.] |
| 2120 | |
| 2121 | *** New macros for argument testing with generic dispatch |
| 2122 | |
| 2123 | New macro: SCM_GASSERT1 (COND, GENERIC, ARG1, POS, SUBR) |
| 2124 | |
| 2125 | New macro: SCM_GASSERT2 (COND, GENERIC, ARG1, ARG2, POS, SUBR) |
| 2126 | |
| 2127 | These correspond to the SCM_ASSERT macro, but will defer control to |
| 2128 | GENERIC on error after `enable-primitive-generic!' has been called. |
| 2129 | |
| 2130 | [This is experimental code which may change soon.] |
| 2131 | |
| 2132 | ** New function: SCM scm_eval_body (SCM body, SCM env) |
| 2133 | |
| 2134 | Evaluates the body of a special form. |
| 2135 | |
| 2136 | ** The internal representation of struct's has changed |
| 2137 | |
| 2138 | Previously, four slots were allocated for the procedure(s) of entities |
| 2139 | and operators. The motivation for this representation had to do with |
| 2140 | the structure of the evaluator, the wish to support tail-recursive |
| 2141 | generic functions, and efficiency. Since the generic function |
| 2142 | dispatch mechanism has changed, there is no longer a need for such an |
| 2143 | expensive representation, and the representation has been simplified. |
| 2144 | |
| 2145 | This should not make any difference for most users. |
| 2146 | |
| 2147 | ** GOOPS support has been cleaned up. |
| 2148 | |
| 2149 | Some code has been moved from eval.c to objects.c and code in both of |
| 2150 | these compilation units has been cleaned up and better structured. |
| 2151 | |
| 2152 | *** New functions for applying generic functions |
| 2153 | |
| 2154 | New function: SCM scm_apply_generic (GENERIC, ARGS) |
| 2155 | New function: SCM scm_call_generic_0 (GENERIC) |
| 2156 | New function: SCM scm_call_generic_1 (GENERIC, ARG1) |
| 2157 | New function: SCM scm_call_generic_2 (GENERIC, ARG1, ARG2) |
| 2158 | New function: SCM scm_call_generic_3 (GENERIC, ARG1, ARG2, ARG3) |
| 2159 | |
| 2160 | ** Deprecated function: scm_make_named_hook |
| 2161 | |
| 2162 | It is now replaced by: |
| 2163 | |
| 2164 | ** New function: SCM scm_create_hook (const char *name, int arity) |
| 2165 | |
| 2166 | Creates a hook in the same way as make-hook above but also |
| 2167 | binds a variable named NAME to it. |
| 2168 | |
| 2169 | This is the typical way of creating a hook from C code. |
| 2170 | |
| 2171 | Currently, the variable is created in the "current" module. |
| 2172 | This might change when we get the new module system. |
| 2173 | |
| 2174 | [The behaviour is identical to scm_make_named_hook.] |
| 2175 | |
| 2176 | |
| 2177 | \f |
| 2178 | Changes since Guile 1.3: |
| 2179 | |
| 2180 | * Changes to mailing lists |
| 2181 | |
| 2182 | ** Some of the Guile mailing lists have moved to sourceware.cygnus.com. |
| 2183 | |
| 2184 | See the README file to find current addresses for all the Guile |
| 2185 | mailing lists. |
| 2186 | |
| 2187 | * Changes to the distribution |
| 2188 | |
| 2189 | ** Readline support is no longer included with Guile by default. |
| 2190 | |
| 2191 | Based on the different license terms of Guile and Readline, we |
| 2192 | concluded that Guile should not *by default* cause the linking of |
| 2193 | Readline into an application program. Readline support is now offered |
| 2194 | as a separate module, which is linked into an application only when |
| 2195 | you explicitly specify it. |
| 2196 | |
| 2197 | Although Guile is GNU software, its distribution terms add a special |
| 2198 | exception to the usual GNU General Public License (GPL). Guile's |
| 2199 | license includes a clause that allows you to link Guile with non-free |
| 2200 | programs. We add this exception so as not to put Guile at a |
| 2201 | disadvantage vis-a-vis other extensibility packages that support other |
| 2202 | languages. |
| 2203 | |
| 2204 | In contrast, the GNU Readline library is distributed under the GNU |
| 2205 | General Public License pure and simple. This means that you may not |
| 2206 | link Readline, even dynamically, into an application unless it is |
| 2207 | distributed under a free software license that is compatible the GPL. |
| 2208 | |
| 2209 | Because of this difference in distribution terms, an application that |
| 2210 | can use Guile may not be able to use Readline. Now users will be |
| 2211 | explicitly offered two independent decisions about the use of these |
| 2212 | two packages. |
| 2213 | |
| 2214 | You can activate the readline support by issuing |
| 2215 | |
| 2216 | (use-modules (readline-activator)) |
| 2217 | (activate-readline) |
| 2218 | |
| 2219 | from your ".guile" file, for example. |
| 2220 | |
| 2221 | * Changes to the stand-alone interpreter |
| 2222 | |
| 2223 | ** All builtins now print as primitives. |
| 2224 | Previously builtin procedures not belonging to the fundamental subr |
| 2225 | types printed as #<compiled closure #<primitive-procedure gsubr-apply>>. |
| 2226 | Now, they print as #<primitive-procedure NAME>. |
| 2227 | |
| 2228 | ** Backtraces slightly more intelligible. |
| 2229 | gsubr-apply and macro transformer application frames no longer appear |
| 2230 | in backtraces. |
| 2231 | |
| 2232 | * Changes to Scheme functions and syntax |
| 2233 | |
| 2234 | ** Guile now correctly handles internal defines by rewriting them into |
| 2235 | their equivalent letrec. Previously, internal defines would |
| 2236 | incrementally add to the innermost environment, without checking |
| 2237 | whether the restrictions specified in RnRS were met. This lead to the |
| 2238 | correct behaviour when these restriction actually were met, but didn't |
| 2239 | catch all illegal uses. Such an illegal use could lead to crashes of |
| 2240 | the Guile interpreter or or other unwanted results. An example of |
| 2241 | incorrect internal defines that made Guile behave erratically: |
| 2242 | |
| 2243 | (let () |
| 2244 | (define a 1) |
| 2245 | (define (b) a) |
| 2246 | (define c (1+ (b))) |
| 2247 | (define d 3) |
| 2248 | |
| 2249 | (b)) |
| 2250 | |
| 2251 | => 2 |
| 2252 | |
| 2253 | The problem with this example is that the definition of `c' uses the |
| 2254 | value of `b' directly. This confuses the meoization machine of Guile |
| 2255 | so that the second call of `b' (this time in a larger environment that |
| 2256 | also contains bindings for `c' and `d') refers to the binding of `c' |
| 2257 | instead of `a'. You could also make Guile crash with a variation on |
| 2258 | this theme: |
| 2259 | |
| 2260 | (define (foo flag) |
| 2261 | (define a 1) |
| 2262 | (define (b flag) (if flag a 1)) |
| 2263 | (define c (1+ (b flag))) |
| 2264 | (define d 3) |
| 2265 | |
| 2266 | (b #t)) |
| 2267 | |
| 2268 | (foo #f) |
| 2269 | (foo #t) |
| 2270 | |
| 2271 | From now on, Guile will issue an `Unbound variable: b' error message |
| 2272 | for both examples. |
| 2273 | |
| 2274 | ** Hooks |
| 2275 | |
| 2276 | A hook contains a list of functions which should be called on |
| 2277 | particular occasions in an existing program. Hooks are used for |
| 2278 | customization. |
| 2279 | |
| 2280 | A window manager might have a hook before-window-map-hook. The window |
| 2281 | manager uses the function run-hooks to call all functions stored in |
| 2282 | before-window-map-hook each time a window is mapped. The user can |
| 2283 | store functions in the hook using add-hook!. |
| 2284 | |
| 2285 | In Guile, hooks are first class objects. |
| 2286 | |
| 2287 | *** New function: make-hook [N_ARGS] |
| 2288 | |
| 2289 | Return a hook for hook functions which can take N_ARGS arguments. |
| 2290 | The default value for N_ARGS is 0. |
| 2291 | |
| 2292 | (See also scm_make_named_hook below.) |
| 2293 | |
| 2294 | *** New function: add-hook! HOOK PROC [APPEND_P] |
| 2295 | |
| 2296 | Put PROC at the beginning of the list of functions stored in HOOK. |
| 2297 | If APPEND_P is supplied, and non-false, put PROC at the end instead. |
| 2298 | |
| 2299 | PROC must be able to take the number of arguments specified when the |
| 2300 | hook was created. |
| 2301 | |
| 2302 | If PROC already exists in HOOK, then remove it first. |
| 2303 | |
| 2304 | *** New function: remove-hook! HOOK PROC |
| 2305 | |
| 2306 | Remove PROC from the list of functions in HOOK. |
| 2307 | |
| 2308 | *** New function: reset-hook! HOOK |
| 2309 | |
| 2310 | Clear the list of hook functions stored in HOOK. |
| 2311 | |
| 2312 | *** New function: run-hook HOOK ARG1 ... |
| 2313 | |
| 2314 | Run all hook functions stored in HOOK with arguments ARG1 ... . |
| 2315 | The number of arguments supplied must correspond to the number given |
| 2316 | when the hook was created. |
| 2317 | |
| 2318 | ** The function `dynamic-link' now takes optional keyword arguments. |
| 2319 | The only keyword argument that is currently defined is `:global |
| 2320 | BOOL'. With it, you can control whether the shared library will be |
| 2321 | linked in global mode or not. In global mode, the symbols from the |
| 2322 | linked library can be used to resolve references from other |
| 2323 | dynamically linked libraries. In non-global mode, the linked |
| 2324 | library is essentially invisible and can only be accessed via |
| 2325 | `dynamic-func', etc. The default is now to link in global mode. |
| 2326 | Previously, the default has been non-global mode. |
| 2327 | |
| 2328 | The `#:global' keyword is only effective on platforms that support |
| 2329 | the dlopen family of functions. |
| 2330 | |
| 2331 | ** New function `provided?' |
| 2332 | |
| 2333 | - Function: provided? FEATURE |
| 2334 | Return true iff FEATURE is supported by this installation of |
| 2335 | Guile. FEATURE must be a symbol naming a feature; the global |
| 2336 | variable `*features*' is a list of available features. |
| 2337 | |
| 2338 | ** Changes to the module (ice-9 expect): |
| 2339 | |
| 2340 | *** The expect-strings macro now matches `$' in a regular expression |
| 2341 | only at a line-break or end-of-file by default. Previously it would |
| 2342 | match the end of the string accumulated so far. The old behaviour |
| 2343 | can be obtained by setting the variable `expect-strings-exec-flags' |
| 2344 | to 0. |
| 2345 | |
| 2346 | *** The expect-strings macro now uses a variable `expect-strings-exec-flags' |
| 2347 | for the regexp-exec flags. If `regexp/noteol' is included, then `$' |
| 2348 | in a regular expression will still match before a line-break or |
| 2349 | end-of-file. The default is `regexp/noteol'. |
| 2350 | |
| 2351 | *** The expect-strings macro now uses a variable |
| 2352 | `expect-strings-compile-flags' for the flags to be supplied to |
| 2353 | `make-regexp'. The default is `regexp/newline', which was previously |
| 2354 | hard-coded. |
| 2355 | |
| 2356 | *** The expect macro now supplies two arguments to a match procedure: |
| 2357 | the current accumulated string and a flag to indicate whether |
| 2358 | end-of-file has been reached. Previously only the string was supplied. |
| 2359 | If end-of-file is reached, the match procedure will be called an |
| 2360 | additional time with the same accumulated string as the previous call |
| 2361 | but with the flag set. |
| 2362 | |
| 2363 | ** New module (ice-9 format), implementing the Common Lisp `format' function. |
| 2364 | |
| 2365 | This code, and the documentation for it that appears here, was |
| 2366 | borrowed from SLIB, with minor adaptations for Guile. |
| 2367 | |
| 2368 | - Function: format DESTINATION FORMAT-STRING . ARGUMENTS |
| 2369 | An almost complete implementation of Common LISP format description |
| 2370 | according to the CL reference book `Common LISP' from Guy L. |
| 2371 | Steele, Digital Press. Backward compatible to most of the |
| 2372 | available Scheme format implementations. |
| 2373 | |
| 2374 | Returns `#t', `#f' or a string; has side effect of printing |
| 2375 | according to FORMAT-STRING. If DESTINATION is `#t', the output is |
| 2376 | to the current output port and `#t' is returned. If DESTINATION |
| 2377 | is `#f', a formatted string is returned as the result of the call. |
| 2378 | NEW: If DESTINATION is a string, DESTINATION is regarded as the |
| 2379 | format string; FORMAT-STRING is then the first argument and the |
| 2380 | output is returned as a string. If DESTINATION is a number, the |
| 2381 | output is to the current error port if available by the |
| 2382 | implementation. Otherwise DESTINATION must be an output port and |
| 2383 | `#t' is returned. |
| 2384 | |
| 2385 | FORMAT-STRING must be a string. In case of a formatting error |
| 2386 | format returns `#f' and prints a message on the current output or |
| 2387 | error port. Characters are output as if the string were output by |
| 2388 | the `display' function with the exception of those prefixed by a |
| 2389 | tilde (~). For a detailed description of the FORMAT-STRING syntax |
| 2390 | please consult a Common LISP format reference manual. For a test |
| 2391 | suite to verify this format implementation load `formatst.scm'. |
| 2392 | Please send bug reports to `lutzeb@cs.tu-berlin.de'. |
| 2393 | |
| 2394 | Note: `format' is not reentrant, i.e. only one `format'-call may |
| 2395 | be executed at a time. |
| 2396 | |
| 2397 | |
| 2398 | *** Format Specification (Format version 3.0) |
| 2399 | |
| 2400 | Please consult a Common LISP format reference manual for a detailed |
| 2401 | description of the format string syntax. For a demonstration of the |
| 2402 | implemented directives see `formatst.scm'. |
| 2403 | |
| 2404 | This implementation supports directive parameters and modifiers (`:' |
| 2405 | and `@' characters). Multiple parameters must be separated by a comma |
| 2406 | (`,'). Parameters can be numerical parameters (positive or negative), |
| 2407 | character parameters (prefixed by a quote character (`''), variable |
| 2408 | parameters (`v'), number of rest arguments parameter (`#'), empty and |
| 2409 | default parameters. Directive characters are case independent. The |
| 2410 | general form of a directive is: |
| 2411 | |
| 2412 | DIRECTIVE ::= ~{DIRECTIVE-PARAMETER,}[:][@]DIRECTIVE-CHARACTER |
| 2413 | |
| 2414 | DIRECTIVE-PARAMETER ::= [ [-|+]{0-9}+ | 'CHARACTER | v | # ] |
| 2415 | |
| 2416 | *** Implemented CL Format Control Directives |
| 2417 | |
| 2418 | Documentation syntax: Uppercase characters represent the |
| 2419 | corresponding control directive characters. Lowercase characters |
| 2420 | represent control directive parameter descriptions. |
| 2421 | |
| 2422 | `~A' |
| 2423 | Any (print as `display' does). |
| 2424 | `~@A' |
| 2425 | left pad. |
| 2426 | |
| 2427 | `~MINCOL,COLINC,MINPAD,PADCHARA' |
| 2428 | full padding. |
| 2429 | |
| 2430 | `~S' |
| 2431 | S-expression (print as `write' does). |
| 2432 | `~@S' |
| 2433 | left pad. |
| 2434 | |
| 2435 | `~MINCOL,COLINC,MINPAD,PADCHARS' |
| 2436 | full padding. |
| 2437 | |
| 2438 | `~D' |
| 2439 | Decimal. |
| 2440 | `~@D' |
| 2441 | print number sign always. |
| 2442 | |
| 2443 | `~:D' |
| 2444 | print comma separated. |
| 2445 | |
| 2446 | `~MINCOL,PADCHAR,COMMACHARD' |
| 2447 | padding. |
| 2448 | |
| 2449 | `~X' |
| 2450 | Hexadecimal. |
| 2451 | `~@X' |
| 2452 | print number sign always. |
| 2453 | |
| 2454 | `~:X' |
| 2455 | print comma separated. |
| 2456 | |
| 2457 | `~MINCOL,PADCHAR,COMMACHARX' |
| 2458 | padding. |
| 2459 | |
| 2460 | `~O' |
| 2461 | Octal. |
| 2462 | `~@O' |
| 2463 | print number sign always. |
| 2464 | |
| 2465 | `~:O' |
| 2466 | print comma separated. |
| 2467 | |
| 2468 | `~MINCOL,PADCHAR,COMMACHARO' |
| 2469 | padding. |
| 2470 | |
| 2471 | `~B' |
| 2472 | Binary. |
| 2473 | `~@B' |
| 2474 | print number sign always. |
| 2475 | |
| 2476 | `~:B' |
| 2477 | print comma separated. |
| 2478 | |
| 2479 | `~MINCOL,PADCHAR,COMMACHARB' |
| 2480 | padding. |
| 2481 | |
| 2482 | `~NR' |
| 2483 | Radix N. |
| 2484 | `~N,MINCOL,PADCHAR,COMMACHARR' |
| 2485 | padding. |
| 2486 | |
| 2487 | `~@R' |
| 2488 | print a number as a Roman numeral. |
| 2489 | |
| 2490 | `~:@R' |
| 2491 | print a number as an "old fashioned" Roman numeral. |
| 2492 | |
| 2493 | `~:R' |
| 2494 | print a number as an ordinal English number. |
| 2495 | |
| 2496 | `~:@R' |
| 2497 | print a number as a cardinal English number. |
| 2498 | |
| 2499 | `~P' |
| 2500 | Plural. |
| 2501 | `~@P' |
| 2502 | prints `y' and `ies'. |
| 2503 | |
| 2504 | `~:P' |
| 2505 | as `~P but jumps 1 argument backward.' |
| 2506 | |
| 2507 | `~:@P' |
| 2508 | as `~@P but jumps 1 argument backward.' |
| 2509 | |
| 2510 | `~C' |
| 2511 | Character. |
| 2512 | `~@C' |
| 2513 | prints a character as the reader can understand it (i.e. `#\' |
| 2514 | prefixing). |
| 2515 | |
| 2516 | `~:C' |
| 2517 | prints a character as emacs does (eg. `^C' for ASCII 03). |
| 2518 | |
| 2519 | `~F' |
| 2520 | Fixed-format floating-point (prints a flonum like MMM.NNN). |
| 2521 | `~WIDTH,DIGITS,SCALE,OVERFLOWCHAR,PADCHARF' |
| 2522 | `~@F' |
| 2523 | If the number is positive a plus sign is printed. |
| 2524 | |
| 2525 | `~E' |
| 2526 | Exponential floating-point (prints a flonum like MMM.NNN`E'EE). |
| 2527 | `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARE' |
| 2528 | `~@E' |
| 2529 | If the number is positive a plus sign is printed. |
| 2530 | |
| 2531 | `~G' |
| 2532 | General floating-point (prints a flonum either fixed or |
| 2533 | exponential). |
| 2534 | `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARG' |
| 2535 | `~@G' |
| 2536 | If the number is positive a plus sign is printed. |
| 2537 | |
| 2538 | `~$' |
| 2539 | Dollars floating-point (prints a flonum in fixed with signs |
| 2540 | separated). |
| 2541 | `~DIGITS,SCALE,WIDTH,PADCHAR$' |
| 2542 | `~@$' |
| 2543 | If the number is positive a plus sign is printed. |
| 2544 | |
| 2545 | `~:@$' |
| 2546 | A sign is always printed and appears before the padding. |
| 2547 | |
| 2548 | `~:$' |
| 2549 | The sign appears before the padding. |
| 2550 | |
| 2551 | `~%' |
| 2552 | Newline. |
| 2553 | `~N%' |
| 2554 | print N newlines. |
| 2555 | |
| 2556 | `~&' |
| 2557 | print newline if not at the beginning of the output line. |
| 2558 | `~N&' |
| 2559 | prints `~&' and then N-1 newlines. |
| 2560 | |
| 2561 | `~|' |
| 2562 | Page Separator. |
| 2563 | `~N|' |
| 2564 | print N page separators. |
| 2565 | |
| 2566 | `~~' |
| 2567 | Tilde. |
| 2568 | `~N~' |
| 2569 | print N tildes. |
| 2570 | |
| 2571 | `~'<newline> |
| 2572 | Continuation Line. |
| 2573 | `~:'<newline> |
| 2574 | newline is ignored, white space left. |
| 2575 | |
| 2576 | `~@'<newline> |
| 2577 | newline is left, white space ignored. |
| 2578 | |
| 2579 | `~T' |
| 2580 | Tabulation. |
| 2581 | `~@T' |
| 2582 | relative tabulation. |
| 2583 | |
| 2584 | `~COLNUM,COLINCT' |
| 2585 | full tabulation. |
| 2586 | |
| 2587 | `~?' |
| 2588 | Indirection (expects indirect arguments as a list). |
| 2589 | `~@?' |
| 2590 | extracts indirect arguments from format arguments. |
| 2591 | |
| 2592 | `~(STR~)' |
| 2593 | Case conversion (converts by `string-downcase'). |
| 2594 | `~:(STR~)' |
| 2595 | converts by `string-capitalize'. |
| 2596 | |
| 2597 | `~@(STR~)' |
| 2598 | converts by `string-capitalize-first'. |
| 2599 | |
| 2600 | `~:@(STR~)' |
| 2601 | converts by `string-upcase'. |
| 2602 | |
| 2603 | `~*' |
| 2604 | Argument Jumping (jumps 1 argument forward). |
| 2605 | `~N*' |
| 2606 | jumps N arguments forward. |
| 2607 | |
| 2608 | `~:*' |
| 2609 | jumps 1 argument backward. |
| 2610 | |
| 2611 | `~N:*' |
| 2612 | jumps N arguments backward. |
| 2613 | |
| 2614 | `~@*' |
| 2615 | jumps to the 0th argument. |
| 2616 | |
| 2617 | `~N@*' |
| 2618 | jumps to the Nth argument (beginning from 0) |
| 2619 | |
| 2620 | `~[STR0~;STR1~;...~;STRN~]' |
| 2621 | Conditional Expression (numerical clause conditional). |
| 2622 | `~N[' |
| 2623 | take argument from N. |
| 2624 | |
| 2625 | `~@[' |
| 2626 | true test conditional. |
| 2627 | |
| 2628 | `~:[' |
| 2629 | if-else-then conditional. |
| 2630 | |
| 2631 | `~;' |
| 2632 | clause separator. |
| 2633 | |
| 2634 | `~:;' |
| 2635 | default clause follows. |
| 2636 | |
| 2637 | `~{STR~}' |
| 2638 | Iteration (args come from the next argument (a list)). |
| 2639 | `~N{' |
| 2640 | at most N iterations. |
| 2641 | |
| 2642 | `~:{' |
| 2643 | args from next arg (a list of lists). |
| 2644 | |
| 2645 | `~@{' |
| 2646 | args from the rest of arguments. |
| 2647 | |
| 2648 | `~:@{' |
| 2649 | args from the rest args (lists). |
| 2650 | |
| 2651 | `~^' |
| 2652 | Up and out. |
| 2653 | `~N^' |
| 2654 | aborts if N = 0 |
| 2655 | |
| 2656 | `~N,M^' |
| 2657 | aborts if N = M |
| 2658 | |
| 2659 | `~N,M,K^' |
| 2660 | aborts if N <= M <= K |
| 2661 | |
| 2662 | *** Not Implemented CL Format Control Directives |
| 2663 | |
| 2664 | `~:A' |
| 2665 | print `#f' as an empty list (see below). |
| 2666 | |
| 2667 | `~:S' |
| 2668 | print `#f' as an empty list (see below). |
| 2669 | |
| 2670 | `~<~>' |
| 2671 | Justification. |
| 2672 | |
| 2673 | `~:^' |
| 2674 | (sorry I don't understand its semantics completely) |
| 2675 | |
| 2676 | *** Extended, Replaced and Additional Control Directives |
| 2677 | |
| 2678 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHD' |
| 2679 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHX' |
| 2680 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHO' |
| 2681 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHB' |
| 2682 | `~N,MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHR' |
| 2683 | COMMAWIDTH is the number of characters between two comma |
| 2684 | characters. |
| 2685 | |
| 2686 | `~I' |
| 2687 | print a R4RS complex number as `~F~@Fi' with passed parameters for |
| 2688 | `~F'. |
| 2689 | |
| 2690 | `~Y' |
| 2691 | Pretty print formatting of an argument for scheme code lists. |
| 2692 | |
| 2693 | `~K' |
| 2694 | Same as `~?.' |
| 2695 | |
| 2696 | `~!' |
| 2697 | Flushes the output if format DESTINATION is a port. |
| 2698 | |
| 2699 | `~_' |
| 2700 | Print a `#\space' character |
| 2701 | `~N_' |
| 2702 | print N `#\space' characters. |
| 2703 | |
| 2704 | `~/' |
| 2705 | Print a `#\tab' character |
| 2706 | `~N/' |
| 2707 | print N `#\tab' characters. |
| 2708 | |
| 2709 | `~NC' |
| 2710 | Takes N as an integer representation for a character. No arguments |
| 2711 | are consumed. N is converted to a character by `integer->char'. N |
| 2712 | must be a positive decimal number. |
| 2713 | |
| 2714 | `~:S' |
| 2715 | Print out readproof. Prints out internal objects represented as |
| 2716 | `#<...>' as strings `"#<...>"' so that the format output can always |
| 2717 | be processed by `read'. |
| 2718 | |
| 2719 | `~:A' |
| 2720 | Print out readproof. Prints out internal objects represented as |
| 2721 | `#<...>' as strings `"#<...>"' so that the format output can always |
| 2722 | be processed by `read'. |
| 2723 | |
| 2724 | `~Q' |
| 2725 | Prints information and a copyright notice on the format |
| 2726 | implementation. |
| 2727 | `~:Q' |
| 2728 | prints format version. |
| 2729 | |
| 2730 | `~F, ~E, ~G, ~$' |
| 2731 | may also print number strings, i.e. passing a number as a string |
| 2732 | and format it accordingly. |
| 2733 | |
| 2734 | *** Configuration Variables |
| 2735 | |
| 2736 | The format module exports some configuration variables to suit the |
| 2737 | systems and users needs. There should be no modification necessary for |
| 2738 | the configuration that comes with Guile. Format detects automatically |
| 2739 | if the running scheme system implements floating point numbers and |
| 2740 | complex numbers. |
| 2741 | |
| 2742 | format:symbol-case-conv |
| 2743 | Symbols are converted by `symbol->string' so the case type of the |
| 2744 | printed symbols is implementation dependent. |
| 2745 | `format:symbol-case-conv' is a one arg closure which is either |
| 2746 | `#f' (no conversion), `string-upcase', `string-downcase' or |
| 2747 | `string-capitalize'. (default `#f') |
| 2748 | |
| 2749 | format:iobj-case-conv |
| 2750 | As FORMAT:SYMBOL-CASE-CONV but applies for the representation of |
| 2751 | implementation internal objects. (default `#f') |
| 2752 | |
| 2753 | format:expch |
| 2754 | The character prefixing the exponent value in `~E' printing. |
| 2755 | (default `#\E') |
| 2756 | |
| 2757 | *** Compatibility With Other Format Implementations |
| 2758 | |
| 2759 | SLIB format 2.x: |
| 2760 | See `format.doc'. |
| 2761 | |
| 2762 | SLIB format 1.4: |
| 2763 | Downward compatible except for padding support and `~A', `~S', |
| 2764 | `~P', `~X' uppercase printing. SLIB format 1.4 uses C-style |
| 2765 | `printf' padding support which is completely replaced by the CL |
| 2766 | `format' padding style. |
| 2767 | |
| 2768 | MIT C-Scheme 7.1: |
| 2769 | Downward compatible except for `~', which is not documented |
| 2770 | (ignores all characters inside the format string up to a newline |
| 2771 | character). (7.1 implements `~a', `~s', ~NEWLINE, `~~', `~%', |
| 2772 | numerical and variable parameters and `:/@' modifiers in the CL |
| 2773 | sense). |
| 2774 | |
| 2775 | Elk 1.5/2.0: |
| 2776 | Downward compatible except for `~A' and `~S' which print in |
| 2777 | uppercase. (Elk implements `~a', `~s', `~~', and `~%' (no |
| 2778 | directive parameters or modifiers)). |
| 2779 | |
| 2780 | Scheme->C 01nov91: |
| 2781 | Downward compatible except for an optional destination parameter: |
| 2782 | S2C accepts a format call without a destination which returns a |
| 2783 | formatted string. This is equivalent to a #f destination in S2C. |
| 2784 | (S2C implements `~a', `~s', `~c', `~%', and `~~' (no directive |
| 2785 | parameters or modifiers)). |
| 2786 | |
| 2787 | |
| 2788 | ** Changes to string-handling functions. |
| 2789 | |
| 2790 | These functions were added to support the (ice-9 format) module, above. |
| 2791 | |
| 2792 | *** New function: string-upcase STRING |
| 2793 | *** New function: string-downcase STRING |
| 2794 | |
| 2795 | These are non-destructive versions of the existing string-upcase! and |
| 2796 | string-downcase! functions. |
| 2797 | |
| 2798 | *** New function: string-capitalize! STRING |
| 2799 | *** New function: string-capitalize STRING |
| 2800 | |
| 2801 | These functions convert the first letter of each word in the string to |
| 2802 | upper case. Thus: |
| 2803 | |
| 2804 | (string-capitalize "howdy there") |
| 2805 | => "Howdy There" |
| 2806 | |
| 2807 | As with the other functions, string-capitalize! modifies the string in |
| 2808 | place, while string-capitalize returns a modified copy of its argument. |
| 2809 | |
| 2810 | *** New function: string-ci->symbol STRING |
| 2811 | |
| 2812 | Return a symbol whose name is STRING, but having the same case as if |
| 2813 | the symbol had be read by `read'. |
| 2814 | |
| 2815 | Guile can be configured to be sensitive or insensitive to case |
| 2816 | differences in Scheme identifiers. If Guile is case-insensitive, all |
| 2817 | symbols are converted to lower case on input. The `string-ci->symbol' |
| 2818 | function returns a symbol whose name in STRING, transformed as Guile |
| 2819 | would if STRING were input. |
| 2820 | |
| 2821 | *** New function: substring-move! STRING1 START END STRING2 START |
| 2822 | |
| 2823 | Copy the substring of STRING1 from START (inclusive) to END |
| 2824 | (exclusive) to STRING2 at START. STRING1 and STRING2 may be the same |
| 2825 | string, and the source and destination areas may overlap; in all |
| 2826 | cases, the function behaves as if all the characters were copied |
| 2827 | simultanously. |
| 2828 | |
| 2829 | *** Extended functions: substring-move-left! substring-move-right! |
| 2830 | |
| 2831 | These functions now correctly copy arbitrarily overlapping substrings; |
| 2832 | they are both synonyms for substring-move!. |
| 2833 | |
| 2834 | |
| 2835 | ** New module (ice-9 getopt-long), with the function `getopt-long'. |
| 2836 | |
| 2837 | getopt-long is a function for parsing command-line arguments in a |
| 2838 | manner consistent with other GNU programs. |
| 2839 | |
| 2840 | (getopt-long ARGS GRAMMAR) |
| 2841 | Parse the arguments ARGS according to the argument list grammar GRAMMAR. |
| 2842 | |
| 2843 | ARGS should be a list of strings. Its first element should be the |
| 2844 | name of the program; subsequent elements should be the arguments |
| 2845 | that were passed to the program on the command line. The |
| 2846 | `program-arguments' procedure returns a list of this form. |
| 2847 | |
| 2848 | GRAMMAR is a list of the form: |
| 2849 | ((OPTION (PROPERTY VALUE) ...) ...) |
| 2850 | |
| 2851 | Each OPTION should be a symbol. `getopt-long' will accept a |
| 2852 | command-line option named `--OPTION'. |
| 2853 | Each option can have the following (PROPERTY VALUE) pairs: |
| 2854 | |
| 2855 | (single-char CHAR) --- Accept `-CHAR' as a single-character |
| 2856 | equivalent to `--OPTION'. This is how to specify traditional |
| 2857 | Unix-style flags. |
| 2858 | (required? BOOL) --- If BOOL is true, the option is required. |
| 2859 | getopt-long will raise an error if it is not found in ARGS. |
| 2860 | (value BOOL) --- If BOOL is #t, the option accepts a value; if |
| 2861 | it is #f, it does not; and if it is the symbol |
| 2862 | `optional', the option may appear in ARGS with or |
| 2863 | without a value. |
| 2864 | (predicate FUNC) --- If the option accepts a value (i.e. you |
| 2865 | specified `(value #t)' for this option), then getopt |
| 2866 | will apply FUNC to the value, and throw an exception |
| 2867 | if it returns #f. FUNC should be a procedure which |
| 2868 | accepts a string and returns a boolean value; you may |
| 2869 | need to use quasiquotes to get it into GRAMMAR. |
| 2870 | |
| 2871 | The (PROPERTY VALUE) pairs may occur in any order, but each |
| 2872 | property may occur only once. By default, options do not have |
| 2873 | single-character equivalents, are not required, and do not take |
| 2874 | values. |
| 2875 | |
| 2876 | In ARGS, single-character options may be combined, in the usual |
| 2877 | Unix fashion: ("-x" "-y") is equivalent to ("-xy"). If an option |
| 2878 | accepts values, then it must be the last option in the |
| 2879 | combination; the value is the next argument. So, for example, using |
| 2880 | the following grammar: |
| 2881 | ((apples (single-char #\a)) |
| 2882 | (blimps (single-char #\b) (value #t)) |
| 2883 | (catalexis (single-char #\c) (value #t))) |
| 2884 | the following argument lists would be acceptable: |
| 2885 | ("-a" "-b" "bang" "-c" "couth") ("bang" and "couth" are the values |
| 2886 | for "blimps" and "catalexis") |
| 2887 | ("-ab" "bang" "-c" "couth") (same) |
| 2888 | ("-ac" "couth" "-b" "bang") (same) |
| 2889 | ("-abc" "couth" "bang") (an error, since `-b' is not the |
| 2890 | last option in its combination) |
| 2891 | |
| 2892 | If an option's value is optional, then `getopt-long' decides |
| 2893 | whether it has a value by looking at what follows it in ARGS. If |
| 2894 | the next element is a string, and it does not appear to be an |
| 2895 | option itself, then that string is the option's value. |
| 2896 | |
| 2897 | The value of a long option can appear as the next element in ARGS, |
| 2898 | or it can follow the option name, separated by an `=' character. |
| 2899 | Thus, using the same grammar as above, the following argument lists |
| 2900 | are equivalent: |
| 2901 | ("--apples" "Braeburn" "--blimps" "Goodyear") |
| 2902 | ("--apples=Braeburn" "--blimps" "Goodyear") |
| 2903 | ("--blimps" "Goodyear" "--apples=Braeburn") |
| 2904 | |
| 2905 | If the option "--" appears in ARGS, argument parsing stops there; |
| 2906 | subsequent arguments are returned as ordinary arguments, even if |
| 2907 | they resemble options. So, in the argument list: |
| 2908 | ("--apples" "Granny Smith" "--" "--blimp" "Goodyear") |
| 2909 | `getopt-long' will recognize the `apples' option as having the |
| 2910 | value "Granny Smith", but it will not recognize the `blimp' |
| 2911 | option; it will return the strings "--blimp" and "Goodyear" as |
| 2912 | ordinary argument strings. |
| 2913 | |
| 2914 | The `getopt-long' function returns the parsed argument list as an |
| 2915 | assocation list, mapping option names --- the symbols from GRAMMAR |
| 2916 | --- onto their values, or #t if the option does not accept a value. |
| 2917 | Unused options do not appear in the alist. |
| 2918 | |
| 2919 | All arguments that are not the value of any option are returned |
| 2920 | as a list, associated with the empty list. |
| 2921 | |
| 2922 | `getopt-long' throws an exception if: |
| 2923 | - it finds an unrecognized option in ARGS |
| 2924 | - a required option is omitted |
| 2925 | - an option that requires an argument doesn't get one |
| 2926 | - an option that doesn't accept an argument does get one (this can |
| 2927 | only happen using the long option `--opt=value' syntax) |
| 2928 | - an option predicate fails |
| 2929 | |
| 2930 | So, for example: |
| 2931 | |
| 2932 | (define grammar |
| 2933 | `((lockfile-dir (required? #t) |
| 2934 | (value #t) |
| 2935 | (single-char #\k) |
| 2936 | (predicate ,file-is-directory?)) |
| 2937 | (verbose (required? #f) |
| 2938 | (single-char #\v) |
| 2939 | (value #f)) |
| 2940 | (x-includes (single-char #\x)) |
| 2941 | (rnet-server (single-char #\y) |
| 2942 | (predicate ,string?)))) |
| 2943 | |
| 2944 | (getopt-long '("my-prog" "-vk" "/tmp" "foo1" "--x-includes=/usr/include" |
| 2945 | "--rnet-server=lamprod" "--" "-fred" "foo2" "foo3") |
| 2946 | grammar) |
| 2947 | => ((() "foo1" "-fred" "foo2" "foo3") |
| 2948 | (rnet-server . "lamprod") |
| 2949 | (x-includes . "/usr/include") |
| 2950 | (lockfile-dir . "/tmp") |
| 2951 | (verbose . #t)) |
| 2952 | |
| 2953 | ** The (ice-9 getopt-gnu-style) module is obsolete; use (ice-9 getopt-long). |
| 2954 | |
| 2955 | It will be removed in a few releases. |
| 2956 | |
| 2957 | ** New syntax: lambda* |
| 2958 | ** New syntax: define* |
| 2959 | ** New syntax: define*-public |
| 2960 | ** New syntax: defmacro* |
| 2961 | ** New syntax: defmacro*-public |
| 2962 | Guile now supports optional arguments. |
| 2963 | |
| 2964 | `lambda*', `define*', `define*-public', `defmacro*' and |
| 2965 | `defmacro*-public' are identical to the non-* versions except that |
| 2966 | they use an extended type of parameter list that has the following BNF |
| 2967 | syntax (parentheses are literal, square brackets indicate grouping, |
| 2968 | and `*', `+' and `?' have the usual meaning): |
| 2969 | |
| 2970 | ext-param-list ::= ( [identifier]* [#&optional [ext-var-decl]+]? |
| 2971 | [#&key [ext-var-decl]+ [#&allow-other-keys]?]? |
| 2972 | [[#&rest identifier]|[. identifier]]? ) | [identifier] |
| 2973 | |
| 2974 | ext-var-decl ::= identifier | ( identifier expression ) |
| 2975 | |
| 2976 | The semantics are best illustrated with the following documentation |
| 2977 | and examples for `lambda*': |
| 2978 | |
| 2979 | lambda* args . body |
| 2980 | lambda extended for optional and keyword arguments |
| 2981 | |
| 2982 | lambda* creates a procedure that takes optional arguments. These |
| 2983 | are specified by putting them inside brackets at the end of the |
| 2984 | paramater list, but before any dotted rest argument. For example, |
| 2985 | (lambda* (a b #&optional c d . e) '()) |
| 2986 | creates a procedure with fixed arguments a and b, optional arguments c |
| 2987 | and d, and rest argument e. If the optional arguments are omitted |
| 2988 | in a call, the variables for them are unbound in the procedure. This |
| 2989 | can be checked with the bound? macro. |
| 2990 | |
| 2991 | lambda* can also take keyword arguments. For example, a procedure |
| 2992 | defined like this: |
| 2993 | (lambda* (#&key xyzzy larch) '()) |
| 2994 | can be called with any of the argument lists (#:xyzzy 11) |
| 2995 | (#:larch 13) (#:larch 42 #:xyzzy 19) (). Whichever arguments |
| 2996 | are given as keywords are bound to values. |
| 2997 | |
| 2998 | Optional and keyword arguments can also be given default values |
| 2999 | which they take on when they are not present in a call, by giving a |
| 3000 | two-item list in place of an optional argument, for example in: |
| 3001 | (lambda* (foo #&optional (bar 42) #&key (baz 73)) (list foo bar baz)) |
| 3002 | foo is a fixed argument, bar is an optional argument with default |
| 3003 | value 42, and baz is a keyword argument with default value 73. |
| 3004 | Default value expressions are not evaluated unless they are needed |
| 3005 | and until the procedure is called. |
| 3006 | |
| 3007 | lambda* now supports two more special parameter list keywords. |
| 3008 | |
| 3009 | lambda*-defined procedures now throw an error by default if a |
| 3010 | keyword other than one of those specified is found in the actual |
| 3011 | passed arguments. However, specifying #&allow-other-keys |
| 3012 | immediately after the kyword argument declarations restores the |
| 3013 | previous behavior of ignoring unknown keywords. lambda* also now |
| 3014 | guarantees that if the same keyword is passed more than once, the |
| 3015 | last one passed is the one that takes effect. For example, |
| 3016 | ((lambda* (#&key (heads 0) (tails 0)) (display (list heads tails))) |
| 3017 | #:heads 37 #:tails 42 #:heads 99) |
| 3018 | would result in (99 47) being displayed. |
| 3019 | |
| 3020 | #&rest is also now provided as a synonym for the dotted syntax rest |
| 3021 | argument. The argument lists (a . b) and (a #&rest b) are equivalent in |
| 3022 | all respects to lambda*. This is provided for more similarity to DSSSL, |
| 3023 | MIT-Scheme and Kawa among others, as well as for refugees from other |
| 3024 | Lisp dialects. |
| 3025 | |
| 3026 | Further documentation may be found in the optargs.scm file itself. |
| 3027 | |
| 3028 | The optional argument module also exports the macros `let-optional', |
| 3029 | `let-optional*', `let-keywords', `let-keywords*' and `bound?'. These |
| 3030 | are not documented here because they may be removed in the future, but |
| 3031 | full documentation is still available in optargs.scm. |
| 3032 | |
| 3033 | ** New syntax: and-let* |
| 3034 | Guile now supports the `and-let*' form, described in the draft SRFI-2. |
| 3035 | |
| 3036 | Syntax: (land* (<clause> ...) <body> ...) |
| 3037 | Each <clause> should have one of the following forms: |
| 3038 | (<variable> <expression>) |
| 3039 | (<expression>) |
| 3040 | <bound-variable> |
| 3041 | Each <variable> or <bound-variable> should be an identifier. Each |
| 3042 | <expression> should be a valid expression. The <body> should be a |
| 3043 | possibly empty sequence of expressions, like the <body> of a |
| 3044 | lambda form. |
| 3045 | |
| 3046 | Semantics: A LAND* expression is evaluated by evaluating the |
| 3047 | <expression> or <bound-variable> of each of the <clause>s from |
| 3048 | left to right. The value of the first <expression> or |
| 3049 | <bound-variable> that evaluates to a false value is returned; the |
| 3050 | remaining <expression>s and <bound-variable>s are not evaluated. |
| 3051 | The <body> forms are evaluated iff all the <expression>s and |
| 3052 | <bound-variable>s evaluate to true values. |
| 3053 | |
| 3054 | The <expression>s and the <body> are evaluated in an environment |
| 3055 | binding each <variable> of the preceding (<variable> <expression>) |
| 3056 | clauses to the value of the <expression>. Later bindings |
| 3057 | shadow earlier bindings. |
| 3058 | |
| 3059 | Guile's and-let* macro was contributed by Michael Livshin. |
| 3060 | |
| 3061 | ** New sorting functions |
| 3062 | |
| 3063 | *** New function: sorted? SEQUENCE LESS? |
| 3064 | Returns `#t' when the sequence argument is in non-decreasing order |
| 3065 | according to LESS? (that is, there is no adjacent pair `... x y |
| 3066 | ...' for which `(less? y x)'). |
| 3067 | |
| 3068 | Returns `#f' when the sequence contains at least one out-of-order |
| 3069 | pair. It is an error if the sequence is neither a list nor a |
| 3070 | vector. |
| 3071 | |
| 3072 | *** New function: merge LIST1 LIST2 LESS? |
| 3073 | LIST1 and LIST2 are sorted lists. |
| 3074 | Returns the sorted list of all elements in LIST1 and LIST2. |
| 3075 | |
| 3076 | Assume that the elements a and b1 in LIST1 and b2 in LIST2 are "equal" |
| 3077 | in the sense that (LESS? x y) --> #f for x, y in {a, b1, b2}, |
| 3078 | and that a < b1 in LIST1. Then a < b1 < b2 in the result. |
| 3079 | (Here "<" should read "comes before".) |
| 3080 | |
| 3081 | *** New procedure: merge! LIST1 LIST2 LESS? |
| 3082 | Merges two lists, re-using the pairs of LIST1 and LIST2 to build |
| 3083 | the result. If the code is compiled, and LESS? constructs no new |
| 3084 | pairs, no pairs at all will be allocated. The first pair of the |
| 3085 | result will be either the first pair of LIST1 or the first pair of |
| 3086 | LIST2. |
| 3087 | |
| 3088 | *** New function: sort SEQUENCE LESS? |
| 3089 | Accepts either a list or a vector, and returns a new sequence |
| 3090 | which is sorted. The new sequence is the same type as the input. |
| 3091 | Always `(sorted? (sort sequence less?) less?)'. The original |
| 3092 | sequence is not altered in any way. The new sequence shares its |
| 3093 | elements with the old one; no elements are copied. |
| 3094 | |
| 3095 | *** New procedure: sort! SEQUENCE LESS |
| 3096 | Returns its sorted result in the original boxes. No new storage is |
| 3097 | allocated at all. Proper usage: (set! slist (sort! slist <)) |
| 3098 | |
| 3099 | *** New function: stable-sort SEQUENCE LESS? |
| 3100 | Similar to `sort' but stable. That is, if "equal" elements are |
| 3101 | ordered a < b in the original sequence, they will have the same order |
| 3102 | in the result. |
| 3103 | |
| 3104 | *** New function: stable-sort! SEQUENCE LESS? |
| 3105 | Similar to `sort!' but stable. |
| 3106 | Uses temporary storage when sorting vectors. |
| 3107 | |
| 3108 | *** New functions: sort-list, sort-list! |
| 3109 | Added for compatibility with scsh. |
| 3110 | |
| 3111 | ** New built-in random number support |
| 3112 | |
| 3113 | *** New function: random N [STATE] |
| 3114 | Accepts a positive integer or real N and returns a number of the |
| 3115 | same type between zero (inclusive) and N (exclusive). The values |
| 3116 | returned have a uniform distribution. |
| 3117 | |
| 3118 | The optional argument STATE must be of the type produced by |
| 3119 | `copy-random-state' or `seed->random-state'. It defaults to the value |
| 3120 | of the variable `*random-state*'. This object is used to maintain the |
| 3121 | state of the pseudo-random-number generator and is altered as a side |
| 3122 | effect of the `random' operation. |
| 3123 | |
| 3124 | *** New variable: *random-state* |
| 3125 | Holds a data structure that encodes the internal state of the |
| 3126 | random-number generator that `random' uses by default. The nature |
| 3127 | of this data structure is implementation-dependent. It may be |
| 3128 | printed out and successfully read back in, but may or may not |
| 3129 | function correctly as a random-number state object in another |
| 3130 | implementation. |
| 3131 | |
| 3132 | *** New function: copy-random-state [STATE] |
| 3133 | Returns a new object of type suitable for use as the value of the |
| 3134 | variable `*random-state*' and as a second argument to `random'. |
| 3135 | If argument STATE is given, a copy of it is returned. Otherwise a |
| 3136 | copy of `*random-state*' is returned. |
| 3137 | |
| 3138 | *** New function: seed->random-state SEED |
| 3139 | Returns a new object of type suitable for use as the value of the |
| 3140 | variable `*random-state*' and as a second argument to `random'. |
| 3141 | SEED is a string or a number. A new state is generated and |
| 3142 | initialized using SEED. |
| 3143 | |
| 3144 | *** New function: random:uniform [STATE] |
| 3145 | Returns an uniformly distributed inexact real random number in the |
| 3146 | range between 0 and 1. |
| 3147 | |
| 3148 | *** New procedure: random:solid-sphere! VECT [STATE] |
| 3149 | Fills VECT with inexact real random numbers the sum of whose |
| 3150 | squares is less than 1.0. Thinking of VECT as coordinates in |
| 3151 | space of dimension N = `(vector-length VECT)', the coordinates are |
| 3152 | uniformly distributed within the unit N-shere. The sum of the |
| 3153 | squares of the numbers is returned. VECT can be either a vector |
| 3154 | or a uniform vector of doubles. |
| 3155 | |
| 3156 | *** New procedure: random:hollow-sphere! VECT [STATE] |
| 3157 | Fills VECT with inexact real random numbers the sum of whose squares |
| 3158 | is equal to 1.0. Thinking of VECT as coordinates in space of |
| 3159 | dimension n = `(vector-length VECT)', the coordinates are uniformly |
| 3160 | distributed over the surface of the unit n-shere. VECT can be either |
| 3161 | a vector or a uniform vector of doubles. |
| 3162 | |
| 3163 | *** New function: random:normal [STATE] |
| 3164 | Returns an inexact real in a normal distribution with mean 0 and |
| 3165 | standard deviation 1. For a normal distribution with mean M and |
| 3166 | standard deviation D use `(+ M (* D (random:normal)))'. |
| 3167 | |
| 3168 | *** New procedure: random:normal-vector! VECT [STATE] |
| 3169 | Fills VECT with inexact real random numbers which are independent and |
| 3170 | standard normally distributed (i.e., with mean 0 and variance 1). |
| 3171 | VECT can be either a vector or a uniform vector of doubles. |
| 3172 | |
| 3173 | *** New function: random:exp STATE |
| 3174 | Returns an inexact real in an exponential distribution with mean 1. |
| 3175 | For an exponential distribution with mean U use (* U (random:exp)). |
| 3176 | |
| 3177 | ** The range of logand, logior, logxor, logtest, and logbit? have changed. |
| 3178 | |
| 3179 | These functions now operate on numbers in the range of a C unsigned |
| 3180 | long. |
| 3181 | |
| 3182 | These functions used to operate on numbers in the range of a C signed |
| 3183 | long; however, this seems inappropriate, because Guile integers don't |
| 3184 | overflow. |
| 3185 | |
| 3186 | ** New function: make-guardian |
| 3187 | This is an implementation of guardians as described in |
| 3188 | R. Kent Dybvig, Carl Bruggeman, and David Eby (1993) "Guardians in a |
| 3189 | Generation-Based Garbage Collector" ACM SIGPLAN Conference on |
| 3190 | Programming Language Design and Implementation, June 1993 |
| 3191 | ftp://ftp.cs.indiana.edu/pub/scheme-repository/doc/pubs/guardians.ps.gz |
| 3192 | |
| 3193 | ** New functions: delq1!, delv1!, delete1! |
| 3194 | These procedures behave similar to delq! and friends but delete only |
| 3195 | one object if at all. |
| 3196 | |
| 3197 | ** New function: unread-string STRING PORT |
| 3198 | Unread STRING to PORT, that is, push it back onto the port so that |
| 3199 | next read operation will work on the pushed back characters. |
| 3200 | |
| 3201 | ** unread-char can now be called multiple times |
| 3202 | If unread-char is called multiple times, the unread characters will be |
| 3203 | read again in last-in first-out order. |
| 3204 | |
| 3205 | ** the procedures uniform-array-read! and uniform-array-write! now |
| 3206 | work on any kind of port, not just ports which are open on a file. |
| 3207 | |
| 3208 | ** Now 'l' in a port mode requests line buffering. |
| 3209 | |
| 3210 | ** The procedure truncate-file now works on string ports as well |
| 3211 | as file ports. If the size argument is omitted, the current |
| 3212 | file position is used. |
| 3213 | |
| 3214 | ** new procedure: seek PORT/FDES OFFSET WHENCE |
| 3215 | The arguments are the same as for the old fseek procedure, but it |
| 3216 | works on string ports as well as random-access file ports. |
| 3217 | |
| 3218 | ** the fseek procedure now works on string ports, since it has been |
| 3219 | redefined using seek. |
| 3220 | |
| 3221 | ** the setvbuf procedure now uses a default size if mode is _IOFBF and |
| 3222 | size is not supplied. |
| 3223 | |
| 3224 | ** the newline procedure no longer flushes the port if it's not |
| 3225 | line-buffered: previously it did if it was the current output port. |
| 3226 | |
| 3227 | ** open-pipe and close-pipe are no longer primitive procedures, but |
| 3228 | an emulation can be obtained using `(use-modules (ice-9 popen))'. |
| 3229 | |
| 3230 | ** the freopen procedure has been removed. |
| 3231 | |
| 3232 | ** new procedure: drain-input PORT |
| 3233 | Drains PORT's read buffers (including any pushed-back characters) |
| 3234 | and returns the contents as a single string. |
| 3235 | |
| 3236 | ** New function: map-in-order PROC LIST1 LIST2 ... |
| 3237 | Version of `map' which guarantees that the procedure is applied to the |
| 3238 | lists in serial order. |
| 3239 | |
| 3240 | ** Renamed `serial-array-copy!' and `serial-array-map!' to |
| 3241 | `array-copy-in-order!' and `array-map-in-order!'. The old names are |
| 3242 | now obsolete and will go away in release 1.5. |
| 3243 | |
| 3244 | ** New syntax: collect BODY1 ... |
| 3245 | Version of `begin' which returns a list of the results of the body |
| 3246 | forms instead of the result of the last body form. In contrast to |
| 3247 | `begin', `collect' allows an empty body. |
| 3248 | |
| 3249 | ** New functions: read-history FILENAME, write-history FILENAME |
| 3250 | Read/write command line history from/to file. Returns #t on success |
| 3251 | and #f if an error occured. |
| 3252 | |
| 3253 | ** `ls' and `lls' in module (ice-9 ls) now handle no arguments. |
| 3254 | |
| 3255 | These procedures return a list of definitions available in the specified |
| 3256 | argument, a relative module reference. In the case of no argument, |
| 3257 | `(current-module)' is now consulted for definitions to return, instead |
| 3258 | of simply returning #f, the former behavior. |
| 3259 | |
| 3260 | ** The #/ syntax for lists is no longer supported. |
| 3261 | |
| 3262 | Earlier versions of Scheme accepted this syntax, but printed a |
| 3263 | warning. |
| 3264 | |
| 3265 | ** Guile no longer consults the SCHEME_LOAD_PATH environment variable. |
| 3266 | |
| 3267 | Instead, you should set GUILE_LOAD_PATH to tell Guile where to find |
| 3268 | modules. |
| 3269 | |
| 3270 | * Changes to the gh_ interface |
| 3271 | |
| 3272 | ** gh_scm2doubles |
| 3273 | |
| 3274 | Now takes a second argument which is the result array. If this |
| 3275 | pointer is NULL, a new array is malloced (the old behaviour). |
| 3276 | |
| 3277 | ** gh_chars2byvect, gh_shorts2svect, gh_floats2fvect, gh_scm2chars, |
| 3278 | gh_scm2shorts, gh_scm2longs, gh_scm2floats |
| 3279 | |
| 3280 | New functions. |
| 3281 | |
| 3282 | * Changes to the scm_ interface |
| 3283 | |
| 3284 | ** Function: scm_make_named_hook (char* name, int n_args) |
| 3285 | |
| 3286 | Creates a hook in the same way as make-hook above but also |
| 3287 | binds a variable named NAME to it. |
| 3288 | |
| 3289 | This is the typical way of creating a hook from C code. |
| 3290 | |
| 3291 | Currently, the variable is created in the "current" module. This |
| 3292 | might change when we get the new module system. |
| 3293 | |
| 3294 | ** The smob interface |
| 3295 | |
| 3296 | The interface for creating smobs has changed. For documentation, see |
| 3297 | data-rep.info (made from guile-core/doc/data-rep.texi). |
| 3298 | |
| 3299 | *** Deprecated function: SCM scm_newsmob (scm_smobfuns *) |
| 3300 | |
| 3301 | >>> This function will be removed in 1.3.4. <<< |
| 3302 | |
| 3303 | It is replaced by: |
| 3304 | |
| 3305 | *** Function: SCM scm_make_smob_type (const char *name, scm_sizet size) |
| 3306 | This function adds a new smob type, named NAME, with instance size |
| 3307 | SIZE to the system. The return value is a tag that is used in |
| 3308 | creating instances of the type. If SIZE is 0, then no memory will |
| 3309 | be allocated when instances of the smob are created, and nothing |
| 3310 | will be freed by the default free function. |
| 3311 | |
| 3312 | *** Function: void scm_set_smob_mark (long tc, SCM (*mark) (SCM)) |
| 3313 | This function sets the smob marking procedure for the smob type |
| 3314 | specified by the tag TC. TC is the tag returned by |
| 3315 | `scm_make_smob_type'. |
| 3316 | |
| 3317 | *** Function: void scm_set_smob_free (long tc, SCM (*mark) (SCM)) |
| 3318 | This function sets the smob freeing procedure for the smob type |
| 3319 | specified by the tag TC. TC is the tag returned by |
| 3320 | `scm_make_smob_type'. |
| 3321 | |
| 3322 | *** Function: void scm_set_smob_print (tc, print) |
| 3323 | |
| 3324 | - Function: void scm_set_smob_print (long tc, |
| 3325 | scm_sizet (*print) (SCM, |
| 3326 | SCM, |
| 3327 | scm_print_state *)) |
| 3328 | |
| 3329 | This function sets the smob printing procedure for the smob type |
| 3330 | specified by the tag TC. TC is the tag returned by |
| 3331 | `scm_make_smob_type'. |
| 3332 | |
| 3333 | *** Function: void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM)) |
| 3334 | This function sets the smob equality-testing predicate for the |
| 3335 | smob type specified by the tag TC. TC is the tag returned by |
| 3336 | `scm_make_smob_type'. |
| 3337 | |
| 3338 | *** Macro: void SCM_NEWSMOB (SCM var, long tc, void *data) |
| 3339 | Make VALUE contain a smob instance of the type with type code TC and |
| 3340 | smob data DATA. VALUE must be previously declared as C type `SCM'. |
| 3341 | |
| 3342 | *** Macro: fn_returns SCM_RETURN_NEWSMOB (long tc, void *data) |
| 3343 | This macro expands to a block of code that creates a smob instance |
| 3344 | of the type with type code TC and smob data DATA, and returns that |
| 3345 | `SCM' value. It should be the last piece of code in a block. |
| 3346 | |
| 3347 | ** The interfaces for using I/O ports and implementing port types |
| 3348 | (ptobs) have changed significantly. The new interface is based on |
| 3349 | shared access to buffers and a new set of ptob procedures. |
| 3350 | |
| 3351 | *** scm_newptob has been removed |
| 3352 | |
| 3353 | It is replaced by: |
| 3354 | |
| 3355 | *** Function: SCM scm_make_port_type (type_name, fill_buffer, write_flush) |
| 3356 | |
| 3357 | - Function: SCM scm_make_port_type (char *type_name, |
| 3358 | int (*fill_buffer) (SCM port), |
| 3359 | void (*write_flush) (SCM port)); |
| 3360 | |
| 3361 | Similarly to the new smob interface, there is a set of function |
| 3362 | setters by which the user can customize the behaviour of his port |
| 3363 | type. See ports.h (scm_set_port_XXX). |
| 3364 | |
| 3365 | ** scm_strport_to_string: New function: creates a new string from |
| 3366 | a string port's buffer. |
| 3367 | |
| 3368 | ** Plug in interface for random number generators |
| 3369 | The variable `scm_the_rng' in random.c contains a value and three |
| 3370 | function pointers which together define the current random number |
| 3371 | generator being used by the Scheme level interface and the random |
| 3372 | number library functions. |
| 3373 | |
| 3374 | The user is free to replace the default generator with the generator |
| 3375 | of his own choice. |
| 3376 | |
| 3377 | *** Variable: size_t scm_the_rng.rstate_size |
| 3378 | The size of the random state type used by the current RNG |
| 3379 | measured in chars. |
| 3380 | |
| 3381 | *** Function: unsigned long scm_the_rng.random_bits (scm_rstate *STATE) |
| 3382 | Given the random STATE, return 32 random bits. |
| 3383 | |
| 3384 | *** Function: void scm_the_rng.init_rstate (scm_rstate *STATE, chars *S, int N) |
| 3385 | Seed random state STATE using string S of length N. |
| 3386 | |
| 3387 | *** Function: scm_rstate *scm_the_rng.copy_rstate (scm_rstate *STATE) |
| 3388 | Given random state STATE, return a malloced copy. |
| 3389 | |
| 3390 | ** Default RNG |
| 3391 | The default RNG is the MWC (Multiply With Carry) random number |
| 3392 | generator described by George Marsaglia at the Department of |
| 3393 | Statistics and Supercomputer Computations Research Institute, The |
| 3394 | Florida State University (http://stat.fsu.edu/~geo). |
| 3395 | |
| 3396 | It uses 64 bits, has a period of 4578426017172946943 (4.6e18), and |
| 3397 | passes all tests in the DIEHARD test suite |
| 3398 | (http://stat.fsu.edu/~geo/diehard.html). The generation of 32 bits |
| 3399 | costs one multiply and one add on platforms which either supports long |
| 3400 | longs (gcc does this on most systems) or have 64 bit longs. The cost |
| 3401 | is four multiply on other systems but this can be optimized by writing |
| 3402 | scm_i_uniform32 in assembler. |
| 3403 | |
| 3404 | These functions are provided through the scm_the_rng interface for use |
| 3405 | by libguile and the application. |
| 3406 | |
| 3407 | *** Function: unsigned long scm_i_uniform32 (scm_i_rstate *STATE) |
| 3408 | Given the random STATE, return 32 random bits. |
| 3409 | Don't use this function directly. Instead go through the plugin |
| 3410 | interface (see "Plug in interface" above). |
| 3411 | |
| 3412 | *** Function: void scm_i_init_rstate (scm_i_rstate *STATE, char *SEED, int N) |
| 3413 | Initialize STATE using SEED of length N. |
| 3414 | |
| 3415 | *** Function: scm_i_rstate *scm_i_copy_rstate (scm_i_rstate *STATE) |
| 3416 | Return a malloc:ed copy of STATE. This function can easily be re-used |
| 3417 | in the interfaces to other RNGs. |
| 3418 | |
| 3419 | ** Random number library functions |
| 3420 | These functions use the current RNG through the scm_the_rng interface. |
| 3421 | It might be a good idea to use these functions from your C code so |
| 3422 | that only one random generator is used by all code in your program. |
| 3423 | |
| 3424 | The default random state is stored in: |
| 3425 | |
| 3426 | *** Variable: SCM scm_var_random_state |
| 3427 | Contains the vcell of the Scheme variable "*random-state*" which is |
| 3428 | used as default state by all random number functions in the Scheme |
| 3429 | level interface. |
| 3430 | |
| 3431 | Example: |
| 3432 | |
| 3433 | double x = scm_c_uniform01 (SCM_RSTATE (SCM_CDR (scm_var_random_state))); |
| 3434 | |
| 3435 | *** Function: scm_rstate *scm_c_default_rstate (void) |
| 3436 | This is a convenience function which returns the value of |
| 3437 | scm_var_random_state. An error message is generated if this value |
| 3438 | isn't a random state. |
| 3439 | |
| 3440 | *** Function: scm_rstate *scm_c_make_rstate (char *SEED, int LENGTH) |
| 3441 | Make a new random state from the string SEED of length LENGTH. |
| 3442 | |
| 3443 | It is generally not a good idea to use multiple random states in a |
| 3444 | program. While subsequent random numbers generated from one random |
| 3445 | state are guaranteed to be reasonably independent, there is no such |
| 3446 | guarantee for numbers generated from different random states. |
| 3447 | |
| 3448 | *** Macro: unsigned long scm_c_uniform32 (scm_rstate *STATE) |
| 3449 | Return 32 random bits. |
| 3450 | |
| 3451 | *** Function: double scm_c_uniform01 (scm_rstate *STATE) |
| 3452 | Return a sample from the uniform(0,1) distribution. |
| 3453 | |
| 3454 | *** Function: double scm_c_normal01 (scm_rstate *STATE) |
| 3455 | Return a sample from the normal(0,1) distribution. |
| 3456 | |
| 3457 | *** Function: double scm_c_exp1 (scm_rstate *STATE) |
| 3458 | Return a sample from the exp(1) distribution. |
| 3459 | |
| 3460 | *** Function: unsigned long scm_c_random (scm_rstate *STATE, unsigned long M) |
| 3461 | Return a sample from the discrete uniform(0,M) distribution. |
| 3462 | |
| 3463 | *** Function: SCM scm_c_random_bignum (scm_rstate *STATE, SCM M) |
| 3464 | Return a sample from the discrete uniform(0,M) distribution. |
| 3465 | M must be a bignum object. The returned value may be an INUM. |
| 3466 | |
| 3467 | |
| 3468 | \f |
| 3469 | Changes in Guile 1.3 (released Monday, October 19, 1998): |
| 3470 | |
| 3471 | * Changes to the distribution |
| 3472 | |
| 3473 | ** We renamed the SCHEME_LOAD_PATH environment variable to GUILE_LOAD_PATH. |
| 3474 | To avoid conflicts, programs should name environment variables after |
| 3475 | themselves, except when there's a common practice establishing some |
| 3476 | other convention. |
| 3477 | |
| 3478 | For now, Guile supports both GUILE_LOAD_PATH and SCHEME_LOAD_PATH, |
| 3479 | giving the former precedence, and printing a warning message if the |
| 3480 | latter is set. Guile 1.4 will not recognize SCHEME_LOAD_PATH at all. |
| 3481 | |
| 3482 | ** The header files related to multi-byte characters have been removed. |
| 3483 | They were: libguile/extchrs.h and libguile/mbstrings.h. Any C code |
| 3484 | which referred to these explicitly will probably need to be rewritten, |
| 3485 | since the support for the variant string types has been removed; see |
| 3486 | below. |
| 3487 | |
| 3488 | ** The header files append.h and sequences.h have been removed. These |
| 3489 | files implemented non-R4RS operations which would encourage |
| 3490 | non-portable programming style and less easy-to-read code. |
| 3491 | |
| 3492 | * Changes to the stand-alone interpreter |
| 3493 | |
| 3494 | ** New procedures have been added to implement a "batch mode": |
| 3495 | |
| 3496 | *** Function: batch-mode? |
| 3497 | |
| 3498 | Returns a boolean indicating whether the interpreter is in batch |
| 3499 | mode. |
| 3500 | |
| 3501 | *** Function: set-batch-mode?! ARG |
| 3502 | |
| 3503 | If ARG is true, switches the interpreter to batch mode. The `#f' |
| 3504 | case has not been implemented. |
| 3505 | |
| 3506 | ** Guile now provides full command-line editing, when run interactively. |
| 3507 | To use this feature, you must have the readline library installed. |
| 3508 | The Guile build process will notice it, and automatically include |
| 3509 | support for it. |
| 3510 | |
| 3511 | The readline library is available via anonymous FTP from any GNU |
| 3512 | mirror site; the canonical location is "ftp://prep.ai.mit.edu/pub/gnu". |
| 3513 | |
| 3514 | ** the-last-stack is now a fluid. |
| 3515 | |
| 3516 | * Changes to the procedure for linking libguile with your programs |
| 3517 | |
| 3518 | ** You can now use the `guile-config' utility to build programs that use Guile. |
| 3519 | |
| 3520 | Guile now includes a command-line utility called `guile-config', which |
| 3521 | can provide information about how to compile and link programs that |
| 3522 | use Guile. |
| 3523 | |
| 3524 | *** `guile-config compile' prints any C compiler flags needed to use Guile. |
| 3525 | You should include this command's output on the command line you use |
| 3526 | to compile C or C++ code that #includes the Guile header files. It's |
| 3527 | usually just a `-I' flag to help the compiler find the Guile headers. |
| 3528 | |
| 3529 | |
| 3530 | *** `guile-config link' prints any linker flags necessary to link with Guile. |
| 3531 | |
| 3532 | This command writes to its standard output a list of flags which you |
| 3533 | must pass to the linker to link your code against the Guile library. |
| 3534 | The flags include '-lguile' itself, any other libraries the Guile |
| 3535 | library depends upon, and any `-L' flags needed to help the linker |
| 3536 | find those libraries. |
| 3537 | |
| 3538 | For example, here is a Makefile rule that builds a program named 'foo' |
| 3539 | from the object files ${FOO_OBJECTS}, and links them against Guile: |
| 3540 | |
| 3541 | foo: ${FOO_OBJECTS} |
| 3542 | ${CC} ${CFLAGS} ${FOO_OBJECTS} `guile-config link` -o foo |
| 3543 | |
| 3544 | Previous Guile releases recommended that you use autoconf to detect |
| 3545 | which of a predefined set of libraries were present on your system. |
| 3546 | It is more robust to use `guile-config', since it records exactly which |
| 3547 | libraries the installed Guile library requires. |
| 3548 | |
| 3549 | This was originally called `build-guile', but was renamed to |
| 3550 | `guile-config' before Guile 1.3 was released, to be consistent with |
| 3551 | the analogous script for the GTK+ GUI toolkit, which is called |
| 3552 | `gtk-config'. |
| 3553 | |
| 3554 | |
| 3555 | ** Use the GUILE_FLAGS macro in your configure.in file to find Guile. |
| 3556 | |
| 3557 | If you are using the GNU autoconf package to configure your program, |
| 3558 | you can use the GUILE_FLAGS autoconf macro to call `guile-config' |
| 3559 | (described above) and gather the necessary values for use in your |
| 3560 | Makefiles. |
| 3561 | |
| 3562 | The GUILE_FLAGS macro expands to configure script code which runs the |
| 3563 | `guile-config' script, to find out where Guile's header files and |
| 3564 | libraries are installed. It sets two variables, marked for |
| 3565 | substitution, as by AC_SUBST. |
| 3566 | |
| 3567 | GUILE_CFLAGS --- flags to pass to a C or C++ compiler to build |
| 3568 | code that uses Guile header files. This is almost always just a |
| 3569 | -I flag. |
| 3570 | |
| 3571 | GUILE_LDFLAGS --- flags to pass to the linker to link a |
| 3572 | program against Guile. This includes `-lguile' for the Guile |
| 3573 | library itself, any libraries that Guile itself requires (like |
| 3574 | -lqthreads), and so on. It may also include a -L flag to tell the |
| 3575 | compiler where to find the libraries. |
| 3576 | |
| 3577 | GUILE_FLAGS is defined in the file guile.m4, in the top-level |
| 3578 | directory of the Guile distribution. You can copy it into your |
| 3579 | package's aclocal.m4 file, and then use it in your configure.in file. |
| 3580 | |
| 3581 | If you are using the `aclocal' program, distributed with GNU automake, |
| 3582 | to maintain your aclocal.m4 file, the Guile installation process |
| 3583 | installs guile.m4 where aclocal will find it. All you need to do is |
| 3584 | use GUILE_FLAGS in your configure.in file, and then run `aclocal'; |
| 3585 | this will copy the definition of GUILE_FLAGS into your aclocal.m4 |
| 3586 | file. |
| 3587 | |
| 3588 | |
| 3589 | * Changes to Scheme functions and syntax |
| 3590 | |
| 3591 | ** Multi-byte strings have been removed, as have multi-byte and wide |
| 3592 | ports. We felt that these were the wrong approach to |
| 3593 | internationalization support. |
| 3594 | |
| 3595 | ** New function: readline [PROMPT] |
| 3596 | Read a line from the terminal, and allow the user to edit it, |
| 3597 | prompting with PROMPT. READLINE provides a large set of Emacs-like |
| 3598 | editing commands, lets the user recall previously typed lines, and |
| 3599 | works on almost every kind of terminal, including dumb terminals. |
| 3600 | |
| 3601 | READLINE assumes that the cursor is at the beginning of the line when |
| 3602 | it is invoked. Thus, you can't print a prompt yourself, and then call |
| 3603 | READLINE; you need to package up your prompt as a string, pass it to |
| 3604 | the function, and let READLINE print the prompt itself. This is |
| 3605 | because READLINE needs to know the prompt's screen width. |
| 3606 | |
| 3607 | For Guile to provide this function, you must have the readline |
| 3608 | library, version 2.1 or later, installed on your system. Readline is |
| 3609 | available via anonymous FTP from prep.ai.mit.edu in pub/gnu, or from |
| 3610 | any GNU mirror site. |
| 3611 | |
| 3612 | See also ADD-HISTORY function. |
| 3613 | |
| 3614 | ** New function: add-history STRING |
| 3615 | Add STRING as the most recent line in the history used by the READLINE |
| 3616 | command. READLINE does not add lines to the history itself; you must |
| 3617 | call ADD-HISTORY to make previous input available to the user. |
| 3618 | |
| 3619 | ** The behavior of the read-line function has changed. |
| 3620 | |
| 3621 | This function now uses standard C library functions to read the line, |
| 3622 | for speed. This means that it doesn not respect the value of |
| 3623 | scm-line-incrementors; it assumes that lines are delimited with |
| 3624 | #\newline. |
| 3625 | |
| 3626 | (Note that this is read-line, the function that reads a line of text |
| 3627 | from a port, not readline, the function that reads a line from a |
| 3628 | terminal, providing full editing capabilities.) |
| 3629 | |
| 3630 | ** New module (ice-9 getopt-gnu-style): Parse command-line arguments. |
| 3631 | |
| 3632 | This module provides some simple argument parsing. It exports one |
| 3633 | function: |
| 3634 | |
| 3635 | Function: getopt-gnu-style ARG-LS |
| 3636 | Parse a list of program arguments into an alist of option |
| 3637 | descriptions. |
| 3638 | |
| 3639 | Each item in the list of program arguments is examined to see if |
| 3640 | it meets the syntax of a GNU long-named option. An argument like |
| 3641 | `--MUMBLE' produces an element of the form (MUMBLE . #t) in the |
| 3642 | returned alist, where MUMBLE is a keyword object with the same |
| 3643 | name as the argument. An argument like `--MUMBLE=FROB' produces |
| 3644 | an element of the form (MUMBLE . FROB), where FROB is a string. |
| 3645 | |
| 3646 | As a special case, the returned alist also contains a pair whose |
| 3647 | car is the symbol `rest'. The cdr of this pair is a list |
| 3648 | containing all the items in the argument list that are not options |
| 3649 | of the form mentioned above. |
| 3650 | |
| 3651 | The argument `--' is treated specially: all items in the argument |
| 3652 | list appearing after such an argument are not examined, and are |
| 3653 | returned in the special `rest' list. |
| 3654 | |
| 3655 | This function does not parse normal single-character switches. |
| 3656 | You will need to parse them out of the `rest' list yourself. |
| 3657 | |
| 3658 | ** The read syntax for byte vectors and short vectors has changed. |
| 3659 | |
| 3660 | Instead of #bytes(...), write #y(...). |
| 3661 | |
| 3662 | Instead of #short(...), write #h(...). |
| 3663 | |
| 3664 | This may seem nutty, but, like the other uniform vectors, byte vectors |
| 3665 | and short vectors want to have the same print and read syntax (and, |
| 3666 | more basic, want to have read syntax!). Changing the read syntax to |
| 3667 | use multiple characters after the hash sign breaks with the |
| 3668 | conventions used in R5RS and the conventions used for the other |
| 3669 | uniform vectors. It also introduces complexity in the current reader, |
| 3670 | both on the C and Scheme levels. (The Right solution is probably to |
| 3671 | change the syntax and prototypes for uniform vectors entirely.) |
| 3672 | |
| 3673 | |
| 3674 | ** The new module (ice-9 session) provides useful interactive functions. |
| 3675 | |
| 3676 | *** New procedure: (apropos REGEXP OPTION ...) |
| 3677 | |
| 3678 | Display a list of top-level variables whose names match REGEXP, and |
| 3679 | the modules they are imported from. Each OPTION should be one of the |
| 3680 | following symbols: |
| 3681 | |
| 3682 | value --- Show the value of each matching variable. |
| 3683 | shadow --- Show bindings shadowed by subsequently imported modules. |
| 3684 | full --- Same as both `shadow' and `value'. |
| 3685 | |
| 3686 | For example: |
| 3687 | |
| 3688 | guile> (apropos "trace" 'full) |
| 3689 | debug: trace #<procedure trace args> |
| 3690 | debug: untrace #<procedure untrace args> |
| 3691 | the-scm-module: display-backtrace #<compiled-closure #<primitive-procedure gsubr-apply>> |
| 3692 | the-scm-module: before-backtrace-hook () |
| 3693 | the-scm-module: backtrace #<primitive-procedure backtrace> |
| 3694 | the-scm-module: after-backtrace-hook () |
| 3695 | the-scm-module: has-shown-backtrace-hint? #f |
| 3696 | guile> |
| 3697 | |
| 3698 | ** There are new functions and syntax for working with macros. |
| 3699 | |
| 3700 | Guile implements macros as a special object type. Any variable whose |
| 3701 | top-level binding is a macro object acts as a macro. The macro object |
| 3702 | specifies how the expression should be transformed before evaluation. |
| 3703 | |
| 3704 | *** Macro objects now print in a reasonable way, resembling procedures. |
| 3705 | |
| 3706 | *** New function: (macro? OBJ) |
| 3707 | True iff OBJ is a macro object. |
| 3708 | |
| 3709 | *** New function: (primitive-macro? OBJ) |
| 3710 | Like (macro? OBJ), but true only if OBJ is one of the Guile primitive |
| 3711 | macro transformers, implemented in eval.c rather than Scheme code. |
| 3712 | |
| 3713 | Why do we have this function? |
| 3714 | - For symmetry with procedure? and primitive-procedure?, |
| 3715 | - to allow custom print procedures to tell whether a macro is |
| 3716 | primitive, and display it differently, and |
| 3717 | - to allow compilers and user-written evaluators to distinguish |
| 3718 | builtin special forms from user-defined ones, which could be |
| 3719 | compiled. |
| 3720 | |
| 3721 | *** New function: (macro-type OBJ) |
| 3722 | Return a value indicating what kind of macro OBJ is. Possible return |
| 3723 | values are: |
| 3724 | |
| 3725 | The symbol `syntax' --- a macro created by procedure->syntax. |
| 3726 | The symbol `macro' --- a macro created by procedure->macro. |
| 3727 | The symbol `macro!' --- a macro created by procedure->memoizing-macro. |
| 3728 | The boolean #f --- if OBJ is not a macro object. |
| 3729 | |
| 3730 | *** New function: (macro-name MACRO) |
| 3731 | Return the name of the macro object MACRO's procedure, as returned by |
| 3732 | procedure-name. |
| 3733 | |
| 3734 | *** New function: (macro-transformer MACRO) |
| 3735 | Return the transformer procedure for MACRO. |
| 3736 | |
| 3737 | *** New syntax: (use-syntax MODULE ... TRANSFORMER) |
| 3738 | |
| 3739 | Specify a new macro expander to use in the current module. Each |
| 3740 | MODULE is a module name, with the same meaning as in the `use-modules' |
| 3741 | form; each named module's exported bindings are added to the current |
| 3742 | top-level environment. TRANSFORMER is an expression evaluated in the |
| 3743 | resulting environment which must yield a procedure to use as the |
| 3744 | module's eval transformer: every expression evaluated in this module |
| 3745 | is passed to this function, and the result passed to the Guile |
| 3746 | interpreter. |
| 3747 | |
| 3748 | *** macro-eval! is removed. Use local-eval instead. |
| 3749 | |
| 3750 | ** Some magic has been added to the printer to better handle user |
| 3751 | written printing routines (like record printers, closure printers). |
| 3752 | |
| 3753 | The problem is that these user written routines must have access to |
| 3754 | the current `print-state' to be able to handle fancy things like |
| 3755 | detection of circular references. These print-states have to be |
| 3756 | passed to the builtin printing routines (display, write, etc) to |
| 3757 | properly continue the print chain. |
| 3758 | |
| 3759 | We didn't want to change all existing print code so that it |
| 3760 | explicitly passes thru a print state in addition to a port. Instead, |
| 3761 | we extented the possible values that the builtin printing routines |
| 3762 | accept as a `port'. In addition to a normal port, they now also take |
| 3763 | a pair of a normal port and a print-state. Printing will go to the |
| 3764 | port and the print-state will be used to control the detection of |
| 3765 | circular references, etc. If the builtin function does not care for a |
| 3766 | print-state, it is simply ignored. |
| 3767 | |
| 3768 | User written callbacks are now called with such a pair as their |
| 3769 | `port', but because every function now accepts this pair as a PORT |
| 3770 | argument, you don't have to worry about that. In fact, it is probably |
| 3771 | safest to not check for these pairs. |
| 3772 | |
| 3773 | However, it is sometimes necessary to continue a print chain on a |
| 3774 | different port, for example to get a intermediate string |
| 3775 | representation of the printed value, mangle that string somehow, and |
| 3776 | then to finally print the mangled string. Use the new function |
| 3777 | |
| 3778 | inherit-print-state OLD-PORT NEW-PORT |
| 3779 | |
| 3780 | for this. It constructs a new `port' that prints to NEW-PORT but |
| 3781 | inherits the print-state of OLD-PORT. |
| 3782 | |
| 3783 | ** struct-vtable-offset renamed to vtable-offset-user |
| 3784 | |
| 3785 | ** New constants: vtable-index-layout, vtable-index-vtable, vtable-index-printer |
| 3786 | |
| 3787 | ** There is now a third optional argument to make-vtable-vtable |
| 3788 | (and fourth to make-struct) when constructing new types (vtables). |
| 3789 | This argument initializes field vtable-index-printer of the vtable. |
| 3790 | |
| 3791 | ** The detection of circular references has been extended to structs. |
| 3792 | That is, a structure that -- in the process of being printed -- prints |
| 3793 | itself does not lead to infinite recursion. |
| 3794 | |
| 3795 | ** There is now some basic support for fluids. Please read |
| 3796 | "libguile/fluid.h" to find out more. It is accessible from Scheme with |
| 3797 | the following functions and macros: |
| 3798 | |
| 3799 | Function: make-fluid |
| 3800 | |
| 3801 | Create a new fluid object. Fluids are not special variables or |
| 3802 | some other extension to the semantics of Scheme, but rather |
| 3803 | ordinary Scheme objects. You can store them into variables (that |
| 3804 | are still lexically scoped, of course) or into any other place you |
| 3805 | like. Every fluid has a initial value of `#f'. |
| 3806 | |
| 3807 | Function: fluid? OBJ |
| 3808 | |
| 3809 | Test whether OBJ is a fluid. |
| 3810 | |
| 3811 | Function: fluid-ref FLUID |
| 3812 | Function: fluid-set! FLUID VAL |
| 3813 | |
| 3814 | Access/modify the fluid FLUID. Modifications are only visible |
| 3815 | within the current dynamic root (that includes threads). |
| 3816 | |
| 3817 | Function: with-fluids* FLUIDS VALUES THUNK |
| 3818 | |
| 3819 | FLUIDS is a list of fluids and VALUES a corresponding list of |
| 3820 | values for these fluids. Before THUNK gets called the values are |
| 3821 | installed in the fluids and the old values of the fluids are |
| 3822 | saved in the VALUES list. When the flow of control leaves THUNK |
| 3823 | or reenters it, the values get swapped again. You might think of |
| 3824 | this as a `safe-fluid-excursion'. Note that the VALUES list is |
| 3825 | modified by `with-fluids*'. |
| 3826 | |
| 3827 | Macro: with-fluids ((FLUID VALUE) ...) FORM ... |
| 3828 | |
| 3829 | The same as `with-fluids*' but with a different syntax. It looks |
| 3830 | just like `let', but both FLUID and VALUE are evaluated. Remember, |
| 3831 | fluids are not special variables but ordinary objects. FLUID |
| 3832 | should evaluate to a fluid. |
| 3833 | |
| 3834 | ** Changes to system call interfaces: |
| 3835 | |
| 3836 | *** close-port, close-input-port and close-output-port now return a |
| 3837 | boolean instead of an `unspecified' object. #t means that the port |
| 3838 | was successfully closed, while #f means it was already closed. It is |
| 3839 | also now possible for these procedures to raise an exception if an |
| 3840 | error occurs (some errors from write can be delayed until close.) |
| 3841 | |
| 3842 | *** the first argument to chmod, fcntl, ftell and fseek can now be a |
| 3843 | file descriptor. |
| 3844 | |
| 3845 | *** the third argument to fcntl is now optional. |
| 3846 | |
| 3847 | *** the first argument to chown can now be a file descriptor or a port. |
| 3848 | |
| 3849 | *** the argument to stat can now be a port. |
| 3850 | |
| 3851 | *** The following new procedures have been added (most use scsh |
| 3852 | interfaces): |
| 3853 | |
| 3854 | *** procedure: close PORT/FD |
| 3855 | Similar to close-port (*note close-port: Closing Ports.), but also |
| 3856 | works on file descriptors. A side effect of closing a file |
| 3857 | descriptor is that any ports using that file descriptor are moved |
| 3858 | to a different file descriptor and have their revealed counts set |
| 3859 | to zero. |
| 3860 | |
| 3861 | *** procedure: port->fdes PORT |
| 3862 | Returns the integer file descriptor underlying PORT. As a side |
| 3863 | effect the revealed count of PORT is incremented. |
| 3864 | |
| 3865 | *** procedure: fdes->ports FDES |
| 3866 | Returns a list of existing ports which have FDES as an underlying |
| 3867 | file descriptor, without changing their revealed counts. |
| 3868 | |
| 3869 | *** procedure: fdes->inport FDES |
| 3870 | Returns an existing input port which has FDES as its underlying |
| 3871 | file descriptor, if one exists, and increments its revealed count. |
| 3872 | Otherwise, returns a new input port with a revealed count of 1. |
| 3873 | |
| 3874 | *** procedure: fdes->outport FDES |
| 3875 | Returns an existing output port which has FDES as its underlying |
| 3876 | file descriptor, if one exists, and increments its revealed count. |
| 3877 | Otherwise, returns a new output port with a revealed count of 1. |
| 3878 | |
| 3879 | The next group of procedures perform a `dup2' system call, if NEWFD |
| 3880 | (an integer) is supplied, otherwise a `dup'. The file descriptor to be |
| 3881 | duplicated can be supplied as an integer or contained in a port. The |
| 3882 | type of value returned varies depending on which procedure is used. |
| 3883 | |
| 3884 | All procedures also have the side effect when performing `dup2' that |
| 3885 | any ports using NEWFD are moved to a different file descriptor and have |
| 3886 | their revealed counts set to zero. |
| 3887 | |
| 3888 | *** procedure: dup->fdes PORT/FD [NEWFD] |
| 3889 | Returns an integer file descriptor. |
| 3890 | |
| 3891 | *** procedure: dup->inport PORT/FD [NEWFD] |
| 3892 | Returns a new input port using the new file descriptor. |
| 3893 | |
| 3894 | *** procedure: dup->outport PORT/FD [NEWFD] |
| 3895 | Returns a new output port using the new file descriptor. |
| 3896 | |
| 3897 | *** procedure: dup PORT/FD [NEWFD] |
| 3898 | Returns a new port if PORT/FD is a port, with the same mode as the |
| 3899 | supplied port, otherwise returns an integer file descriptor. |
| 3900 | |
| 3901 | *** procedure: dup->port PORT/FD MODE [NEWFD] |
| 3902 | Returns a new port using the new file descriptor. MODE supplies a |
| 3903 | mode string for the port (*note open-file: File Ports.). |
| 3904 | |
| 3905 | *** procedure: setenv NAME VALUE |
| 3906 | Modifies the environment of the current process, which is also the |
| 3907 | default environment inherited by child processes. |
| 3908 | |
| 3909 | If VALUE is `#f', then NAME is removed from the environment. |
| 3910 | Otherwise, the string NAME=VALUE is added to the environment, |
| 3911 | replacing any existing string with name matching NAME. |
| 3912 | |
| 3913 | The return value is unspecified. |
| 3914 | |
| 3915 | *** procedure: truncate-file OBJ SIZE |
| 3916 | Truncates the file referred to by OBJ to at most SIZE bytes. OBJ |
| 3917 | can be a string containing a file name or an integer file |
| 3918 | descriptor or port open for output on the file. The underlying |
| 3919 | system calls are `truncate' and `ftruncate'. |
| 3920 | |
| 3921 | The return value is unspecified. |
| 3922 | |
| 3923 | *** procedure: setvbuf PORT MODE [SIZE] |
| 3924 | Set the buffering mode for PORT. MODE can be: |
| 3925 | `_IONBF' |
| 3926 | non-buffered |
| 3927 | |
| 3928 | `_IOLBF' |
| 3929 | line buffered |
| 3930 | |
| 3931 | `_IOFBF' |
| 3932 | block buffered, using a newly allocated buffer of SIZE bytes. |
| 3933 | However if SIZE is zero or unspecified, the port will be made |
| 3934 | non-buffered. |
| 3935 | |
| 3936 | This procedure should not be used after I/O has been performed with |
| 3937 | the port. |
| 3938 | |
| 3939 | Ports are usually block buffered by default, with a default buffer |
| 3940 | size. Procedures e.g., *Note open-file: File Ports, which accept a |
| 3941 | mode string allow `0' to be added to request an unbuffered port. |
| 3942 | |
| 3943 | *** procedure: fsync PORT/FD |
| 3944 | Copies any unwritten data for the specified output file descriptor |
| 3945 | to disk. If PORT/FD is a port, its buffer is flushed before the |
| 3946 | underlying file descriptor is fsync'd. The return value is |
| 3947 | unspecified. |
| 3948 | |
| 3949 | *** procedure: open-fdes PATH FLAGS [MODES] |
| 3950 | Similar to `open' but returns a file descriptor instead of a port. |
| 3951 | |
| 3952 | *** procedure: execle PATH ENV [ARG] ... |
| 3953 | Similar to `execl', but the environment of the new process is |
| 3954 | specified by ENV, which must be a list of strings as returned by |
| 3955 | the `environ' procedure. |
| 3956 | |
| 3957 | This procedure is currently implemented using the `execve' system |
| 3958 | call, but we call it `execle' because of its Scheme calling |
| 3959 | interface. |
| 3960 | |
| 3961 | *** procedure: strerror ERRNO |
| 3962 | Returns the Unix error message corresponding to ERRNO, an integer. |
| 3963 | |
| 3964 | *** procedure: primitive-exit [STATUS] |
| 3965 | Terminate the current process without unwinding the Scheme stack. |
| 3966 | This is would typically be useful after a fork. The exit status |
| 3967 | is STATUS if supplied, otherwise zero. |
| 3968 | |
| 3969 | *** procedure: times |
| 3970 | Returns an object with information about real and processor time. |
| 3971 | The following procedures accept such an object as an argument and |
| 3972 | return a selected component: |
| 3973 | |
| 3974 | `tms:clock' |
| 3975 | The current real time, expressed as time units relative to an |
| 3976 | arbitrary base. |
| 3977 | |
| 3978 | `tms:utime' |
| 3979 | The CPU time units used by the calling process. |
| 3980 | |
| 3981 | `tms:stime' |
| 3982 | The CPU time units used by the system on behalf of the |
| 3983 | calling process. |
| 3984 | |
| 3985 | `tms:cutime' |
| 3986 | The CPU time units used by terminated child processes of the |
| 3987 | calling process, whose status has been collected (e.g., using |
| 3988 | `waitpid'). |
| 3989 | |
| 3990 | `tms:cstime' |
| 3991 | Similarly, the CPU times units used by the system on behalf of |
| 3992 | terminated child processes. |
| 3993 | |
| 3994 | ** Removed: list-length |
| 3995 | ** Removed: list-append, list-append! |
| 3996 | ** Removed: list-reverse, list-reverse! |
| 3997 | |
| 3998 | ** array-map renamed to array-map! |
| 3999 | |
| 4000 | ** serial-array-map renamed to serial-array-map! |
| 4001 | |
| 4002 | ** catch doesn't take #f as first argument any longer |
| 4003 | |
| 4004 | Previously, it was possible to pass #f instead of a key to `catch'. |
| 4005 | That would cause `catch' to pass a jump buffer object to the procedure |
| 4006 | passed as second argument. The procedure could then use this jump |
| 4007 | buffer objekt as an argument to throw. |
| 4008 | |
| 4009 | This mechanism has been removed since its utility doesn't motivate the |
| 4010 | extra complexity it introduces. |
| 4011 | |
| 4012 | ** The `#/' notation for lists now provokes a warning message from Guile. |
| 4013 | This syntax will be removed from Guile in the near future. |
| 4014 | |
| 4015 | To disable the warning message, set the GUILE_HUSH environment |
| 4016 | variable to any non-empty value. |
| 4017 | |
| 4018 | ** The newline character now prints as `#\newline', following the |
| 4019 | normal Scheme notation, not `#\nl'. |
| 4020 | |
| 4021 | * Changes to the gh_ interface |
| 4022 | |
| 4023 | ** The gh_enter function now takes care of loading the Guile startup files. |
| 4024 | gh_enter works by calling scm_boot_guile; see the remarks below. |
| 4025 | |
| 4026 | ** Function: void gh_write (SCM x) |
| 4027 | |
| 4028 | Write the printed representation of the scheme object x to the current |
| 4029 | output port. Corresponds to the scheme level `write'. |
| 4030 | |
| 4031 | ** gh_list_length renamed to gh_length. |
| 4032 | |
| 4033 | ** vector handling routines |
| 4034 | |
| 4035 | Several major changes. In particular, gh_vector() now resembles |
| 4036 | (vector ...) (with a caveat -- see manual), and gh_make_vector() now |
| 4037 | exists and behaves like (make-vector ...). gh_vset() and gh_vref() |
| 4038 | have been renamed gh_vector_set_x() and gh_vector_ref(). Some missing |
| 4039 | vector-related gh_ functions have been implemented. |
| 4040 | |
| 4041 | ** pair and list routines |
| 4042 | |
| 4043 | Implemented several of the R4RS pair and list functions that were |
| 4044 | missing. |
| 4045 | |
| 4046 | ** gh_scm2doubles, gh_doubles2scm, gh_doubles2dvect |
| 4047 | |
| 4048 | New function. Converts double arrays back and forth between Scheme |
| 4049 | and C. |
| 4050 | |
| 4051 | * Changes to the scm_ interface |
| 4052 | |
| 4053 | ** The function scm_boot_guile now takes care of loading the startup files. |
| 4054 | |
| 4055 | Guile's primary initialization function, scm_boot_guile, now takes |
| 4056 | care of loading `boot-9.scm', in the `ice-9' module, to initialize |
| 4057 | Guile, define the module system, and put together some standard |
| 4058 | bindings. It also loads `init.scm', which is intended to hold |
| 4059 | site-specific initialization code. |
| 4060 | |
| 4061 | Since Guile cannot operate properly until boot-9.scm is loaded, there |
| 4062 | is no reason to separate loading boot-9.scm from Guile's other |
| 4063 | initialization processes. |
| 4064 | |
| 4065 | This job used to be done by scm_compile_shell_switches, which didn't |
| 4066 | make much sense; in particular, it meant that people using Guile for |
| 4067 | non-shell-like applications had to jump through hoops to get Guile |
| 4068 | initialized properly. |
| 4069 | |
| 4070 | ** The function scm_compile_shell_switches no longer loads the startup files. |
| 4071 | Now, Guile always loads the startup files, whenever it is initialized; |
| 4072 | see the notes above for scm_boot_guile and scm_load_startup_files. |
| 4073 | |
| 4074 | ** Function: scm_load_startup_files |
| 4075 | This new function takes care of loading Guile's initialization file |
| 4076 | (`boot-9.scm'), and the site initialization file, `init.scm'. Since |
| 4077 | this is always called by the Guile initialization process, it's |
| 4078 | probably not too useful to call this yourself, but it's there anyway. |
| 4079 | |
| 4080 | ** The semantics of smob marking have changed slightly. |
| 4081 | |
| 4082 | The smob marking function (the `mark' member of the scm_smobfuns |
| 4083 | structure) is no longer responsible for setting the mark bit on the |
| 4084 | smob. The generic smob handling code in the garbage collector will |
| 4085 | set this bit. The mark function need only ensure that any other |
| 4086 | objects the smob refers to get marked. |
| 4087 | |
| 4088 | Note that this change means that the smob's GC8MARK bit is typically |
| 4089 | already set upon entry to the mark function. Thus, marking functions |
| 4090 | which look like this: |
| 4091 | |
| 4092 | { |
| 4093 | if (SCM_GC8MARKP (ptr)) |
| 4094 | return SCM_BOOL_F; |
| 4095 | SCM_SETGC8MARK (ptr); |
| 4096 | ... mark objects to which the smob refers ... |
| 4097 | } |
| 4098 | |
| 4099 | are now incorrect, since they will return early, and fail to mark any |
| 4100 | other objects the smob refers to. Some code in the Guile library used |
| 4101 | to work this way. |
| 4102 | |
| 4103 | ** The semantics of the I/O port functions in scm_ptobfuns have changed. |
| 4104 | |
| 4105 | If you have implemented your own I/O port type, by writing the |
| 4106 | functions required by the scm_ptobfuns and then calling scm_newptob, |
| 4107 | you will need to change your functions slightly. |
| 4108 | |
| 4109 | The functions in a scm_ptobfuns structure now expect the port itself |
| 4110 | as their argument; they used to expect the `stream' member of the |
| 4111 | port's scm_port_table structure. This allows functions in an |
| 4112 | scm_ptobfuns structure to easily access the port's cell (and any flags |
| 4113 | it its CAR), and the port's scm_port_table structure. |
| 4114 | |
| 4115 | Guile now passes the I/O port itself as the `port' argument in the |
| 4116 | following scm_ptobfuns functions: |
| 4117 | |
| 4118 | int (*free) (SCM port); |
| 4119 | int (*fputc) (int, SCM port); |
| 4120 | int (*fputs) (char *, SCM port); |
| 4121 | scm_sizet (*fwrite) SCM_P ((char *ptr, |
| 4122 | scm_sizet size, |
| 4123 | scm_sizet nitems, |
| 4124 | SCM port)); |
| 4125 | int (*fflush) (SCM port); |
| 4126 | int (*fgetc) (SCM port); |
| 4127 | int (*fclose) (SCM port); |
| 4128 | |
| 4129 | The interfaces to the `mark', `print', `equalp', and `fgets' methods |
| 4130 | are unchanged. |
| 4131 | |
| 4132 | If you have existing code which defines its own port types, it is easy |
| 4133 | to convert your code to the new interface; simply apply SCM_STREAM to |
| 4134 | the port argument to yield the value you code used to expect. |
| 4135 | |
| 4136 | Note that since both the port and the stream have the same type in the |
| 4137 | C code --- they are both SCM values --- the C compiler will not remind |
| 4138 | you if you forget to update your scm_ptobfuns functions. |
| 4139 | |
| 4140 | |
| 4141 | ** Function: int scm_internal_select (int fds, |
| 4142 | SELECT_TYPE *rfds, |
| 4143 | SELECT_TYPE *wfds, |
| 4144 | SELECT_TYPE *efds, |
| 4145 | struct timeval *timeout); |
| 4146 | |
| 4147 | This is a replacement for the `select' function provided by the OS. |
| 4148 | It enables I/O blocking and sleeping to happen for one cooperative |
| 4149 | thread without blocking other threads. It also avoids busy-loops in |
| 4150 | these situations. It is intended that all I/O blocking and sleeping |
| 4151 | will finally go through this function. Currently, this function is |
| 4152 | only available on systems providing `gettimeofday' and `select'. |
| 4153 | |
| 4154 | ** Function: SCM scm_internal_stack_catch (SCM tag, |
| 4155 | scm_catch_body_t body, |
| 4156 | void *body_data, |
| 4157 | scm_catch_handler_t handler, |
| 4158 | void *handler_data) |
| 4159 | |
| 4160 | A new sibling to the other two C level `catch' functions |
| 4161 | scm_internal_catch and scm_internal_lazy_catch. Use it if you want |
| 4162 | the stack to be saved automatically into the variable `the-last-stack' |
| 4163 | (scm_the_last_stack_var) on error. This is necessary if you want to |
| 4164 | use advanced error reporting, such as calling scm_display_error and |
| 4165 | scm_display_backtrace. (They both take a stack object as argument.) |
| 4166 | |
| 4167 | ** Function: SCM scm_spawn_thread (scm_catch_body_t body, |
| 4168 | void *body_data, |
| 4169 | scm_catch_handler_t handler, |
| 4170 | void *handler_data) |
| 4171 | |
| 4172 | Spawns a new thread. It does a job similar to |
| 4173 | scm_call_with_new_thread but takes arguments more suitable when |
| 4174 | spawning threads from application C code. |
| 4175 | |
| 4176 | ** The hook scm_error_callback has been removed. It was originally |
| 4177 | intended as a way for the user to install his own error handler. But |
| 4178 | that method works badly since it intervenes between throw and catch, |
| 4179 | thereby changing the semantics of expressions like (catch #t ...). |
| 4180 | The correct way to do it is to use one of the C level catch functions |
| 4181 | in throw.c: scm_internal_catch/lazy_catch/stack_catch. |
| 4182 | |
| 4183 | ** Removed functions: |
| 4184 | |
| 4185 | scm_obj_length, scm_list_length, scm_list_append, scm_list_append_x, |
| 4186 | scm_list_reverse, scm_list_reverse_x |
| 4187 | |
| 4188 | ** New macros: SCM_LISTn where n is one of the integers 0-9. |
| 4189 | |
| 4190 | These can be used for pretty list creation from C. The idea is taken |
| 4191 | from Erick Gallesio's STk. |
| 4192 | |
| 4193 | ** scm_array_map renamed to scm_array_map_x |
| 4194 | |
| 4195 | ** mbstrings are now removed |
| 4196 | |
| 4197 | This means that the type codes scm_tc7_mb_string and |
| 4198 | scm_tc7_mb_substring has been removed. |
| 4199 | |
| 4200 | ** scm_gen_putc, scm_gen_puts, scm_gen_write, and scm_gen_getc have changed. |
| 4201 | |
| 4202 | Since we no longer support multi-byte strings, these I/O functions |
| 4203 | have been simplified, and renamed. Here are their old names, and |
| 4204 | their new names and arguments: |
| 4205 | |
| 4206 | scm_gen_putc -> void scm_putc (int c, SCM port); |
| 4207 | scm_gen_puts -> void scm_puts (char *s, SCM port); |
| 4208 | scm_gen_write -> void scm_lfwrite (char *ptr, scm_sizet size, SCM port); |
| 4209 | scm_gen_getc -> void scm_getc (SCM port); |
| 4210 | |
| 4211 | |
| 4212 | ** The macros SCM_TYP7D and SCM_TYP7SD has been removed. |
| 4213 | |
| 4214 | ** The macro SCM_TYP7S has taken the role of the old SCM_TYP7D |
| 4215 | |
| 4216 | SCM_TYP7S now masks away the bit which distinguishes substrings from |
| 4217 | strings. |
| 4218 | |
| 4219 | ** scm_catch_body_t: Backward incompatible change! |
| 4220 | |
| 4221 | Body functions to scm_internal_catch and friends do not any longer |
| 4222 | take a second argument. This is because it is no longer possible to |
| 4223 | pass a #f arg to catch. |
| 4224 | |
| 4225 | ** Calls to scm_protect_object and scm_unprotect now nest properly. |
| 4226 | |
| 4227 | The function scm_protect_object protects its argument from being freed |
| 4228 | by the garbage collector. scm_unprotect_object removes that |
| 4229 | protection. |
| 4230 | |
| 4231 | These functions now nest properly. That is, for every object O, there |
| 4232 | is a counter which scm_protect_object(O) increments and |
| 4233 | scm_unprotect_object(O) decrements, if the counter is greater than |
| 4234 | zero. Every object's counter is zero when it is first created. If an |
| 4235 | object's counter is greater than zero, the garbage collector will not |
| 4236 | reclaim its storage. |
| 4237 | |
| 4238 | This allows you to use scm_protect_object in your code without |
| 4239 | worrying that some other function you call will call |
| 4240 | scm_unprotect_object, and allow it to be freed. Assuming that the |
| 4241 | functions you call are well-behaved, and unprotect only those objects |
| 4242 | they protect, you can follow the same rule and have confidence that |
| 4243 | objects will be freed only at appropriate times. |
| 4244 | |
| 4245 | \f |
| 4246 | Changes in Guile 1.2 (released Tuesday, June 24 1997): |
| 4247 | |
| 4248 | * Changes to the distribution |
| 4249 | |
| 4250 | ** Nightly snapshots are now available from ftp.red-bean.com. |
| 4251 | The old server, ftp.cyclic.com, has been relinquished to its rightful |
| 4252 | owner. |
| 4253 | |
| 4254 | Nightly snapshots of the Guile development sources are now available via |
| 4255 | anonymous FTP from ftp.red-bean.com, as /pub/guile/guile-snap.tar.gz. |
| 4256 | |
| 4257 | Via the web, that's: ftp://ftp.red-bean.com/pub/guile/guile-snap.tar.gz |
| 4258 | For getit, that's: ftp.red-bean.com:/pub/guile/guile-snap.tar.gz |
| 4259 | |
| 4260 | ** To run Guile without installing it, the procedure has changed a bit. |
| 4261 | |
| 4262 | If you used a separate build directory to compile Guile, you'll need |
| 4263 | to include the build directory in SCHEME_LOAD_PATH, as well as the |
| 4264 | source directory. See the `INSTALL' file for examples. |
| 4265 | |
| 4266 | * Changes to the procedure for linking libguile with your programs |
| 4267 | |
| 4268 | ** The standard Guile load path for Scheme code now includes |
| 4269 | $(datadir)/guile (usually /usr/local/share/guile). This means that |
| 4270 | you can install your own Scheme files there, and Guile will find them. |
| 4271 | (Previous versions of Guile only checked a directory whose name |
| 4272 | contained the Guile version number, so you had to re-install or move |
| 4273 | your Scheme sources each time you installed a fresh version of Guile.) |
| 4274 | |
| 4275 | The load path also includes $(datadir)/guile/site; we recommend |
| 4276 | putting individual Scheme files there. If you want to install a |
| 4277 | package with multiple source files, create a directory for them under |
| 4278 | $(datadir)/guile. |
| 4279 | |
| 4280 | ** Guile 1.2 will now use the Rx regular expression library, if it is |
| 4281 | installed on your system. When you are linking libguile into your own |
| 4282 | programs, this means you will have to link against -lguile, -lqt (if |
| 4283 | you configured Guile with thread support), and -lrx. |
| 4284 | |
| 4285 | If you are using autoconf to generate configuration scripts for your |
| 4286 | application, the following lines should suffice to add the appropriate |
| 4287 | libraries to your link command: |
| 4288 | |
| 4289 | ### Find Rx, quickthreads and libguile. |
| 4290 | AC_CHECK_LIB(rx, main) |
| 4291 | AC_CHECK_LIB(qt, main) |
| 4292 | AC_CHECK_LIB(guile, scm_shell) |
| 4293 | |
| 4294 | The Guile 1.2 distribution does not contain sources for the Rx |
| 4295 | library, as Guile 1.0 did. If you want to use Rx, you'll need to |
| 4296 | retrieve it from a GNU FTP site and install it separately. |
| 4297 | |
| 4298 | * Changes to Scheme functions and syntax |
| 4299 | |
| 4300 | ** The dynamic linking features of Guile are now enabled by default. |
| 4301 | You can disable them by giving the `--disable-dynamic-linking' option |
| 4302 | to configure. |
| 4303 | |
| 4304 | (dynamic-link FILENAME) |
| 4305 | |
| 4306 | Find the object file denoted by FILENAME (a string) and link it |
| 4307 | into the running Guile application. When everything works out, |
| 4308 | return a Scheme object suitable for representing the linked object |
| 4309 | file. Otherwise an error is thrown. How object files are |
| 4310 | searched is system dependent. |
| 4311 | |
| 4312 | (dynamic-object? VAL) |
| 4313 | |
| 4314 | Determine whether VAL represents a dynamically linked object file. |
| 4315 | |
| 4316 | (dynamic-unlink DYNOBJ) |
| 4317 | |
| 4318 | Unlink the indicated object file from the application. DYNOBJ |
| 4319 | should be one of the values returned by `dynamic-link'. |
| 4320 | |
| 4321 | (dynamic-func FUNCTION DYNOBJ) |
| 4322 | |
| 4323 | Search the C function indicated by FUNCTION (a string or symbol) |
| 4324 | in DYNOBJ and return some Scheme object that can later be used |
| 4325 | with `dynamic-call' to actually call this function. Right now, |
| 4326 | these Scheme objects are formed by casting the address of the |
| 4327 | function to `long' and converting this number to its Scheme |
| 4328 | representation. |
| 4329 | |
| 4330 | (dynamic-call FUNCTION DYNOBJ) |
| 4331 | |
| 4332 | Call the C function indicated by FUNCTION and DYNOBJ. The |
| 4333 | function is passed no arguments and its return value is ignored. |
| 4334 | When FUNCTION is something returned by `dynamic-func', call that |
| 4335 | function and ignore DYNOBJ. When FUNCTION is a string (or symbol, |
| 4336 | etc.), look it up in DYNOBJ; this is equivalent to |
| 4337 | |
| 4338 | (dynamic-call (dynamic-func FUNCTION DYNOBJ) #f) |
| 4339 | |
| 4340 | Interrupts are deferred while the C function is executing (with |
| 4341 | SCM_DEFER_INTS/SCM_ALLOW_INTS). |
| 4342 | |
| 4343 | (dynamic-args-call FUNCTION DYNOBJ ARGS) |
| 4344 | |
| 4345 | Call the C function indicated by FUNCTION and DYNOBJ, but pass it |
| 4346 | some arguments and return its return value. The C function is |
| 4347 | expected to take two arguments and return an `int', just like |
| 4348 | `main': |
| 4349 | |
| 4350 | int c_func (int argc, char **argv); |
| 4351 | |
| 4352 | ARGS must be a list of strings and is converted into an array of |
| 4353 | `char *'. The array is passed in ARGV and its size in ARGC. The |
| 4354 | return value is converted to a Scheme number and returned from the |
| 4355 | call to `dynamic-args-call'. |
| 4356 | |
| 4357 | When dynamic linking is disabled or not supported on your system, |
| 4358 | the above functions throw errors, but they are still available. |
| 4359 | |
| 4360 | Here is a small example that works on GNU/Linux: |
| 4361 | |
| 4362 | (define libc-obj (dynamic-link "libc.so")) |
| 4363 | (dynamic-args-call 'rand libc-obj '()) |
| 4364 | |
| 4365 | See the file `libguile/DYNAMIC-LINKING' for additional comments. |
| 4366 | |
| 4367 | ** The #/ syntax for module names is depreciated, and will be removed |
| 4368 | in a future version of Guile. Instead of |
| 4369 | |
| 4370 | #/foo/bar/baz |
| 4371 | |
| 4372 | instead write |
| 4373 | |
| 4374 | (foo bar baz) |
| 4375 | |
| 4376 | The latter syntax is more consistent with existing Lisp practice. |
| 4377 | |
| 4378 | ** Guile now does fancier printing of structures. Structures are the |
| 4379 | underlying implementation for records, which in turn are used to |
| 4380 | implement modules, so all of these object now print differently and in |
| 4381 | a more informative way. |
| 4382 | |
| 4383 | The Scheme printer will examine the builtin variable *struct-printer* |
| 4384 | whenever it needs to print a structure object. When this variable is |
| 4385 | not `#f' it is deemed to be a procedure and will be applied to the |
| 4386 | structure object and the output port. When *struct-printer* is `#f' |
| 4387 | or the procedure return `#f' the structure object will be printed in |
| 4388 | the boring #<struct 80458270> form. |
| 4389 | |
| 4390 | This hook is used by some routines in ice-9/boot-9.scm to implement |
| 4391 | type specific printing routines. Please read the comments there about |
| 4392 | "printing structs". |
| 4393 | |
| 4394 | One of the more specific uses of structs are records. The printing |
| 4395 | procedure that could be passed to MAKE-RECORD-TYPE is now actually |
| 4396 | called. It should behave like a *struct-printer* procedure (described |
| 4397 | above). |
| 4398 | |
| 4399 | ** Guile now supports a new R4RS-compliant syntax for keywords. A |
| 4400 | token of the form #:NAME, where NAME has the same syntax as a Scheme |
| 4401 | symbol, is the external representation of the keyword named NAME. |
| 4402 | Keyword objects print using this syntax as well, so values containing |
| 4403 | keyword objects can be read back into Guile. When used in an |
| 4404 | expression, keywords are self-quoting objects. |
| 4405 | |
| 4406 | Guile suports this read syntax, and uses this print syntax, regardless |
| 4407 | of the current setting of the `keyword' read option. The `keyword' |
| 4408 | read option only controls whether Guile recognizes the `:NAME' syntax, |
| 4409 | which is incompatible with R4RS. (R4RS says such token represent |
| 4410 | symbols.) |
| 4411 | |
| 4412 | ** Guile has regular expression support again. Guile 1.0 included |
| 4413 | functions for matching regular expressions, based on the Rx library. |
| 4414 | In Guile 1.1, the Guile/Rx interface was removed to simplify the |
| 4415 | distribution, and thus Guile had no regular expression support. Guile |
| 4416 | 1.2 again supports the most commonly used functions, and supports all |
| 4417 | of SCSH's regular expression functions. |
| 4418 | |
| 4419 | If your system does not include a POSIX regular expression library, |
| 4420 | and you have not linked Guile with a third-party regexp library such as |
| 4421 | Rx, these functions will not be available. You can tell whether your |
| 4422 | Guile installation includes regular expression support by checking |
| 4423 | whether the `*features*' list includes the `regex' symbol. |
| 4424 | |
| 4425 | *** regexp functions |
| 4426 | |
| 4427 | By default, Guile supports POSIX extended regular expressions. That |
| 4428 | means that the characters `(', `)', `+' and `?' are special, and must |
| 4429 | be escaped if you wish to match the literal characters. |
| 4430 | |
| 4431 | This regular expression interface was modeled after that implemented |
| 4432 | by SCSH, the Scheme Shell. It is intended to be upwardly compatible |
| 4433 | with SCSH regular expressions. |
| 4434 | |
| 4435 | **** Function: string-match PATTERN STR [START] |
| 4436 | Compile the string PATTERN into a regular expression and compare |
| 4437 | it with STR. The optional numeric argument START specifies the |
| 4438 | position of STR at which to begin matching. |
| 4439 | |
| 4440 | `string-match' returns a "match structure" which describes what, |
| 4441 | if anything, was matched by the regular expression. *Note Match |
| 4442 | Structures::. If STR does not match PATTERN at all, |
| 4443 | `string-match' returns `#f'. |
| 4444 | |
| 4445 | Each time `string-match' is called, it must compile its PATTERN |
| 4446 | argument into a regular expression structure. This operation is |
| 4447 | expensive, which makes `string-match' inefficient if the same regular |
| 4448 | expression is used several times (for example, in a loop). For better |
| 4449 | performance, you can compile a regular expression in advance and then |
| 4450 | match strings against the compiled regexp. |
| 4451 | |
| 4452 | **** Function: make-regexp STR [FLAGS] |
| 4453 | Compile the regular expression described by STR, and return the |
| 4454 | compiled regexp structure. If STR does not describe a legal |
| 4455 | regular expression, `make-regexp' throws a |
| 4456 | `regular-expression-syntax' error. |
| 4457 | |
| 4458 | FLAGS may be the bitwise-or of one or more of the following: |
| 4459 | |
| 4460 | **** Constant: regexp/extended |
| 4461 | Use POSIX Extended Regular Expression syntax when interpreting |
| 4462 | STR. If not set, POSIX Basic Regular Expression syntax is used. |
| 4463 | If the FLAGS argument is omitted, we assume regexp/extended. |
| 4464 | |
| 4465 | **** Constant: regexp/icase |
| 4466 | Do not differentiate case. Subsequent searches using the |
| 4467 | returned regular expression will be case insensitive. |
| 4468 | |
| 4469 | **** Constant: regexp/newline |
| 4470 | Match-any-character operators don't match a newline. |
| 4471 | |
| 4472 | A non-matching list ([^...]) not containing a newline matches a |
| 4473 | newline. |
| 4474 | |
| 4475 | Match-beginning-of-line operator (^) matches the empty string |
| 4476 | immediately after a newline, regardless of whether the FLAGS |
| 4477 | passed to regexp-exec contain regexp/notbol. |
| 4478 | |
| 4479 | Match-end-of-line operator ($) matches the empty string |
| 4480 | immediately before a newline, regardless of whether the FLAGS |
| 4481 | passed to regexp-exec contain regexp/noteol. |
| 4482 | |
| 4483 | **** Function: regexp-exec REGEXP STR [START [FLAGS]] |
| 4484 | Match the compiled regular expression REGEXP against `str'. If |
| 4485 | the optional integer START argument is provided, begin matching |
| 4486 | from that position in the string. Return a match structure |
| 4487 | describing the results of the match, or `#f' if no match could be |
| 4488 | found. |
| 4489 | |
| 4490 | FLAGS may be the bitwise-or of one or more of the following: |
| 4491 | |
| 4492 | **** Constant: regexp/notbol |
| 4493 | The match-beginning-of-line operator always fails to match (but |
| 4494 | see the compilation flag regexp/newline above) This flag may be |
| 4495 | used when different portions of a string are passed to |
| 4496 | regexp-exec and the beginning of the string should not be |
| 4497 | interpreted as the beginning of the line. |
| 4498 | |
| 4499 | **** Constant: regexp/noteol |
| 4500 | The match-end-of-line operator always fails to match (but see the |
| 4501 | compilation flag regexp/newline above) |
| 4502 | |
| 4503 | **** Function: regexp? OBJ |
| 4504 | Return `#t' if OBJ is a compiled regular expression, or `#f' |
| 4505 | otherwise. |
| 4506 | |
| 4507 | Regular expressions are commonly used to find patterns in one string |
| 4508 | and replace them with the contents of another string. |
| 4509 | |
| 4510 | **** Function: regexp-substitute PORT MATCH [ITEM...] |
| 4511 | Write to the output port PORT selected contents of the match |
| 4512 | structure MATCH. Each ITEM specifies what should be written, and |
| 4513 | may be one of the following arguments: |
| 4514 | |
| 4515 | * A string. String arguments are written out verbatim. |
| 4516 | |
| 4517 | * An integer. The submatch with that number is written. |
| 4518 | |
| 4519 | * The symbol `pre'. The portion of the matched string preceding |
| 4520 | the regexp match is written. |
| 4521 | |
| 4522 | * The symbol `post'. The portion of the matched string |
| 4523 | following the regexp match is written. |
| 4524 | |
| 4525 | PORT may be `#f', in which case nothing is written; instead, |
| 4526 | `regexp-substitute' constructs a string from the specified ITEMs |
| 4527 | and returns that. |
| 4528 | |
| 4529 | **** Function: regexp-substitute/global PORT REGEXP TARGET [ITEM...] |
| 4530 | Similar to `regexp-substitute', but can be used to perform global |
| 4531 | substitutions on STR. Instead of taking a match structure as an |
| 4532 | argument, `regexp-substitute/global' takes two string arguments: a |
| 4533 | REGEXP string describing a regular expression, and a TARGET string |
| 4534 | which should be matched against this regular expression. |
| 4535 | |
| 4536 | Each ITEM behaves as in REGEXP-SUBSTITUTE, with the following |
| 4537 | exceptions: |
| 4538 | |
| 4539 | * A function may be supplied. When this function is called, it |
| 4540 | will be passed one argument: a match structure for a given |
| 4541 | regular expression match. It should return a string to be |
| 4542 | written out to PORT. |
| 4543 | |
| 4544 | * The `post' symbol causes `regexp-substitute/global' to recurse |
| 4545 | on the unmatched portion of STR. This *must* be supplied in |
| 4546 | order to perform global search-and-replace on STR; if it is |
| 4547 | not present among the ITEMs, then `regexp-substitute/global' |
| 4548 | will return after processing a single match. |
| 4549 | |
| 4550 | *** Match Structures |
| 4551 | |
| 4552 | A "match structure" is the object returned by `string-match' and |
| 4553 | `regexp-exec'. It describes which portion of a string, if any, matched |
| 4554 | the given regular expression. Match structures include: a reference to |
| 4555 | the string that was checked for matches; the starting and ending |
| 4556 | positions of the regexp match; and, if the regexp included any |
| 4557 | parenthesized subexpressions, the starting and ending positions of each |
| 4558 | submatch. |
| 4559 | |
| 4560 | In each of the regexp match functions described below, the `match' |
| 4561 | argument must be a match structure returned by a previous call to |
| 4562 | `string-match' or `regexp-exec'. Most of these functions return some |
| 4563 | information about the original target string that was matched against a |
| 4564 | regular expression; we will call that string TARGET for easy reference. |
| 4565 | |
| 4566 | **** Function: regexp-match? OBJ |
| 4567 | Return `#t' if OBJ is a match structure returned by a previous |
| 4568 | call to `regexp-exec', or `#f' otherwise. |
| 4569 | |
| 4570 | **** Function: match:substring MATCH [N] |
| 4571 | Return the portion of TARGET matched by subexpression number N. |
| 4572 | Submatch 0 (the default) represents the entire regexp match. If |
| 4573 | the regular expression as a whole matched, but the subexpression |
| 4574 | number N did not match, return `#f'. |
| 4575 | |
| 4576 | **** Function: match:start MATCH [N] |
| 4577 | Return the starting position of submatch number N. |
| 4578 | |
| 4579 | **** Function: match:end MATCH [N] |
| 4580 | Return the ending position of submatch number N. |
| 4581 | |
| 4582 | **** Function: match:prefix MATCH |
| 4583 | Return the unmatched portion of TARGET preceding the regexp match. |
| 4584 | |
| 4585 | **** Function: match:suffix MATCH |
| 4586 | Return the unmatched portion of TARGET following the regexp match. |
| 4587 | |
| 4588 | **** Function: match:count MATCH |
| 4589 | Return the number of parenthesized subexpressions from MATCH. |
| 4590 | Note that the entire regular expression match itself counts as a |
| 4591 | subexpression, and failed submatches are included in the count. |
| 4592 | |
| 4593 | **** Function: match:string MATCH |
| 4594 | Return the original TARGET string. |
| 4595 | |
| 4596 | *** Backslash Escapes |
| 4597 | |
| 4598 | Sometimes you will want a regexp to match characters like `*' or `$' |
| 4599 | exactly. For example, to check whether a particular string represents |
| 4600 | a menu entry from an Info node, it would be useful to match it against |
| 4601 | a regexp like `^* [^:]*::'. However, this won't work; because the |
| 4602 | asterisk is a metacharacter, it won't match the `*' at the beginning of |
| 4603 | the string. In this case, we want to make the first asterisk un-magic. |
| 4604 | |
| 4605 | You can do this by preceding the metacharacter with a backslash |
| 4606 | character `\'. (This is also called "quoting" the metacharacter, and |
| 4607 | is known as a "backslash escape".) When Guile sees a backslash in a |
| 4608 | regular expression, it considers the following glyph to be an ordinary |
| 4609 | character, no matter what special meaning it would ordinarily have. |
| 4610 | Therefore, we can make the above example work by changing the regexp to |
| 4611 | `^\* [^:]*::'. The `\*' sequence tells the regular expression engine |
| 4612 | to match only a single asterisk in the target string. |
| 4613 | |
| 4614 | Since the backslash is itself a metacharacter, you may force a |
| 4615 | regexp to match a backslash in the target string by preceding the |
| 4616 | backslash with itself. For example, to find variable references in a |
| 4617 | TeX program, you might want to find occurrences of the string `\let\' |
| 4618 | followed by any number of alphabetic characters. The regular expression |
| 4619 | `\\let\\[A-Za-z]*' would do this: the double backslashes in the regexp |
| 4620 | each match a single backslash in the target string. |
| 4621 | |
| 4622 | **** Function: regexp-quote STR |
| 4623 | Quote each special character found in STR with a backslash, and |
| 4624 | return the resulting string. |
| 4625 | |
| 4626 | *Very important:* Using backslash escapes in Guile source code (as |
| 4627 | in Emacs Lisp or C) can be tricky, because the backslash character has |
| 4628 | special meaning for the Guile reader. For example, if Guile encounters |
| 4629 | the character sequence `\n' in the middle of a string while processing |
| 4630 | Scheme code, it replaces those characters with a newline character. |
| 4631 | Similarly, the character sequence `\t' is replaced by a horizontal tab. |
| 4632 | Several of these "escape sequences" are processed by the Guile reader |
| 4633 | before your code is executed. Unrecognized escape sequences are |
| 4634 | ignored: if the characters `\*' appear in a string, they will be |
| 4635 | translated to the single character `*'. |
| 4636 | |
| 4637 | This translation is obviously undesirable for regular expressions, |
| 4638 | since we want to be able to include backslashes in a string in order to |
| 4639 | escape regexp metacharacters. Therefore, to make sure that a backslash |
| 4640 | is preserved in a string in your Guile program, you must use *two* |
| 4641 | consecutive backslashes: |
| 4642 | |
| 4643 | (define Info-menu-entry-pattern (make-regexp "^\\* [^:]*")) |
| 4644 | |
| 4645 | The string in this example is preprocessed by the Guile reader before |
| 4646 | any code is executed. The resulting argument to `make-regexp' is the |
| 4647 | string `^\* [^:]*', which is what we really want. |
| 4648 | |
| 4649 | This also means that in order to write a regular expression that |
| 4650 | matches a single backslash character, the regular expression string in |
| 4651 | the source code must include *four* backslashes. Each consecutive pair |
| 4652 | of backslashes gets translated by the Guile reader to a single |
| 4653 | backslash, and the resulting double-backslash is interpreted by the |
| 4654 | regexp engine as matching a single backslash character. Hence: |
| 4655 | |
| 4656 | (define tex-variable-pattern (make-regexp "\\\\let\\\\=[A-Za-z]*")) |
| 4657 | |
| 4658 | The reason for the unwieldiness of this syntax is historical. Both |
| 4659 | regular expression pattern matchers and Unix string processing systems |
| 4660 | have traditionally used backslashes with the special meanings described |
| 4661 | above. The POSIX regular expression specification and ANSI C standard |
| 4662 | both require these semantics. Attempting to abandon either convention |
| 4663 | would cause other kinds of compatibility problems, possibly more severe |
| 4664 | ones. Therefore, without extending the Scheme reader to support |
| 4665 | strings with different quoting conventions (an ungainly and confusing |
| 4666 | extension when implemented in other languages), we must adhere to this |
| 4667 | cumbersome escape syntax. |
| 4668 | |
| 4669 | * Changes to the gh_ interface |
| 4670 | |
| 4671 | * Changes to the scm_ interface |
| 4672 | |
| 4673 | * Changes to system call interfaces: |
| 4674 | |
| 4675 | ** The value returned by `raise' is now unspecified. It throws an exception |
| 4676 | if an error occurs. |
| 4677 | |
| 4678 | *** A new procedure `sigaction' can be used to install signal handlers |
| 4679 | |
| 4680 | (sigaction signum [action] [flags]) |
| 4681 | |
| 4682 | signum is the signal number, which can be specified using the value |
| 4683 | of SIGINT etc. |
| 4684 | |
| 4685 | If action is omitted, sigaction returns a pair: the CAR is the current |
| 4686 | signal hander, which will be either an integer with the value SIG_DFL |
| 4687 | (default action) or SIG_IGN (ignore), or the Scheme procedure which |
| 4688 | handles the signal, or #f if a non-Scheme procedure handles the |
| 4689 | signal. The CDR contains the current sigaction flags for the handler. |
| 4690 | |
| 4691 | If action is provided, it is installed as the new handler for signum. |
| 4692 | action can be a Scheme procedure taking one argument, or the value of |
| 4693 | SIG_DFL (default action) or SIG_IGN (ignore), or #f to restore |
| 4694 | whatever signal handler was installed before sigaction was first used. |
| 4695 | Flags can optionally be specified for the new handler (SA_RESTART is |
| 4696 | always used if the system provides it, so need not be specified.) The |
| 4697 | return value is a pair with information about the old handler as |
| 4698 | described above. |
| 4699 | |
| 4700 | This interface does not provide access to the "signal blocking" |
| 4701 | facility. Maybe this is not needed, since the thread support may |
| 4702 | provide solutions to the problem of consistent access to data |
| 4703 | structures. |
| 4704 | |
| 4705 | *** A new procedure `flush-all-ports' is equivalent to running |
| 4706 | `force-output' on every port open for output. |
| 4707 | |
| 4708 | ** Guile now provides information on how it was built, via the new |
| 4709 | global variable, %guile-build-info. This variable records the values |
| 4710 | of the standard GNU makefile directory variables as an assocation |
| 4711 | list, mapping variable names (symbols) onto directory paths (strings). |
| 4712 | For example, to find out where the Guile link libraries were |
| 4713 | installed, you can say: |
| 4714 | |
| 4715 | guile -c "(display (assq-ref %guile-build-info 'libdir)) (newline)" |
| 4716 | |
| 4717 | |
| 4718 | * Changes to the scm_ interface |
| 4719 | |
| 4720 | ** The new function scm_handle_by_message_noexit is just like the |
| 4721 | existing scm_handle_by_message function, except that it doesn't call |
| 4722 | exit to terminate the process. Instead, it prints a message and just |
| 4723 | returns #f. This might be a more appropriate catch-all handler for |
| 4724 | new dynamic roots and threads. |
| 4725 | |
| 4726 | \f |
| 4727 | Changes in Guile 1.1 (released Friday, May 16 1997): |
| 4728 | |
| 4729 | * Changes to the distribution. |
| 4730 | |
| 4731 | The Guile 1.0 distribution has been split up into several smaller |
| 4732 | pieces: |
| 4733 | guile-core --- the Guile interpreter itself. |
| 4734 | guile-tcltk --- the interface between the Guile interpreter and |
| 4735 | Tcl/Tk; Tcl is an interpreter for a stringy language, and Tk |
| 4736 | is a toolkit for building graphical user interfaces. |
| 4737 | guile-rgx-ctax --- the interface between Guile and the Rx regular |
| 4738 | expression matcher, and the translator for the Ctax |
| 4739 | programming language. These are packaged together because the |
| 4740 | Ctax translator uses Rx to parse Ctax source code. |
| 4741 | |
| 4742 | This NEWS file describes the changes made to guile-core since the 1.0 |
| 4743 | release. |
| 4744 | |
| 4745 | We no longer distribute the documentation, since it was either out of |
| 4746 | date, or incomplete. As soon as we have current documentation, we |
| 4747 | will distribute it. |
| 4748 | |
| 4749 | |
| 4750 | |
| 4751 | * Changes to the stand-alone interpreter |
| 4752 | |
| 4753 | ** guile now accepts command-line arguments compatible with SCSH, Olin |
| 4754 | Shivers' Scheme Shell. |
| 4755 | |
| 4756 | In general, arguments are evaluated from left to right, but there are |
| 4757 | exceptions. The following switches stop argument processing, and |
| 4758 | stash all remaining command-line arguments as the value returned by |
| 4759 | the (command-line) function. |
| 4760 | -s SCRIPT load Scheme source code from FILE, and exit |
| 4761 | -c EXPR evalute Scheme expression EXPR, and exit |
| 4762 | -- stop scanning arguments; run interactively |
| 4763 | |
| 4764 | The switches below are processed as they are encountered. |
| 4765 | -l FILE load Scheme source code from FILE |
| 4766 | -e FUNCTION after reading script, apply FUNCTION to |
| 4767 | command line arguments |
| 4768 | -ds do -s script at this point |
| 4769 | --emacs enable Emacs protocol (experimental) |
| 4770 | -h, --help display this help and exit |
| 4771 | -v, --version display version information and exit |
| 4772 | \ read arguments from following script lines |
| 4773 | |
| 4774 | So, for example, here is a Guile script named `ekko' (thanks, Olin) |
| 4775 | which re-implements the traditional "echo" command: |
| 4776 | |
| 4777 | #!/usr/local/bin/guile -s |
| 4778 | !# |
| 4779 | (define (main args) |
| 4780 | (map (lambda (arg) (display arg) (display " ")) |
| 4781 | (cdr args)) |
| 4782 | (newline)) |
| 4783 | |
| 4784 | (main (command-line)) |
| 4785 | |
| 4786 | Suppose we invoke this script as follows: |
| 4787 | |
| 4788 | ekko a speckled gecko |
| 4789 | |
| 4790 | Through the magic of Unix script processing (triggered by the `#!' |
| 4791 | token at the top of the file), /usr/local/bin/guile receives the |
| 4792 | following list of command-line arguments: |
| 4793 | |
| 4794 | ("-s" "./ekko" "a" "speckled" "gecko") |
| 4795 | |
| 4796 | Unix inserts the name of the script after the argument specified on |
| 4797 | the first line of the file (in this case, "-s"), and then follows that |
| 4798 | with the arguments given to the script. Guile loads the script, which |
| 4799 | defines the `main' function, and then applies it to the list of |
| 4800 | remaining command-line arguments, ("a" "speckled" "gecko"). |
| 4801 | |
| 4802 | In Unix, the first line of a script file must take the following form: |
| 4803 | |
| 4804 | #!INTERPRETER ARGUMENT |
| 4805 | |
| 4806 | where INTERPRETER is the absolute filename of the interpreter |
| 4807 | executable, and ARGUMENT is a single command-line argument to pass to |
| 4808 | the interpreter. |
| 4809 | |
| 4810 | You may only pass one argument to the interpreter, and its length is |
| 4811 | limited. These restrictions can be annoying to work around, so Guile |
| 4812 | provides a general mechanism (borrowed from, and compatible with, |
| 4813 | SCSH) for circumventing them. |
| 4814 | |
| 4815 | If the ARGUMENT in a Guile script is a single backslash character, |
| 4816 | `\', Guile will open the script file, parse arguments from its second |
| 4817 | and subsequent lines, and replace the `\' with them. So, for example, |
| 4818 | here is another implementation of the `ekko' script: |
| 4819 | |
| 4820 | #!/usr/local/bin/guile \ |
| 4821 | -e main -s |
| 4822 | !# |
| 4823 | (define (main args) |
| 4824 | (for-each (lambda (arg) (display arg) (display " ")) |
| 4825 | (cdr args)) |
| 4826 | (newline)) |
| 4827 | |
| 4828 | If the user invokes this script as follows: |
| 4829 | |
| 4830 | ekko a speckled gecko |
| 4831 | |
| 4832 | Unix expands this into |
| 4833 | |
| 4834 | /usr/local/bin/guile \ ekko a speckled gecko |
| 4835 | |
| 4836 | When Guile sees the `\' argument, it replaces it with the arguments |
| 4837 | read from the second line of the script, producing: |
| 4838 | |
| 4839 | /usr/local/bin/guile -e main -s ekko a speckled gecko |
| 4840 | |
| 4841 | This tells Guile to load the `ekko' script, and apply the function |
| 4842 | `main' to the argument list ("a" "speckled" "gecko"). |
| 4843 | |
| 4844 | Here is how Guile parses the command-line arguments: |
| 4845 | - Each space character terminates an argument. This means that two |
| 4846 | spaces in a row introduce an empty-string argument. |
| 4847 | - The tab character is not permitted (unless you quote it with the |
| 4848 | backslash character, as described below), to avoid confusion. |
| 4849 | - The newline character terminates the sequence of arguments, and will |
| 4850 | also terminate a final non-empty argument. (However, a newline |
| 4851 | following a space will not introduce a final empty-string argument; |
| 4852 | it only terminates the argument list.) |
| 4853 | - The backslash character is the escape character. It escapes |
| 4854 | backslash, space, tab, and newline. The ANSI C escape sequences |
| 4855 | like \n and \t are also supported. These produce argument |
| 4856 | constituents; the two-character combination \n doesn't act like a |
| 4857 | terminating newline. The escape sequence \NNN for exactly three |
| 4858 | octal digits reads as the character whose ASCII code is NNN. As |
| 4859 | above, characters produced this way are argument constituents. |
| 4860 | Backslash followed by other characters is not allowed. |
| 4861 | |
| 4862 | * Changes to the procedure for linking libguile with your programs |
| 4863 | |
| 4864 | ** Guile now builds and installs a shared guile library, if your |
| 4865 | system support shared libraries. (It still builds a static library on |
| 4866 | all systems.) Guile automatically detects whether your system |
| 4867 | supports shared libraries. To prevent Guile from buildisg shared |
| 4868 | libraries, pass the `--disable-shared' flag to the configure script. |
| 4869 | |
| 4870 | Guile takes longer to compile when it builds shared libraries, because |
| 4871 | it must compile every file twice --- once to produce position- |
| 4872 | independent object code, and once to produce normal object code. |
| 4873 | |
| 4874 | ** The libthreads library has been merged into libguile. |
| 4875 | |
| 4876 | To link a program against Guile, you now need only link against |
| 4877 | -lguile and -lqt; -lthreads is no longer needed. If you are using |
| 4878 | autoconf to generate configuration scripts for your application, the |
| 4879 | following lines should suffice to add the appropriate libraries to |
| 4880 | your link command: |
| 4881 | |
| 4882 | ### Find quickthreads and libguile. |
| 4883 | AC_CHECK_LIB(qt, main) |
| 4884 | AC_CHECK_LIB(guile, scm_shell) |
| 4885 | |
| 4886 | * Changes to Scheme functions |
| 4887 | |
| 4888 | ** Guile Scheme's special syntax for keyword objects is now optional, |
| 4889 | and disabled by default. |
| 4890 | |
| 4891 | The syntax variation from R4RS made it difficult to port some |
| 4892 | interesting packages to Guile. The routines which accepted keyword |
| 4893 | arguments (mostly in the module system) have been modified to also |
| 4894 | accept symbols whose names begin with `:'. |
| 4895 | |
| 4896 | To change the keyword syntax, you must first import the (ice-9 debug) |
| 4897 | module: |
| 4898 | (use-modules (ice-9 debug)) |
| 4899 | |
| 4900 | Then you can enable the keyword syntax as follows: |
| 4901 | (read-set! keywords 'prefix) |
| 4902 | |
| 4903 | To disable keyword syntax, do this: |
| 4904 | (read-set! keywords #f) |
| 4905 | |
| 4906 | ** Many more primitive functions accept shared substrings as |
| 4907 | arguments. In the past, these functions required normal, mutable |
| 4908 | strings as arguments, although they never made use of this |
| 4909 | restriction. |
| 4910 | |
| 4911 | ** The uniform array functions now operate on byte vectors. These |
| 4912 | functions are `array-fill!', `serial-array-copy!', `array-copy!', |
| 4913 | `serial-array-map', `array-map', `array-for-each', and |
| 4914 | `array-index-map!'. |
| 4915 | |
| 4916 | ** The new functions `trace' and `untrace' implement simple debugging |
| 4917 | support for Scheme functions. |
| 4918 | |
| 4919 | The `trace' function accepts any number of procedures as arguments, |
| 4920 | and tells the Guile interpreter to display each procedure's name and |
| 4921 | arguments each time the procedure is invoked. When invoked with no |
| 4922 | arguments, `trace' returns the list of procedures currently being |
| 4923 | traced. |
| 4924 | |
| 4925 | The `untrace' function accepts any number of procedures as arguments, |
| 4926 | and tells the Guile interpreter not to trace them any more. When |
| 4927 | invoked with no arguments, `untrace' untraces all curretly traced |
| 4928 | procedures. |
| 4929 | |
| 4930 | The tracing in Guile has an advantage over most other systems: we |
| 4931 | don't create new procedure objects, but mark the procedure objects |
| 4932 | themselves. This means that anonymous and internal procedures can be |
| 4933 | traced. |
| 4934 | |
| 4935 | ** The function `assert-repl-prompt' has been renamed to |
| 4936 | `set-repl-prompt!'. It takes one argument, PROMPT. |
| 4937 | - If PROMPT is #f, the Guile read-eval-print loop will not prompt. |
| 4938 | - If PROMPT is a string, we use it as a prompt. |
| 4939 | - If PROMPT is a procedure accepting no arguments, we call it, and |
| 4940 | display the result as a prompt. |
| 4941 | - Otherwise, we display "> ". |
| 4942 | |
| 4943 | ** The new function `eval-string' reads Scheme expressions from a |
| 4944 | string and evaluates them, returning the value of the last expression |
| 4945 | in the string. If the string contains no expressions, it returns an |
| 4946 | unspecified value. |
| 4947 | |
| 4948 | ** The new function `thunk?' returns true iff its argument is a |
| 4949 | procedure of zero arguments. |
| 4950 | |
| 4951 | ** `defined?' is now a builtin function, instead of syntax. This |
| 4952 | means that its argument should be quoted. It returns #t iff its |
| 4953 | argument is bound in the current module. |
| 4954 | |
| 4955 | ** The new syntax `use-modules' allows you to add new modules to your |
| 4956 | environment without re-typing a complete `define-module' form. It |
| 4957 | accepts any number of module names as arguments, and imports their |
| 4958 | public bindings into the current module. |
| 4959 | |
| 4960 | ** The new function (module-defined? NAME MODULE) returns true iff |
| 4961 | NAME, a symbol, is defined in MODULE, a module object. |
| 4962 | |
| 4963 | ** The new function `builtin-bindings' creates and returns a hash |
| 4964 | table containing copies of all the root module's bindings. |
| 4965 | |
| 4966 | ** The new function `builtin-weak-bindings' does the same as |
| 4967 | `builtin-bindings', but creates a doubly-weak hash table. |
| 4968 | |
| 4969 | ** The `equal?' function now considers variable objects to be |
| 4970 | equivalent if they have the same name and the same value. |
| 4971 | |
| 4972 | ** The new function `command-line' returns the command-line arguments |
| 4973 | given to Guile, as a list of strings. |
| 4974 | |
| 4975 | When using guile as a script interpreter, `command-line' returns the |
| 4976 | script's arguments; those processed by the interpreter (like `-s' or |
| 4977 | `-c') are omitted. (In other words, you get the normal, expected |
| 4978 | behavior.) Any application that uses scm_shell to process its |
| 4979 | command-line arguments gets this behavior as well. |
| 4980 | |
| 4981 | ** The new function `load-user-init' looks for a file called `.guile' |
| 4982 | in the user's home directory, and loads it if it exists. This is |
| 4983 | mostly for use by the code generated by scm_compile_shell_switches, |
| 4984 | but we thought it might also be useful in other circumstances. |
| 4985 | |
| 4986 | ** The new function `log10' returns the base-10 logarithm of its |
| 4987 | argument. |
| 4988 | |
| 4989 | ** Changes to I/O functions |
| 4990 | |
| 4991 | *** The functions `read', `primitive-load', `read-and-eval!', and |
| 4992 | `primitive-load-path' no longer take optional arguments controlling |
| 4993 | case insensitivity and a `#' parser. |
| 4994 | |
| 4995 | Case sensitivity is now controlled by a read option called |
| 4996 | `case-insensitive'. The user can add new `#' syntaxes with the |
| 4997 | `read-hash-extend' function (see below). |
| 4998 | |
| 4999 | *** The new function `read-hash-extend' allows the user to change the |
| 5000 | syntax of Guile Scheme in a somewhat controlled way. |
| 5001 | |
| 5002 | (read-hash-extend CHAR PROC) |
| 5003 | When parsing S-expressions, if we read a `#' character followed by |
| 5004 | the character CHAR, use PROC to parse an object from the stream. |
| 5005 | If PROC is #f, remove any parsing procedure registered for CHAR. |
| 5006 | |
| 5007 | The reader applies PROC to two arguments: CHAR and an input port. |
| 5008 | |
| 5009 | *** The new functions read-delimited and read-delimited! provide a |
| 5010 | general mechanism for doing delimited input on streams. |
| 5011 | |
| 5012 | (read-delimited DELIMS [PORT HANDLE-DELIM]) |
| 5013 | Read until we encounter one of the characters in DELIMS (a string), |
| 5014 | or end-of-file. PORT is the input port to read from; it defaults to |
| 5015 | the current input port. The HANDLE-DELIM parameter determines how |
| 5016 | the terminating character is handled; it should be one of the |
| 5017 | following symbols: |
| 5018 | |
| 5019 | 'trim omit delimiter from result |
| 5020 | 'peek leave delimiter character in input stream |
| 5021 | 'concat append delimiter character to returned value |
| 5022 | 'split return a pair: (RESULT . TERMINATOR) |
| 5023 | |
| 5024 | HANDLE-DELIM defaults to 'peek. |
| 5025 | |
| 5026 | (read-delimited! DELIMS BUF [PORT HANDLE-DELIM START END]) |
| 5027 | A side-effecting variant of `read-delimited'. |
| 5028 | |
| 5029 | The data is written into the string BUF at the indices in the |
| 5030 | half-open interval [START, END); the default interval is the whole |
| 5031 | string: START = 0 and END = (string-length BUF). The values of |
| 5032 | START and END must specify a well-defined interval in BUF, i.e. |
| 5033 | 0 <= START <= END <= (string-length BUF). |
| 5034 | |
| 5035 | It returns NBYTES, the number of bytes read. If the buffer filled |
| 5036 | up without a delimiter character being found, it returns #f. If the |
| 5037 | port is at EOF when the read starts, it returns the EOF object. |
| 5038 | |
| 5039 | If an integer is returned (i.e., the read is successfully terminated |
| 5040 | by reading a delimiter character), then the HANDLE-DELIM parameter |
| 5041 | determines how to handle the terminating character. It is described |
| 5042 | above, and defaults to 'peek. |
| 5043 | |
| 5044 | (The descriptions of these functions were borrowed from the SCSH |
| 5045 | manual, by Olin Shivers and Brian Carlstrom.) |
| 5046 | |
| 5047 | *** The `%read-delimited!' function is the primitive used to implement |
| 5048 | `read-delimited' and `read-delimited!'. |
| 5049 | |
| 5050 | (%read-delimited! DELIMS BUF GOBBLE? [PORT START END]) |
| 5051 | |
| 5052 | This returns a pair of values: (TERMINATOR . NUM-READ). |
| 5053 | - TERMINATOR describes why the read was terminated. If it is a |
| 5054 | character or the eof object, then that is the value that terminated |
| 5055 | the read. If it is #f, the function filled the buffer without finding |
| 5056 | a delimiting character. |
| 5057 | - NUM-READ is the number of characters read into BUF. |
| 5058 | |
| 5059 | If the read is successfully terminated by reading a delimiter |
| 5060 | character, then the gobble? parameter determines what to do with the |
| 5061 | terminating character. If true, the character is removed from the |
| 5062 | input stream; if false, the character is left in the input stream |
| 5063 | where a subsequent read operation will retrieve it. In either case, |
| 5064 | the character is also the first value returned by the procedure call. |
| 5065 | |
| 5066 | (The descriptions of this function was borrowed from the SCSH manual, |
| 5067 | by Olin Shivers and Brian Carlstrom.) |
| 5068 | |
| 5069 | *** The `read-line' and `read-line!' functions have changed; they now |
| 5070 | trim the terminator by default; previously they appended it to the |
| 5071 | returned string. For the old behavior, use (read-line PORT 'concat). |
| 5072 | |
| 5073 | *** The functions `uniform-array-read!' and `uniform-array-write!' now |
| 5074 | take new optional START and END arguments, specifying the region of |
| 5075 | the array to read and write. |
| 5076 | |
| 5077 | *** The `ungetc-char-ready?' function has been removed. We feel it's |
| 5078 | inappropriate for an interface to expose implementation details this |
| 5079 | way. |
| 5080 | |
| 5081 | ** Changes to the Unix library and system call interface |
| 5082 | |
| 5083 | *** The new fcntl function provides access to the Unix `fcntl' system |
| 5084 | call. |
| 5085 | |
| 5086 | (fcntl PORT COMMAND VALUE) |
| 5087 | Apply COMMAND to PORT's file descriptor, with VALUE as an argument. |
| 5088 | Values for COMMAND are: |
| 5089 | |
| 5090 | F_DUPFD duplicate a file descriptor |
| 5091 | F_GETFD read the descriptor's close-on-exec flag |
| 5092 | F_SETFD set the descriptor's close-on-exec flag to VALUE |
| 5093 | F_GETFL read the descriptor's flags, as set on open |
| 5094 | F_SETFL set the descriptor's flags, as set on open to VALUE |
| 5095 | F_GETOWN return the process ID of a socket's owner, for SIGIO |
| 5096 | F_SETOWN set the process that owns a socket to VALUE, for SIGIO |
| 5097 | FD_CLOEXEC not sure what this is |
| 5098 | |
| 5099 | For details, see the documentation for the fcntl system call. |
| 5100 | |
| 5101 | *** The arguments to `select' have changed, for compatibility with |
| 5102 | SCSH. The TIMEOUT parameter may now be non-integral, yielding the |
| 5103 | expected behavior. The MILLISECONDS parameter has been changed to |
| 5104 | MICROSECONDS, to more closely resemble the underlying system call. |
| 5105 | The RVEC, WVEC, and EVEC arguments can now be vectors; the type of the |
| 5106 | corresponding return set will be the same. |
| 5107 | |
| 5108 | *** The arguments to the `mknod' system call have changed. They are |
| 5109 | now: |
| 5110 | |
| 5111 | (mknod PATH TYPE PERMS DEV) |
| 5112 | Create a new file (`node') in the file system. PATH is the name of |
| 5113 | the file to create. TYPE is the kind of file to create; it should |
| 5114 | be 'fifo, 'block-special, or 'char-special. PERMS specifies the |
| 5115 | permission bits to give the newly created file. If TYPE is |
| 5116 | 'block-special or 'char-special, DEV specifies which device the |
| 5117 | special file refers to; its interpretation depends on the kind of |
| 5118 | special file being created. |
| 5119 | |
| 5120 | *** The `fork' function has been renamed to `primitive-fork', to avoid |
| 5121 | clashing with various SCSH forks. |
| 5122 | |
| 5123 | *** The `recv' and `recvfrom' functions have been renamed to `recv!' |
| 5124 | and `recvfrom!'. They no longer accept a size for a second argument; |
| 5125 | you must pass a string to hold the received value. They no longer |
| 5126 | return the buffer. Instead, `recv' returns the length of the message |
| 5127 | received, and `recvfrom' returns a pair containing the packet's length |
| 5128 | and originating address. |
| 5129 | |
| 5130 | *** The file descriptor datatype has been removed, as have the |
| 5131 | `read-fd', `write-fd', `close', `lseek', and `dup' functions. |
| 5132 | We plan to replace these functions with a SCSH-compatible interface. |
| 5133 | |
| 5134 | *** The `create' function has been removed; it's just a special case |
| 5135 | of `open'. |
| 5136 | |
| 5137 | *** There are new functions to break down process termination status |
| 5138 | values. In the descriptions below, STATUS is a value returned by |
| 5139 | `waitpid'. |
| 5140 | |
| 5141 | (status:exit-val STATUS) |
| 5142 | If the child process exited normally, this function returns the exit |
| 5143 | code for the child process (i.e., the value passed to exit, or |
| 5144 | returned from main). If the child process did not exit normally, |
| 5145 | this function returns #f. |
| 5146 | |
| 5147 | (status:stop-sig STATUS) |
| 5148 | If the child process was suspended by a signal, this function |
| 5149 | returns the signal that suspended the child. Otherwise, it returns |
| 5150 | #f. |
| 5151 | |
| 5152 | (status:term-sig STATUS) |
| 5153 | If the child process terminated abnormally, this function returns |
| 5154 | the signal that terminated the child. Otherwise, this function |
| 5155 | returns false. |
| 5156 | |
| 5157 | POSIX promises that exactly one of these functions will return true on |
| 5158 | a valid STATUS value. |
| 5159 | |
| 5160 | These functions are compatible with SCSH. |
| 5161 | |
| 5162 | *** There are new accessors and setters for the broken-out time vectors |
| 5163 | returned by `localtime', `gmtime', and that ilk. They are: |
| 5164 | |
| 5165 | Component Accessor Setter |
| 5166 | ========================= ============ ============ |
| 5167 | seconds tm:sec set-tm:sec |
| 5168 | minutes tm:min set-tm:min |
| 5169 | hours tm:hour set-tm:hour |
| 5170 | day of the month tm:mday set-tm:mday |
| 5171 | month tm:mon set-tm:mon |
| 5172 | year tm:year set-tm:year |
| 5173 | day of the week tm:wday set-tm:wday |
| 5174 | day in the year tm:yday set-tm:yday |
| 5175 | daylight saving time tm:isdst set-tm:isdst |
| 5176 | GMT offset, seconds tm:gmtoff set-tm:gmtoff |
| 5177 | name of time zone tm:zone set-tm:zone |
| 5178 | |
| 5179 | *** There are new accessors for the vectors returned by `uname', |
| 5180 | describing the host system: |
| 5181 | |
| 5182 | Component Accessor |
| 5183 | ============================================== ================ |
| 5184 | name of the operating system implementation utsname:sysname |
| 5185 | network name of this machine utsname:nodename |
| 5186 | release level of the operating system utsname:release |
| 5187 | version level of the operating system utsname:version |
| 5188 | machine hardware platform utsname:machine |
| 5189 | |
| 5190 | *** There are new accessors for the vectors returned by `getpw', |
| 5191 | `getpwnam', `getpwuid', and `getpwent', describing entries from the |
| 5192 | system's user database: |
| 5193 | |
| 5194 | Component Accessor |
| 5195 | ====================== ================= |
| 5196 | user name passwd:name |
| 5197 | user password passwd:passwd |
| 5198 | user id passwd:uid |
| 5199 | group id passwd:gid |
| 5200 | real name passwd:gecos |
| 5201 | home directory passwd:dir |
| 5202 | shell program passwd:shell |
| 5203 | |
| 5204 | *** There are new accessors for the vectors returned by `getgr', |
| 5205 | `getgrnam', `getgrgid', and `getgrent', describing entries from the |
| 5206 | system's group database: |
| 5207 | |
| 5208 | Component Accessor |
| 5209 | ======================= ============ |
| 5210 | group name group:name |
| 5211 | group password group:passwd |
| 5212 | group id group:gid |
| 5213 | group members group:mem |
| 5214 | |
| 5215 | *** There are new accessors for the vectors returned by `gethost', |
| 5216 | `gethostbyaddr', `gethostbyname', and `gethostent', describing |
| 5217 | internet hosts: |
| 5218 | |
| 5219 | Component Accessor |
| 5220 | ========================= =============== |
| 5221 | official name of host hostent:name |
| 5222 | alias list hostent:aliases |
| 5223 | host address type hostent:addrtype |
| 5224 | length of address hostent:length |
| 5225 | list of addresses hostent:addr-list |
| 5226 | |
| 5227 | *** There are new accessors for the vectors returned by `getnet', |
| 5228 | `getnetbyaddr', `getnetbyname', and `getnetent', describing internet |
| 5229 | networks: |
| 5230 | |
| 5231 | Component Accessor |
| 5232 | ========================= =============== |
| 5233 | official name of net netent:name |
| 5234 | alias list netent:aliases |
| 5235 | net number type netent:addrtype |
| 5236 | net number netent:net |
| 5237 | |
| 5238 | *** There are new accessors for the vectors returned by `getproto', |
| 5239 | `getprotobyname', `getprotobynumber', and `getprotoent', describing |
| 5240 | internet protocols: |
| 5241 | |
| 5242 | Component Accessor |
| 5243 | ========================= =============== |
| 5244 | official protocol name protoent:name |
| 5245 | alias list protoent:aliases |
| 5246 | protocol number protoent:proto |
| 5247 | |
| 5248 | *** There are new accessors for the vectors returned by `getserv', |
| 5249 | `getservbyname', `getservbyport', and `getservent', describing |
| 5250 | internet protocols: |
| 5251 | |
| 5252 | Component Accessor |
| 5253 | ========================= =============== |
| 5254 | official service name servent:name |
| 5255 | alias list servent:aliases |
| 5256 | port number servent:port |
| 5257 | protocol to use servent:proto |
| 5258 | |
| 5259 | *** There are new accessors for the sockaddr structures returned by |
| 5260 | `accept', `getsockname', `getpeername', `recvfrom!': |
| 5261 | |
| 5262 | Component Accessor |
| 5263 | ======================================== =============== |
| 5264 | address format (`family') sockaddr:fam |
| 5265 | path, for file domain addresses sockaddr:path |
| 5266 | address, for internet domain addresses sockaddr:addr |
| 5267 | TCP or UDP port, for internet sockaddr:port |
| 5268 | |
| 5269 | *** The `getpwent', `getgrent', `gethostent', `getnetent', |
| 5270 | `getprotoent', and `getservent' functions now return #f at the end of |
| 5271 | the user database. (They used to throw an exception.) |
| 5272 | |
| 5273 | Note that calling MUMBLEent function is equivalent to calling the |
| 5274 | corresponding MUMBLE function with no arguments. |
| 5275 | |
| 5276 | *** The `setpwent', `setgrent', `sethostent', `setnetent', |
| 5277 | `setprotoent', and `setservent' routines now take no arguments. |
| 5278 | |
| 5279 | *** The `gethost', `getproto', `getnet', and `getserv' functions now |
| 5280 | provide more useful information when they throw an exception. |
| 5281 | |
| 5282 | *** The `lnaof' function has been renamed to `inet-lnaof'. |
| 5283 | |
| 5284 | *** Guile now claims to have the `current-time' feature. |
| 5285 | |
| 5286 | *** The `mktime' function now takes an optional second argument ZONE, |
| 5287 | giving the time zone to use for the conversion. ZONE should be a |
| 5288 | string, in the same format as expected for the "TZ" environment variable. |
| 5289 | |
| 5290 | *** The `strptime' function now returns a pair (TIME . COUNT), where |
| 5291 | TIME is the parsed time as a vector, and COUNT is the number of |
| 5292 | characters from the string left unparsed. This function used to |
| 5293 | return the remaining characters as a string. |
| 5294 | |
| 5295 | *** The `gettimeofday' function has replaced the old `time+ticks' function. |
| 5296 | The return value is now (SECONDS . MICROSECONDS); the fractional |
| 5297 | component is no longer expressed in "ticks". |
| 5298 | |
| 5299 | *** The `ticks/sec' constant has been removed, in light of the above change. |
| 5300 | |
| 5301 | * Changes to the gh_ interface |
| 5302 | |
| 5303 | ** gh_eval_str() now returns an SCM object which is the result of the |
| 5304 | evaluation |
| 5305 | |
| 5306 | ** gh_scm2str() now copies the Scheme data to a caller-provided C |
| 5307 | array |
| 5308 | |
| 5309 | ** gh_scm2newstr() now makes a C array, copies the Scheme data to it, |
| 5310 | and returns the array |
| 5311 | |
| 5312 | ** gh_scm2str0() is gone: there is no need to distinguish |
| 5313 | null-terminated from non-null-terminated, since gh_scm2newstr() allows |
| 5314 | the user to interpret the data both ways. |
| 5315 | |
| 5316 | * Changes to the scm_ interface |
| 5317 | |
| 5318 | ** The new function scm_symbol_value0 provides an easy way to get a |
| 5319 | symbol's value from C code: |
| 5320 | |
| 5321 | SCM scm_symbol_value0 (char *NAME) |
| 5322 | Return the value of the symbol named by the null-terminated string |
| 5323 | NAME in the current module. If the symbol named NAME is unbound in |
| 5324 | the current module, return SCM_UNDEFINED. |
| 5325 | |
| 5326 | ** The new function scm_sysintern0 creates new top-level variables, |
| 5327 | without assigning them a value. |
| 5328 | |
| 5329 | SCM scm_sysintern0 (char *NAME) |
| 5330 | Create a new Scheme top-level variable named NAME. NAME is a |
| 5331 | null-terminated string. Return the variable's value cell. |
| 5332 | |
| 5333 | ** The function scm_internal_catch is the guts of catch. It handles |
| 5334 | all the mechanics of setting up a catch target, invoking the catch |
| 5335 | body, and perhaps invoking the handler if the body does a throw. |
| 5336 | |
| 5337 | The function is designed to be usable from C code, but is general |
| 5338 | enough to implement all the semantics Guile Scheme expects from throw. |
| 5339 | |
| 5340 | TAG is the catch tag. Typically, this is a symbol, but this function |
| 5341 | doesn't actually care about that. |
| 5342 | |
| 5343 | BODY is a pointer to a C function which runs the body of the catch; |
| 5344 | this is the code you can throw from. We call it like this: |
| 5345 | BODY (BODY_DATA, JMPBUF) |
| 5346 | where: |
| 5347 | BODY_DATA is just the BODY_DATA argument we received; we pass it |
| 5348 | through to BODY as its first argument. The caller can make |
| 5349 | BODY_DATA point to anything useful that BODY might need. |
| 5350 | JMPBUF is the Scheme jmpbuf object corresponding to this catch, |
| 5351 | which we have just created and initialized. |
| 5352 | |
| 5353 | HANDLER is a pointer to a C function to deal with a throw to TAG, |
| 5354 | should one occur. We call it like this: |
| 5355 | HANDLER (HANDLER_DATA, THROWN_TAG, THROW_ARGS) |
| 5356 | where |
| 5357 | HANDLER_DATA is the HANDLER_DATA argument we recevied; it's the |
| 5358 | same idea as BODY_DATA above. |
| 5359 | THROWN_TAG is the tag that the user threw to; usually this is |
| 5360 | TAG, but it could be something else if TAG was #t (i.e., a |
| 5361 | catch-all), or the user threw to a jmpbuf. |
| 5362 | THROW_ARGS is the list of arguments the user passed to the THROW |
| 5363 | function. |
| 5364 | |
| 5365 | BODY_DATA is just a pointer we pass through to BODY. HANDLER_DATA |
| 5366 | is just a pointer we pass through to HANDLER. We don't actually |
| 5367 | use either of those pointers otherwise ourselves. The idea is |
| 5368 | that, if our caller wants to communicate something to BODY or |
| 5369 | HANDLER, it can pass a pointer to it as MUMBLE_DATA, which BODY and |
| 5370 | HANDLER can then use. Think of it as a way to make BODY and |
| 5371 | HANDLER closures, not just functions; MUMBLE_DATA points to the |
| 5372 | enclosed variables. |
| 5373 | |
| 5374 | Of course, it's up to the caller to make sure that any data a |
| 5375 | MUMBLE_DATA needs is protected from GC. A common way to do this is |
| 5376 | to make MUMBLE_DATA a pointer to data stored in an automatic |
| 5377 | structure variable; since the collector must scan the stack for |
| 5378 | references anyway, this assures that any references in MUMBLE_DATA |
| 5379 | will be found. |
| 5380 | |
| 5381 | ** The new function scm_internal_lazy_catch is exactly like |
| 5382 | scm_internal_catch, except: |
| 5383 | |
| 5384 | - It does not unwind the stack (this is the major difference). |
| 5385 | - If handler returns, its value is returned from the throw. |
| 5386 | - BODY always receives #f as its JMPBUF argument (since there's no |
| 5387 | jmpbuf associated with a lazy catch, because we don't unwind the |
| 5388 | stack.) |
| 5389 | |
| 5390 | ** scm_body_thunk is a new body function you can pass to |
| 5391 | scm_internal_catch if you want the body to be like Scheme's `catch' |
| 5392 | --- a thunk, or a function of one argument if the tag is #f. |
| 5393 | |
| 5394 | BODY_DATA is a pointer to a scm_body_thunk_data structure, which |
| 5395 | contains the Scheme procedure to invoke as the body, and the tag |
| 5396 | we're catching. If the tag is #f, then we pass JMPBUF (created by |
| 5397 | scm_internal_catch) to the body procedure; otherwise, the body gets |
| 5398 | no arguments. |
| 5399 | |
| 5400 | ** scm_handle_by_proc is a new handler function you can pass to |
| 5401 | scm_internal_catch if you want the handler to act like Scheme's catch |
| 5402 | --- call a procedure with the tag and the throw arguments. |
| 5403 | |
| 5404 | If the user does a throw to this catch, this function runs a handler |
| 5405 | procedure written in Scheme. HANDLER_DATA is a pointer to an SCM |
| 5406 | variable holding the Scheme procedure object to invoke. It ought to |
| 5407 | be a pointer to an automatic variable (i.e., one living on the stack), |
| 5408 | or the procedure object should be otherwise protected from GC. |
| 5409 | |
| 5410 | ** scm_handle_by_message is a new handler function to use with |
| 5411 | `scm_internal_catch' if you want Guile to print a message and die. |
| 5412 | It's useful for dealing with throws to uncaught keys at the top level. |
| 5413 | |
| 5414 | HANDLER_DATA, if non-zero, is assumed to be a char * pointing to a |
| 5415 | message header to print; if zero, we use "guile" instead. That |
| 5416 | text is followed by a colon, then the message described by ARGS. |
| 5417 | |
| 5418 | ** The return type of scm_boot_guile is now void; the function does |
| 5419 | not return a value, and indeed, never returns at all. |
| 5420 | |
| 5421 | ** The new function scm_shell makes it easy for user applications to |
| 5422 | process command-line arguments in a way that is compatible with the |
| 5423 | stand-alone guile interpreter (which is in turn compatible with SCSH, |
| 5424 | the Scheme shell). |
| 5425 | |
| 5426 | To use the scm_shell function, first initialize any guile modules |
| 5427 | linked into your application, and then call scm_shell with the values |
| 5428 | of ARGC and ARGV your `main' function received. scm_shell will add |
| 5429 | any SCSH-style meta-arguments from the top of the script file to the |
| 5430 | argument vector, and then process the command-line arguments. This |
| 5431 | generally means loading a script file or starting up an interactive |
| 5432 | command interpreter. For details, see "Changes to the stand-alone |
| 5433 | interpreter" above. |
| 5434 | |
| 5435 | ** The new functions scm_get_meta_args and scm_count_argv help you |
| 5436 | implement the SCSH-style meta-argument, `\'. |
| 5437 | |
| 5438 | char **scm_get_meta_args (int ARGC, char **ARGV) |
| 5439 | If the second element of ARGV is a string consisting of a single |
| 5440 | backslash character (i.e. "\\" in Scheme notation), open the file |
| 5441 | named by the following argument, parse arguments from it, and return |
| 5442 | the spliced command line. The returned array is terminated by a |
| 5443 | null pointer. |
| 5444 | |
| 5445 | For details of argument parsing, see above, under "guile now accepts |
| 5446 | command-line arguments compatible with SCSH..." |
| 5447 | |
| 5448 | int scm_count_argv (char **ARGV) |
| 5449 | Count the arguments in ARGV, assuming it is terminated by a null |
| 5450 | pointer. |
| 5451 | |
| 5452 | For an example of how these functions might be used, see the source |
| 5453 | code for the function scm_shell in libguile/script.c. |
| 5454 | |
| 5455 | You will usually want to use scm_shell instead of calling this |
| 5456 | function yourself. |
| 5457 | |
| 5458 | ** The new function scm_compile_shell_switches turns an array of |
| 5459 | command-line arguments into Scheme code to carry out the actions they |
| 5460 | describe. Given ARGC and ARGV, it returns a Scheme expression to |
| 5461 | evaluate, and calls scm_set_program_arguments to make any remaining |
| 5462 | command-line arguments available to the Scheme code. For example, |
| 5463 | given the following arguments: |
| 5464 | |
| 5465 | -e main -s ekko a speckled gecko |
| 5466 | |
| 5467 | scm_set_program_arguments will return the following expression: |
| 5468 | |
| 5469 | (begin (load "ekko") (main (command-line)) (quit)) |
| 5470 | |
| 5471 | You will usually want to use scm_shell instead of calling this |
| 5472 | function yourself. |
| 5473 | |
| 5474 | ** The function scm_shell_usage prints a usage message appropriate for |
| 5475 | an interpreter that uses scm_compile_shell_switches to handle its |
| 5476 | command-line arguments. |
| 5477 | |
| 5478 | void scm_shell_usage (int FATAL, char *MESSAGE) |
| 5479 | Print a usage message to the standard error output. If MESSAGE is |
| 5480 | non-zero, write it before the usage message, followed by a newline. |
| 5481 | If FATAL is non-zero, exit the process, using FATAL as the |
| 5482 | termination status. (If you want to be compatible with Guile, |
| 5483 | always use 1 as the exit status when terminating due to command-line |
| 5484 | usage problems.) |
| 5485 | |
| 5486 | You will usually want to use scm_shell instead of calling this |
| 5487 | function yourself. |
| 5488 | |
| 5489 | ** scm_eval_0str now returns SCM_UNSPECIFIED if the string contains no |
| 5490 | expressions. It used to return SCM_EOL. Earth-shattering. |
| 5491 | |
| 5492 | ** The macros for declaring scheme objects in C code have been |
| 5493 | rearranged slightly. They are now: |
| 5494 | |
| 5495 | SCM_SYMBOL (C_NAME, SCHEME_NAME) |
| 5496 | Declare a static SCM variable named C_NAME, and initialize it to |
| 5497 | point to the Scheme symbol whose name is SCHEME_NAME. C_NAME should |
| 5498 | be a C identifier, and SCHEME_NAME should be a C string. |
| 5499 | |
| 5500 | SCM_GLOBAL_SYMBOL (C_NAME, SCHEME_NAME) |
| 5501 | Just like SCM_SYMBOL, but make C_NAME globally visible. |
| 5502 | |
| 5503 | SCM_VCELL (C_NAME, SCHEME_NAME) |
| 5504 | Create a global variable at the Scheme level named SCHEME_NAME. |
| 5505 | Declare a static SCM variable named C_NAME, and initialize it to |
| 5506 | point to the Scheme variable's value cell. |
| 5507 | |
| 5508 | SCM_GLOBAL_VCELL (C_NAME, SCHEME_NAME) |
| 5509 | Just like SCM_VCELL, but make C_NAME globally visible. |
| 5510 | |
| 5511 | The `guile-snarf' script writes initialization code for these macros |
| 5512 | to its standard output, given C source code as input. |
| 5513 | |
| 5514 | The SCM_GLOBAL macro is gone. |
| 5515 | |
| 5516 | ** The scm_read_line and scm_read_line_x functions have been replaced |
| 5517 | by Scheme code based on the %read-delimited! procedure (known to C |
| 5518 | code as scm_read_delimited_x). See its description above for more |
| 5519 | information. |
| 5520 | |
| 5521 | ** The function scm_sys_open has been renamed to scm_open. It now |
| 5522 | returns a port instead of an FD object. |
| 5523 | |
| 5524 | * The dynamic linking support has changed. For more information, see |
| 5525 | libguile/DYNAMIC-LINKING. |
| 5526 | |
| 5527 | \f |
| 5528 | Guile 1.0b3 |
| 5529 | |
| 5530 | User-visible changes from Thursday, September 5, 1996 until Guile 1.0 |
| 5531 | (Sun 5 Jan 1997): |
| 5532 | |
| 5533 | * Changes to the 'guile' program: |
| 5534 | |
| 5535 | ** Guile now loads some new files when it starts up. Guile first |
| 5536 | searches the load path for init.scm, and loads it if found. Then, if |
| 5537 | Guile is not being used to execute a script, and the user's home |
| 5538 | directory contains a file named `.guile', Guile loads that. |
| 5539 | |
| 5540 | ** You can now use Guile as a shell script interpreter. |
| 5541 | |
| 5542 | To paraphrase the SCSH manual: |
| 5543 | |
| 5544 | When Unix tries to execute an executable file whose first two |
| 5545 | characters are the `#!', it treats the file not as machine code to |
| 5546 | be directly executed by the native processor, but as source code |
| 5547 | to be executed by some interpreter. The interpreter to use is |
| 5548 | specified immediately after the #! sequence on the first line of |
| 5549 | the source file. The kernel reads in the name of the interpreter, |
| 5550 | and executes that instead. It passes the interpreter the source |
| 5551 | filename as its first argument, with the original arguments |
| 5552 | following. Consult the Unix man page for the `exec' system call |
| 5553 | for more information. |
| 5554 | |
| 5555 | Now you can use Guile as an interpreter, using a mechanism which is a |
| 5556 | compatible subset of that provided by SCSH. |
| 5557 | |
| 5558 | Guile now recognizes a '-s' command line switch, whose argument is the |
| 5559 | name of a file of Scheme code to load. It also treats the two |
| 5560 | characters `#!' as the start of a comment, terminated by `!#'. Thus, |
| 5561 | to make a file of Scheme code directly executable by Unix, insert the |
| 5562 | following two lines at the top of the file: |
| 5563 | |
| 5564 | #!/usr/local/bin/guile -s |
| 5565 | !# |
| 5566 | |
| 5567 | Guile treats the argument of the `-s' command-line switch as the name |
| 5568 | of a file of Scheme code to load, and treats the sequence `#!' as the |
| 5569 | start of a block comment, terminated by `!#'. |
| 5570 | |
| 5571 | For example, here's a version of 'echo' written in Scheme: |
| 5572 | |
| 5573 | #!/usr/local/bin/guile -s |
| 5574 | !# |
| 5575 | (let loop ((args (cdr (program-arguments)))) |
| 5576 | (if (pair? args) |
| 5577 | (begin |
| 5578 | (display (car args)) |
| 5579 | (if (pair? (cdr args)) |
| 5580 | (display " ")) |
| 5581 | (loop (cdr args))))) |
| 5582 | (newline) |
| 5583 | |
| 5584 | Why does `#!' start a block comment terminated by `!#', instead of the |
| 5585 | end of the line? That is the notation SCSH uses, and although we |
| 5586 | don't yet support the other SCSH features that motivate that choice, |
| 5587 | we would like to be backward-compatible with any existing Guile |
| 5588 | scripts once we do. Furthermore, if the path to Guile on your system |
| 5589 | is too long for your kernel, you can start the script with this |
| 5590 | horrible hack: |
| 5591 | |
| 5592 | #!/bin/sh |
| 5593 | exec /really/long/path/to/guile -s "$0" ${1+"$@"} |
| 5594 | !# |
| 5595 | |
| 5596 | Note that some very old Unix systems don't support the `#!' syntax. |
| 5597 | |
| 5598 | |
| 5599 | ** You can now run Guile without installing it. |
| 5600 | |
| 5601 | Previous versions of the interactive Guile interpreter (`guile') |
| 5602 | couldn't start up unless Guile's Scheme library had been installed; |
| 5603 | they used the value of the environment variable `SCHEME_LOAD_PATH' |
| 5604 | later on in the startup process, but not to find the startup code |
| 5605 | itself. Now Guile uses `SCHEME_LOAD_PATH' in all searches for Scheme |
| 5606 | code. |
| 5607 | |
| 5608 | To run Guile without installing it, build it in the normal way, and |
| 5609 | then set the environment variable `SCHEME_LOAD_PATH' to a |
| 5610 | colon-separated list of directories, including the top-level directory |
| 5611 | of the Guile sources. For example, if you unpacked Guile so that the |
| 5612 | full filename of this NEWS file is /home/jimb/guile-1.0b3/NEWS, then |
| 5613 | you might say |
| 5614 | |
| 5615 | export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-1.0b3 |
| 5616 | |
| 5617 | |
| 5618 | ** Guile's read-eval-print loop no longer prints #<unspecified> |
| 5619 | results. If the user wants to see this, she can evaluate the |
| 5620 | expression (assert-repl-print-unspecified #t), perhaps in her startup |
| 5621 | file. |
| 5622 | |
| 5623 | ** Guile no longer shows backtraces by default when an error occurs; |
| 5624 | however, it does display a message saying how to get one, and how to |
| 5625 | request that they be displayed by default. After an error, evaluate |
| 5626 | (backtrace) |
| 5627 | to see a backtrace, and |
| 5628 | (debug-enable 'backtrace) |
| 5629 | to see them by default. |
| 5630 | |
| 5631 | |
| 5632 | |
| 5633 | * Changes to Guile Scheme: |
| 5634 | |
| 5635 | ** Guile now distinguishes between #f and the empty list. |
| 5636 | |
| 5637 | This is for compatibility with the IEEE standard, the (possibly) |
| 5638 | upcoming Revised^5 Report on Scheme, and many extant Scheme |
| 5639 | implementations. |
| 5640 | |
| 5641 | Guile used to have #f and '() denote the same object, to make Scheme's |
| 5642 | type system more compatible with Emacs Lisp's. However, the change |
| 5643 | caused too much trouble for Scheme programmers, and we found another |
| 5644 | way to reconcile Emacs Lisp with Scheme that didn't require this. |
| 5645 | |
| 5646 | |
| 5647 | ** Guile's delq, delv, delete functions, and their destructive |
| 5648 | counterparts, delq!, delv!, and delete!, now remove all matching |
| 5649 | elements from the list, not just the first. This matches the behavior |
| 5650 | of the corresponding Emacs Lisp functions, and (I believe) the Maclisp |
| 5651 | functions which inspired them. |
| 5652 | |
| 5653 | I recognize that this change may break code in subtle ways, but it |
| 5654 | seems best to make the change before the FSF's first Guile release, |
| 5655 | rather than after. |
| 5656 | |
| 5657 | |
| 5658 | ** The compiled-library-path function has been deleted from libguile. |
| 5659 | |
| 5660 | ** The facilities for loading Scheme source files have changed. |
| 5661 | |
| 5662 | *** The variable %load-path now tells Guile which directories to search |
| 5663 | for Scheme code. Its value is a list of strings, each of which names |
| 5664 | a directory. |
| 5665 | |
| 5666 | *** The variable %load-extensions now tells Guile which extensions to |
| 5667 | try appending to a filename when searching the load path. Its value |
| 5668 | is a list of strings. Its default value is ("" ".scm"). |
| 5669 | |
| 5670 | *** (%search-load-path FILENAME) searches the directories listed in the |
| 5671 | value of the %load-path variable for a Scheme file named FILENAME, |
| 5672 | with all the extensions listed in %load-extensions. If it finds a |
| 5673 | match, then it returns its full filename. If FILENAME is absolute, it |
| 5674 | returns it unchanged. Otherwise, it returns #f. |
| 5675 | |
| 5676 | %search-load-path will not return matches that refer to directories. |
| 5677 | |
| 5678 | *** (primitive-load FILENAME :optional CASE-INSENSITIVE-P SHARP) |
| 5679 | uses %seach-load-path to find a file named FILENAME, and loads it if |
| 5680 | it finds it. If it can't read FILENAME for any reason, it throws an |
| 5681 | error. |
| 5682 | |
| 5683 | The arguments CASE-INSENSITIVE-P and SHARP are interpreted as by the |
| 5684 | `read' function. |
| 5685 | |
| 5686 | *** load uses the same searching semantics as primitive-load. |
| 5687 | |
| 5688 | *** The functions %try-load, try-load-with-path, %load, load-with-path, |
| 5689 | basic-try-load-with-path, basic-load-with-path, try-load-module-with- |
| 5690 | path, and load-module-with-path have been deleted. The functions |
| 5691 | above should serve their purposes. |
| 5692 | |
| 5693 | *** If the value of the variable %load-hook is a procedure, |
| 5694 | `primitive-load' applies its value to the name of the file being |
| 5695 | loaded (without the load path directory name prepended). If its value |
| 5696 | is #f, it is ignored. Otherwise, an error occurs. |
| 5697 | |
| 5698 | This is mostly useful for printing load notification messages. |
| 5699 | |
| 5700 | |
| 5701 | ** The function `eval!' is no longer accessible from the scheme level. |
| 5702 | We can't allow operations which introduce glocs into the scheme level, |
| 5703 | because Guile's type system can't handle these as data. Use `eval' or |
| 5704 | `read-and-eval!' (see below) as replacement. |
| 5705 | |
| 5706 | ** The new function read-and-eval! reads an expression from PORT, |
| 5707 | evaluates it, and returns the result. This is more efficient than |
| 5708 | simply calling `read' and `eval', since it is not necessary to make a |
| 5709 | copy of the expression for the evaluator to munge. |
| 5710 | |
| 5711 | Its optional arguments CASE_INSENSITIVE_P and SHARP are interpreted as |
| 5712 | for the `read' function. |
| 5713 | |
| 5714 | |
| 5715 | ** The function `int?' has been removed; its definition was identical |
| 5716 | to that of `integer?'. |
| 5717 | |
| 5718 | ** The functions `<?', `<?', `<=?', `=?', `>?', and `>=?'. Code should |
| 5719 | use the R4RS names for these functions. |
| 5720 | |
| 5721 | ** The function object-properties no longer returns the hash handle; |
| 5722 | it simply returns the object's property list. |
| 5723 | |
| 5724 | ** Many functions have been changed to throw errors, instead of |
| 5725 | returning #f on failure. The point of providing exception handling in |
| 5726 | the language is to simplify the logic of user code, but this is less |
| 5727 | useful if Guile's primitives don't throw exceptions. |
| 5728 | |
| 5729 | ** The function `fileno' has been renamed from `%fileno'. |
| 5730 | |
| 5731 | ** The function primitive-mode->fdes returns #t or #f now, not 1 or 0. |
| 5732 | |
| 5733 | |
| 5734 | * Changes to Guile's C interface: |
| 5735 | |
| 5736 | ** The library's initialization procedure has been simplified. |
| 5737 | scm_boot_guile now has the prototype: |
| 5738 | |
| 5739 | void scm_boot_guile (int ARGC, |
| 5740 | char **ARGV, |
| 5741 | void (*main_func) (), |
| 5742 | void *closure); |
| 5743 | |
| 5744 | scm_boot_guile calls MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV. |
| 5745 | MAIN_FUNC should do all the work of the program (initializing other |
| 5746 | packages, reading user input, etc.) before returning. When MAIN_FUNC |
| 5747 | returns, call exit (0); this function never returns. If you want some |
| 5748 | other exit value, MAIN_FUNC may call exit itself. |
| 5749 | |
| 5750 | scm_boot_guile arranges for program-arguments to return the strings |
| 5751 | given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should call |
| 5752 | scm_set_program_arguments with the final list, so Scheme code will |
| 5753 | know which arguments have been processed. |
| 5754 | |
| 5755 | scm_boot_guile establishes a catch-all catch handler which prints an |
| 5756 | error message and exits the process. This means that Guile exits in a |
| 5757 | coherent way when system errors occur and the user isn't prepared to |
| 5758 | handle it. If the user doesn't like this behavior, they can establish |
| 5759 | their own universal catcher in MAIN_FUNC to shadow this one. |
| 5760 | |
| 5761 | Why must the caller do all the real work from MAIN_FUNC? The garbage |
| 5762 | collector assumes that all local variables of type SCM will be above |
| 5763 | scm_boot_guile's stack frame on the stack. If you try to manipulate |
| 5764 | SCM values after this function returns, it's the luck of the draw |
| 5765 | whether the GC will be able to find the objects you allocate. So, |
| 5766 | scm_boot_guile function exits, rather than returning, to discourage |
| 5767 | people from making that mistake. |
| 5768 | |
| 5769 | The IN, OUT, and ERR arguments were removed; there are other |
| 5770 | convenient ways to override these when desired. |
| 5771 | |
| 5772 | The RESULT argument was deleted; this function should never return. |
| 5773 | |
| 5774 | The BOOT_CMD argument was deleted; the MAIN_FUNC argument is more |
| 5775 | general. |
| 5776 | |
| 5777 | |
| 5778 | ** Guile's header files should no longer conflict with your system's |
| 5779 | header files. |
| 5780 | |
| 5781 | In order to compile code which #included <libguile.h>, previous |
| 5782 | versions of Guile required you to add a directory containing all the |
| 5783 | Guile header files to your #include path. This was a problem, since |
| 5784 | Guile's header files have names which conflict with many systems' |
| 5785 | header files. |
| 5786 | |
| 5787 | Now only <libguile.h> need appear in your #include path; you must |
| 5788 | refer to all Guile's other header files as <libguile/mumble.h>. |
| 5789 | Guile's installation procedure puts libguile.h in $(includedir), and |
| 5790 | the rest in $(includedir)/libguile. |
| 5791 | |
| 5792 | |
| 5793 | ** Two new C functions, scm_protect_object and scm_unprotect_object, |
| 5794 | have been added to the Guile library. |
| 5795 | |
| 5796 | scm_protect_object (OBJ) protects OBJ from the garbage collector. |
| 5797 | OBJ will not be freed, even if all other references are dropped, |
| 5798 | until someone does scm_unprotect_object (OBJ). Both functions |
| 5799 | return OBJ. |
| 5800 | |
| 5801 | Note that calls to scm_protect_object do not nest. You can call |
| 5802 | scm_protect_object any number of times on a given object, and the |
| 5803 | next call to scm_unprotect_object will unprotect it completely. |
| 5804 | |
| 5805 | Basically, scm_protect_object and scm_unprotect_object just |
| 5806 | maintain a list of references to things. Since the GC knows about |
| 5807 | this list, all objects it mentions stay alive. scm_protect_object |
| 5808 | adds its argument to the list; scm_unprotect_object remove its |
| 5809 | argument from the list. |
| 5810 | |
| 5811 | |
| 5812 | ** scm_eval_0str now returns the value of the last expression |
| 5813 | evaluated. |
| 5814 | |
| 5815 | ** The new function scm_read_0str reads an s-expression from a |
| 5816 | null-terminated string, and returns it. |
| 5817 | |
| 5818 | ** The new function `scm_stdio_to_port' converts a STDIO file pointer |
| 5819 | to a Scheme port object. |
| 5820 | |
| 5821 | ** The new function `scm_set_program_arguments' allows C code to set |
| 5822 | the value returned by the Scheme `program-arguments' function. |
| 5823 | |
| 5824 | \f |
| 5825 | Older changes: |
| 5826 | |
| 5827 | * Guile no longer includes sophisticated Tcl/Tk support. |
| 5828 | |
| 5829 | The old Tcl/Tk support was unsatisfying to us, because it required the |
| 5830 | user to link against the Tcl library, as well as Tk and Guile. The |
| 5831 | interface was also un-lispy, in that it preserved Tcl/Tk's practice of |
| 5832 | referring to widgets by names, rather than exporting widgets to Scheme |
| 5833 | code as a special datatype. |
| 5834 | |
| 5835 | In the Usenix Tk Developer's Workshop held in July 1996, the Tcl/Tk |
| 5836 | maintainers described some very interesting changes in progress to the |
| 5837 | Tcl/Tk internals, which would facilitate clean interfaces between lone |
| 5838 | Tk and other interpreters --- even for garbage-collected languages |
| 5839 | like Scheme. They expected the new Tk to be publicly available in the |
| 5840 | fall of 1996. |
| 5841 | |
| 5842 | Since it seems that Guile might soon have a new, cleaner interface to |
| 5843 | lone Tk, and that the old Guile/Tk glue code would probably need to be |
| 5844 | completely rewritten, we (Jim Blandy and Richard Stallman) have |
| 5845 | decided not to support the old code. We'll spend the time instead on |
| 5846 | a good interface to the newer Tk, as soon as it is available. |
| 5847 | |
| 5848 | Until then, gtcltk-lib provides trivial, low-maintenance functionality. |
| 5849 | |
| 5850 | \f |
| 5851 | Copyright information: |
| 5852 | |
| 5853 | Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. |
| 5854 | |
| 5855 | Permission is granted to anyone to make or distribute verbatim copies |
| 5856 | of this document as received, in any medium, provided that the |
| 5857 | copyright notice and this permission notice are preserved, |
| 5858 | thus giving the recipient permission to redistribute in turn. |
| 5859 | |
| 5860 | Permission is granted to distribute modified versions |
| 5861 | of this document, or of portions of it, |
| 5862 | under the above conditions, provided also that they |
| 5863 | carry prominent notices stating who last changed them. |
| 5864 | |
| 5865 | \f |
| 5866 | Local variables: |
| 5867 | mode: outline |
| 5868 | paragraph-separate: "[ \f]*$" |
| 5869 | end: |
| 5870 | |