diff options
| -rw-r--r-- | ANNOUNCE | 110 | ||||
| -rw-r--r-- | Bev2slib.scm | 58 | ||||
| -rw-r--r-- | ChangeLog | 520 | ||||
| -rw-r--r-- | FAQ | 20 | ||||
| -rw-r--r-- | Makefile | 129 | ||||
| -rw-r--r-- | README | 17 | ||||
| -rw-r--r-- | RScheme.init | 282 | ||||
| -rw-r--r-- | STk.init | 248 | ||||
| -rw-r--r-- | Template.scm | 28 | ||||
| -rw-r--r-- | alistab.scm | 15 | ||||
| -rw-r--r-- | arraymap.scm | 2 | ||||
| -rw-r--r-- | batch.scm | 151 | ||||
| -rw-r--r-- | bigloo.init | 248 | ||||
| -rw-r--r-- | chap.scm | 6 | ||||
| -rw-r--r-- | charplot.scm | 26 | ||||
| -rw-r--r-- | chez.init | 605 | ||||
| -rw-r--r-- | collect.scm | 10 | ||||
| -rw-r--r-- | comlist.scm | 22 | ||||
| -rw-r--r-- | cring.scm | 99 | ||||
| -rw-r--r-- | dbrowse.scm | 16 | ||||
| -rw-r--r-- | debian/changelog | 70 | ||||
| -rw-r--r-- | debian/control | 4 | ||||
| -rw-r--r-- | debian/postinst | 14 | ||||
| -rw-r--r-- | debian/postrm | 1 | ||||
| -rw-r--r-- | debian/prerm | 8 | ||||
| -rwxr-xr-x | debian/rules | 35 | ||||
| -rw-r--r-- | debug.scm | 6 | ||||
| -rw-r--r-- | elk.init | 27 | ||||
| -rw-r--r-- | factor.scm | 199 | ||||
| -rw-r--r-- | factor.txi | 73 | ||||
| -rw-r--r-- | fft.scm | 70 | ||||
| -rw-r--r-- | fluidlet.scm | 43 | ||||
| -rw-r--r-- | format.scm | 149 | ||||
| -rw-r--r-- | formatst.scm | 18 | ||||
| -rw-r--r-- | gambit.init | 42 | ||||
| -rw-r--r-- | glob.scm | 246 | ||||
| -rw-r--r-- | htmlform.scm | 294 | ||||
| -rw-r--r-- | htmlform.txi | 116 | ||||
| -rw-r--r-- | lineio.scm | 68 | ||||
| -rw-r--r-- | lineio.txi | 51 | ||||
| -rw-r--r-- | macscheme.init | 26 | ||||
| -rw-r--r-- | mbe.scm | 323 | ||||
| -rw-r--r-- | mitscheme.init | 32 | ||||
| -rw-r--r-- | mklibcat.scm | 11 | ||||
| -rw-r--r-- | mwexpand.scm | 46 | ||||
| -rw-r--r-- | mwsynrul.scm | 20 | ||||
| -rw-r--r-- | nclients.scm | 385 | ||||
| -rw-r--r-- | nclients.txi | 115 | ||||
| -rw-r--r-- | objdoc.txi | 238 | ||||
| -rw-r--r-- | object.scm | 97 | ||||
| -rw-r--r-- | paramlst.scm | 7 | ||||
| -rw-r--r-- | primes.scm | 187 | ||||
| -rw-r--r-- | printf.scm | 198 | ||||
| -rw-r--r-- | pscheme.init | 202 | ||||
| -rw-r--r-- | queue.scm | 2 | ||||
| -rw-r--r-- | randinex.scm | 96 | ||||
| -rw-r--r-- | randinex.txi | 74 | ||||
| -rw-r--r-- | random.scm | 167 | ||||
| -rw-r--r-- | random.txi | 69 | ||||
| -rw-r--r-- | rdms.scm | 42 | ||||
| -rw-r--r-- | recobj.scm | 55 | ||||
| -rw-r--r-- | require.scm | 67 | ||||
| -rw-r--r-- | root.scm | 66 | ||||
| -rw-r--r-- | sc4sc3.scm | 2 | ||||
| -rw-r--r-- | scanf.scm | 2 | ||||
| -rw-r--r-- | scheme2c.init | 29 | ||||
| -rw-r--r-- | scheme48.init | 31 | ||||
| -rw-r--r-- | schmooz.scm | 108 | ||||
| -rw-r--r-- | scsh.init | 12 | ||||
| -rw-r--r-- | sierpinski.scm | 2 | ||||
| -rw-r--r-- | slib.info | 11240 | ||||
| -rw-r--r-- | slib.texi | 1138 | ||||
| -rw-r--r-- | sort.scm | 2 | ||||
| -rw-r--r-- | strcase.scm | 2 | ||||
| -rw-r--r-- | strsrch.scm | 19 | ||||
| -rw-r--r-- | struct.scm | 6 | ||||
| -rw-r--r-- | t3.init | 31 | ||||
| -rw-r--r-- | timezone.scm | 13 | ||||
| -rw-r--r-- | tzfile.scm | 2 | ||||
| -rw-r--r-- | umbscheme.init | 263 | ||||
| -rw-r--r-- | version.txi | 2 | ||||
| -rw-r--r-- | vscm.init | 29 | ||||
| -rw-r--r-- | wttree.scm | 32 | ||||
| -rw-r--r-- | yasos.scm | 299 | ||||
| -rw-r--r-- | yasyn.scm | 201 |
85 files changed, 17452 insertions, 2684 deletions
@@ -1,93 +1,53 @@ -This message announces the availability of Scheme Library release -slib2c3. - -New in slib2c3 are filename matching (a la Bash glob) and `Schmooz', a -lightweight markup language for interspersing Texinfo documentation -with Scheme source code. - - * slib.texi (Filenames): documented pattern strings. - * Makefile: Added $srcdir to TEXINPUTS for TeX. - * slib.texi (Schmooz): Added documentation. - * Makefile (info htmlform.txi): made smarter about when to run - schmooz. - * slib.texi (Format): documentation moved to fmtdoc.txi. - * glob.scm (filename:match?? filename:match-ci??): aliases added. - * primes.scm (primes:prngs): added to reduce likelyhood of - reentrant random calls. - * random.scm: rewritten using new seedable RNG. - * randinex.scm (random:uniform): Rewritten for new RNG. - * primes.scm (primes:dbsp?): Now requires 'root and uses - integer-sqrt for sqrt on platforms not supporting inexacts. - * record.scm (rtd-name): Fixed so record rtds print. - * cring.scm (*): Number distribution requires separate treatment. - * factor.scm (prime:factor): (factor 0) now returns '(0) rather - than infinite-looping. - * cring.scm (*): Added check for (* -1 (- <expr>)) case. - * prec.scm (prec:warn): now takes arbitrary number of arguments. - (prec:nofix): - (prec:postfix): extra arguments are appended to the rules list; - not bound. - * qp.scm (qp:qp): *qp-width* set to #f now the same as *qp-width* - set to 0 -- the full expressions are printed. - * prec.scm (prec:nofix): Added . binds args, which are combined - with *syn-rules*. - - From: Radey Shouman <Radey_Shouman@splashtech.com> - - * glob.scm: Added. - * schmooz.scm (schmooz): Added @args markup command. - * schmooz.scm (schmooz): Now tries harder to determine whether a - definition is of a procedure or non-procedure variable. - Recognizes DEFMACRO, DEFINE-SYNTAX. - * schmooz.scm (scheme-args->macros): Now passed either a symbol, - for variable definition, or a possibly improper list, for - function/macro definition. For the variable definition case - generates @var{... for @0 instead of @code{... Now uses APPEND to - be more readable. - -SLIB is a portable scheme library meant to provide compatibiliy and -utility functions for all standard scheme implementations. - -SLIB includes initialization files for Chez, ELK 2.1, GAMBIT, -MacScheme, MITScheme, scheme->C, Scheme48, SCM, scsh, T3.1, and VSCM. +This message announces the availability of Scheme Library release slib2c7. + +New in slib2c7: + + * charplot.scm (charplot:number->string): printf %g gets rid of + microscopic fractions. + * printf.scm (%g): Make precision threshold work for both + fractions and integers. + * nclients.scm (browse-url-netscape): Try running netscape in + background. + * batch.scm (write-batch-line): Added slib:warn. + * paramlst.scm (check-parameters): Improved warning. + * batch.scm (batch:command): Renamed from batch:system. + (batch:try-command): Renamed from batch:try-system. + (batch:try-chopped-command): Added. + (batch:apply-chop-to-fit): Removed. + * glob.scm (replace-suffix): Now works. + * slib.texi: Put description and URL into slib_toc.html. + +SLIB is a portable Scheme library providing compatibiliy and utility +functions for all standard Scheme implementations. + +SLIB includes initialization files for Bigloo, Chez, ELK, GAMBIT, +MacScheme, MITScheme, PocketScheme, RScheme Scheme->C, Scheme48, SCM, +SCSH, T3.1, UMB-Scheme, and VSCM. Documentation includes a manifest, installation instructions, and coding standards for the library. Documentation of each library package is supplied. SLIB Documentation is online at: - http://www-swiss.ai.mit.edu/~jaffer/SLIB.html + http://swissnet.ai.mit.edu/~jaffer/SLIB.html -SLIB is a portable Scheme library: - ftp-swiss.ai.mit.edu:pub/scm/slib2c3.tar.gz - prep.ai.mit.edu:pub/gnu/jacal/slib2c3.tar.gz +SLIB source is available from: + http://swissnet.ai.mit.edu/ftpdir/scm/slib2c7.zip + ftp.gnu.org:pub/gnu/jacal/slib2c7.zip (FTP instructions follow) SLIB-PSD is a portable debugger for Scheme (requires emacs editor): - ftp-swiss.ai.mit.edu:pub/scm/slib-psd1-3.tar.gz - prep.ai.mit.edu:pub/gnu/jacal/slib-psd1-3.tar.gz + http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.zip + ftp.gnu.org:pub/gnu/jacal/slib-psd1-3.zip SCHELOG is an embedding of Prolog in Scheme+SLIB: http://www.cs.rice.edu/CS/PLT/packages/schelog/ Programs for printing and viewing TexInfo documentation (which SLIB has) come with GNU Emacs or can be obtained via ftp from: -prep.ai.mit.edu:pub/gnu/texinfo-3.1.tar.gz + ftp.gnu.org:pub/gnu/texinfo/texinfo-4.0.tar.gz -Files in these directories are compressed with patent-free gzip (no -relation to zip). The program to uncompress them is available from - prep.ai.mit.edu:pub/gnu/gzip-1.2.4.tar - prep.ai.mit.edu:pub/gnu/gzip-1.2.4.shar - prep.ai.mit.edu:pub/gnu/gzip-1.2.4.msdos.exe + -=-=- - ftp ftp-swiss.ai.mit.edu (anonymous) + ftp ftp.gnu.org (anonymous) bin - cd pub/scm - get slib2c3.tar.gz -or - ftp prep.ai.mit.edu (anonymous) cd pub/gnu/jacal - bin - get slib2c3.tar.gz - - `slib2c3.tar.gz' is a compressed tar file of a Scheme Library. - -Remember to use binary mode when transferring the *.tar.gz files. + get slib2c5.zip diff --git a/Bev2slib.scm b/Bev2slib.scm index 1198842..24a7c68 100644 --- a/Bev2slib.scm +++ b/Bev2slib.scm @@ -1,45 +1,21 @@ -;; Copyright (C) 1997 Free Software Foundation, Inc. -;; -;; This program is free software; you can redistribute it and/or modify -;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation; either version 2, or (at your option) -;; any later version. -;; -;; This program is distributed in the hope that it will be useful, -;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;; GNU General Public License for more details. -;; -;; You should have received a copy of the GNU General Public License -;; along with this software; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. -;; -;; As a special exception, the Free Software Foundation gives permission -;; for additional uses of the text contained in its release of GUILE. -;; -;; The exception is that, if you link the GUILE library with other files -;; to produce an executable, this does not by itself cause the -;; resulting executable to be covered by the GNU General Public License. -;; Your use of that executable is in no way restricted on account of -;; linking the GUILE library code into it. -;; -;; This exception does not however invalidate any other reasons why -;; the executable file might be covered by the GNU General Public License. -;; -;; This exception applies only to the code released by the -;; Free Software Foundation under the name GUILE. If you copy -;; code from other Free Software Foundation releases into a copy of -;; GUILE, as the General Public License permits, the exception does -;; not apply to the code that you add in this way. To avoid misleading -;; anyone as to the status of such modified files, you must delete -;; this exception notice from them. -;; -;; If you write modifications of your own for GUILE, it is your choice -;; whether to permit this exception to apply to your modifications. -;; If you do not wish that, delete this exception notice. - ;;;; "Bev2slib.scm" Build SLIB catalogs for Stephen Bevan's libraries. -;;; Author: Aubrey Jaffer. +;Copyright (C) 1998 Aubrey Jaffer +; +;Permission to copy this software, to redistribute it, and to use it +;for any purpose is granted, subject to the following restrictions and +;understandings. +; +;1. Any copy made of this software must include this copyright notice +;in full. +; +;2. I have made no warrantee or representation that the operation of +;this software will be error-free, and I am under no obligation to +;provide any services, by way of maintenance, update, or otherwise. +; +;3. In conjunction with products arising from the use of this +;material, there shall be no use of my name in any advertising, +;promotional, or sales literature without prior written consent in +;each case. ;;; Put this file into the implementation-vicinity directory for your ;;; scheme implementation. @@ -1,3 +1,471 @@ +Sun Dec 5 19:54:35 EST 1999 Aubrey Jaffer <jaffer@aubrey.jaffer> + + * require.scm (*SLIB-VERSION*): Bumped from 2c6 to 2c7. + +1999-12-04 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * charplot.scm (charplot:number->string): printf %g gets rid of + microscopic fractions. + + * printf.scm (%g): Make precision threshold work for both + fractions and integers. + +1999-12-03 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * nclients.scm (browse-url-netscape): Try running netscape in + background. + +1999-11-14 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * batch.scm (write-batch-line): Added slib:warn. + +1999-11-01 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * paramlst.scm (check-parameters): Improved warning. + +1999-10-31 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * batch.scm (batch:command): Renamed from batch:system. + (batch:try-command): Renamed from batch:try-system. + (batch:try-chopped-command): Added. + (batch:apply-chop-to-fit): Removed. + +1999-09-29 Radey Shouman <Radey_Shouman@splashtech.com> + + * glob.scm (replace-suffix): Now works. + +1999-09-17 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * slib.texi: Put description and URL into slib_toc.html. + +Sun Sep 12 22:45:01 EDT 1999 Aubrey Jaffer <jaffer@aubrey.jaffer> + + * require.scm (*SLIB-VERSION*): Bumped from 2c5 to 2c6. + +1999-07-08 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * format.scm (format:string-capitalize-first): Renamed from + string-capitalize-first. + (format:list-head): Renamed from list-head. + (string-index): Removed. + +1999-06-07 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:parse-float): Now handles strings representing + complex numbers in polar form. + + (stdio:parse-float): Now parses non-real numbers written in + rectangular form. + + (stdio:iprintf): Inexact formats work on non-real numbers assuming + NUMBER->STRING outputs a rectangular format. + + Inexact formats given a string or symbol rather than a number + output "???" if the string cannot be parsed as an inexact number. + +1999-06-06 Aubrey Jaffer <jaffer@ai.mit.edu> + + * fft.scm (fft fft-1): Added. + +1999-06-05 Radey Shouman <Radey_Shouman@splashtech.com> + + * glob.scm (glob:substitute??): (glob:substitute-ci??): Now accept + a procedure or string as template argument, for more general + transformations. + +1999-05-28 Gary T. Leavens <leavens@cs.iastate.edu> + + * chez.init: Updated for Chez Scheme 6.0a. + + * bigloo.init: Added. + +1999-05-18 Aubrey Jaffer <jaffer@ai.mit.edu> + + * printf.scm (stdio:iprintf): Extra arguments are *not* a bug. + +1999-05-08 Aubrey Jaffer <jaffer@ai.mit.edu> + + * lineio.scm (read-line!): fixed to eat trailing newline when line + length equals string length. + +1999-05-08 Ben Goetter <goetter@angrygraycat.com> + + * pscheme.init: String-ports added for version Pscheme 0.3.6. + +1999-05-07 <jaffer@super.jaffer> + + * charplot.scm (plot-function): Added. + (charplot:plot!): Now will accept array argument. + +1999-05-02 Jim Blandy <jimb@savonarola.red-bean.com> + + * format.scm (format:format): If the first argument is the format + string, stick a #f on the front of it, so it is now a valid CL + format argument list. This is easier than changing everyplace + else (like the error formatter) that expects it to be in CL form. + The other clause which explicitly tests for this case is now dead + code; remove it. + (format:format-work): Allow `@' and `:' in either order, as per + modern CL behavior. + (format:num->cardinal): Don't assume that an elseless if returns + '() when the condition is false. + +1999-04-22 Radey Shouman <Radey_Shouman@splashtech.com> + + * root.scm (secant:find-root): Replaced hack to decide on + accepting regula-falsi step with a modified regula-falsi in which + the weight of an "old" function value is repeatedly decreased each + time it is retained. + +1999-04-13 Radey Shouman <Radey_Shouman@splashtech.com> + + * root.scm (secant:find-root): Now checks that a step is actually + of nonzero length, otherwise small tolerances lead to not + stopping. Tuned for the case that one starting point is much + closer to the root than the other. + +1999-04-08 Ben Goetter <goetter@angrygraycat.com> + + * pscheme.init: updated with defmacro for version 0.3.3. + +1999-04-04 Aubrey Jaffer <jaffer@ai.mit.edu> + + * lineio.scm: Fixed @args command in documentation-comment. + +1999-03-27 Aubrey Jaffer <jaffer@ai.mit.edu> + + * strsrch.scm (find-string-from-port?): Fixed so procedure + argument is called at most once per character. + +1999-03-11 Radey Shouman <Radey_Shouman@splashtech.com> + + * fluidlet.scm: Added (require 'common-list-functions), for + MAKE-LIST. + +1999-03-08 Aubrey Jaffer <jaffer@ai.mit.edu> + + * RScheme.init, STk.init, Template.scm, chez.init, elk.init, + gambit.init, macscheme.init, mitscheme.init, pscheme.init, + scheme2c.init, scheme48.init, scsh.init, t3.init, vscm.init: Added + scheme-implementation-home-page definition + +1999-03-04 radey <radey@aubrey.jaffer> + + * root.scm (secant:find-bracketed-root): Added, requires (f x0) + and (f x1) to have opposite signs. + +1999-03-03 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:printf): Tweaks to %k format so that the + precision indicates the number of significant digits, as in %g + format. + +1999-03-02 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:printf): %k format now uses %f instead of %g + to format the scaled number. + + * root.scm (secant:find-root): Added. + +1999-02-25 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:iprintf): Fixed bug in %f format, + (printf "%.1f" 0.001) printed "0", now prints "0.0" + +1999-02-12 Hakan L. Younes <d93-hyo@nada.kth.se> + + * batch.scm, slib.texi: amiga-gcc port. + +1999-02-10 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:iprintf): K format now prints no prefix if + exponent is beyond the range of the specified prefixes. + + (stdio:iprintf): Added and corrected SI prefixes, ref + http://physics.nist.gov/cuu/Units/prefixes.html . + + (stdio:iprintf): Added numerical format specifiers %K and %k, + which format like %g, except that an SI prefix is output after the + number, which is scaled accordingly. %K outputs a space between + number and prefix, %k does not. It would be good to allow %f and + %e like formatting, but it's not clear how to fit this into the + format string syntax. + +1999-02-09 Aubrey Jaffer <jaffer@ai.mit.edu> + + * rdms.scm (domains:init-data): added number domain. + +1999-01-30 Matthew Flatt <mflatt@cs.rice.edu> + + * mbe.scm (hyg:untag-quasiquote): Added to fix quasiquote in output. + +1999-01-30 Dorai Sitaram <dorai@cs.rice.edu> + + * mbe.scm (mbe:ellipsis-sub-envs, mbe:append-map): Modified to fix + multiple ellipses problem. + +1999-01-26 Erick Gallesio <eg@unice.fr> + + * STk.init: The actual file. + +1999-01-25 Aubrey Jaffer <jaffer@ai.mit.edu> + + * RScheme.init: added; content is from + http://www.rscheme.org/rs/pg1/RScheme.scm + +1999-01-24 Aubrey Jaffer <jaffer@ai.mit.edu> + + * STk.init: added; content is from + http://kaolin.unice.fr/STk/FAQ/FAQ-1.html#ss1.9 + +1999-01-23 Aubrey Jaffer <jaffer@ai.mit.edu> + + * alistab.scm (open-base): Check file exists before opening it. + +1999-01-21 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * htmlform.scm (html:start-page): Extra arguments printed in HEAD + (for META tags). + +1999-01-20 Aubrey Jaffer <jaffer@ai.mit.edu> + + * htmlform.scm (make-atval make-plain): use object->string for + non-atomic arguments. + +1999-01-19 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:iprintf): Now reports wrong number of + arguments instead of silently ignoring extra arguments or taking + the CAR of the empty list. + +Sun Jan 17 12:33:31 EST 1999 Aubrey Jaffer <jaffer@aubrey.jaffer> + + * require.scm (*SLIB-VERSION*): Bumped from 2c4 to 2c5. + +1999-01-12 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * mitscheme.init (char-code-limit): Added. Builtin + char-code-limit is 65536 (NOT!) in MITScheme Version 8.0. + +1999-01-11 Aubrey Jaffer <jaffer@ai.mit.edu> + + * batch.scm (batch:apply-chop-to-fit): fixed off-by-1 error. + +1999-01-10 Aubrey Jaffer <jaffer@ai.mit.edu> + + * randinex.scm: moved (schmooz) documentation here from scm.texi. + (random:uniform1): Renamed from random:uniform. + (random:uniform): Added (takes optional state argument). + (random:normal): Made reentrant. + + * random.scm: moved (schmooz) documentation here from scm.texi. + +1999-01-09 Aubrey Jaffer <jaffer@ai.mit.edu> + + * random.scm (seed->random-state): added. + +1999-01-08 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * mitscheme.init (object->limited-string): Added. + + * random.scm (random:random): Fixed embarrassingly stupid bug. + +1999-01-07 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * alistab.scm (supported-key-type?): number now allowed. + +1998-12-22 Radey Shouman <Radey_Shouman@splashtech.com> + + * printf.scm (stdio:round-string): Makes sure result has at least + STRIP-0S characters after the implied decimal point if STRIP-0S is + not false. Fixes bug associated with engineering notation in SCM. + +1998-12-18 Aubrey Jaffer <jaffer@ai.mit.edu> + + * schmooz.scm (schmooz): Converted from replace-suffix to + filename:substitute??. + +1998-12-16 Radey Shouman <Radey_Shouman@splashtech.com> + + * glob.scm (glob:make-substituter): Made to handle cases where + PATTERN and TEMPLATE have different numbers of literal sections. + + * glob.scm (glob:pattern->tokens): (glob:make-matcher): + (glob:make-substituter): Fixed to accept null strings as literals + to match, for REPLACE-SUFFIX. There is no way to write a glob + pattern that produces such a token, should there be? + +1998-12-15 Radey Shouman <Radey_Shouman@splashtech.com> + + * glob.scm (glob:substitute??) renamed from glob:transform?? + (filename:substitute??) identical to glob:substitute?? + +1998-12-14 Radey Shouman <Radey_Shouman@splashtech.com> + + * glob.scm (glob:pattern->tokens): Separated from + GLOB:MAKE-MATCHER. + (glob:make-transformer): + (glob:transform??): + (glob:transform-ci??): Added. + (replace-suffix): Rewritten using GLOB:TRANSFORM?? + +1998-12-09 Aubrey Jaffer <jaffer@ai.mit.edu> + + * yasyn.scm: Restored to SLIB. yasos.scm removed. + * object.scm: Restored to SLIB + * recobj.scm: Restored to SLIB + +1998-12-08 Aubrey Jaffer <jaffer@ai.mit.edu> + + * slib.texi (Copyrights): Added HTML anchor for Copying information. + (Installation): Added HTML anchor for Installation instructions. + +1998-12-02 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * fluidlet.scm (fluid-let): Rewritten as defmacro. + +1998-11-30 Radey Shouman <Radey_Shouman@splashtech.com> + + * fluidlet.scm (fluid-let): Changed macro definition so that it + doesn't depend on being able to combine input from two different + ellipsis patterns. Now produces a nice expansion with + macro-by-example so that one can see exactly what goes wrong. + +1998-11-29 Aubrey Jaffer <jaffer@ai.mit.edu> + + * htmlform.scm (table->html): Table conversion functions added. + +1998-11-27 Aubrey Jaffer <jaffer@ai.mit.edu> + + * nclients.scm (glob-pattern?): Added. + +1998-11-24 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * htmlform.scm (html:href-heading): simplified. + +1998-11-16 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * htmlform.scm (html:comment): No longer puts `>' alone on line. + (make-plain make-atval): renamed from html:plain and html:atval; + html: functions now all output HTML. + + * nclients.scm (user-email-address): Ported to W95 and WNT. + (make-directory): added. + + * dbrowse.scm (browse:display-table): Column-foreigns restored. + + * htmlform.scm (html:atval html:plain): Now accept numbers. + (html:pre): Added. + (html:start-page html:end-page): Updated to HTML 3.2. HTML header + added. + + * rdms.scm (make-relational-system): column-foreign-list split + into column-foreign-check-list and column-foreign-list. + +1998-11-12 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * lineio.scm (display-file): added. Schmoozed docs. + +1998-11-12 Radey Shouman <Radey_Shouman@splashtech.com> + + * schmooz.scm (schmooz-top): No longer emits @defun lines for + definitions not separated by blank lines unless they have + associated @body comment lines. + +1998-11-11 Radey Shouman <Radey_Shouman@splashtech.com> + + * fluidlet.scm (fluid-let): Redone to restore variable values even + if a continuation captured in the body is invoked. Now agrees + with MIT Scheme documentation. + +1998-11-11 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * nclients.scm: Added net-clients. + + * require.scm (vicinity:suffix?): Abstracted from + program-vicinity. + +1998-11-04 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * comlist.scm (remove-duplicates): added. + (adjoin): memq -> memv. + +Tue Nov 3 17:47:32 EST 1998 Aubrey Jaffer <jaffer@scm.colorage.net> + + * require.scm (*SLIB-VERSION*): Bumped from 2c3 to 2c4. + +1998-10-24 Aubrey Jaffer <jaffer@ai.mit.edu> + + * cring.scm: Added procedures to create and manipulate rulesets. + + * cring.scm (cring:db): Distributing / over + led to infinite + loops. Now only distribute *. + +1998-10-19 amu@mit.edu + + * timezone.scm (tzfile:vicinity): Linux RH 5.x moved zoneinfo to + /usr/share and didn't bother to leave a symlink behind. This + caused ctime to print out things in GMT, instead of using the + local time. + +1998-10-01 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * factor.scm: Moved documentation to schmooz format. + (prime:prime< prime:prime>): written. + (prime:prngs): added. + (Solovay-Strassen??): No longer tries `1'. + (prime:products): Added list of prime products smaller than + most-positive-fixnum. + (prime:sieve): added to test for primes smaller than largest prime + in prime:products. + (prime:factor): wrapper rewritten. Code cleaned up. + + * primes.scm: removed. + +1998-09-29 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * paramlst.scm (check-parameters): Now generates slib:warn when + parameter is wrong type. + + * debug.scm (for-each-top-level-definition-in-file): Now discards + `magic-number' first line of files when first character is `#'. + + * batch.scm (batch:port parms): enabled warning. + +1998-09-28 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * scheme2c.init scsh.init t3.init chez.init, vscm.init, + scheme48.init, mitscheme.init, macscheme.init, gambit.init, + elk.init, Template.scm: Placed in public domain to make + distributing modified versions easier. + + * schmooz.scm, htmlform.scm, admin.scm, glob.scm, ChangeLog: + Cleaned a bit. + +1998-09-28 Aubrey Jaffer <aubrey_jaffer@splashtech.com> + + * slib.texi (most-positive-fixnum): fixed description. + +1998-09-22 Ortwin Gasper <gasper@sensecom.de> + + * random.scm (random:random): Removed one-parameter call to + logand. + +1998-09-22 Radey Shouman <Radey_Shouman@splashtech.com> + + * schmooz.scm: Changed all references to #\nl to #\newline. + Removed all references to #\cr. Trailing whitespace no longer + prevents issuing a defunx for an additional definition form. + +1998-09-21 Aubrey Jaffer <jaffer@ai.mit.edu> + + * primes.scm: Eliminated use of 1+. + (probably-prime?): #f for negative numbers. + +1998-09-19 Jorgen Schaefer <forcer@mindless.com> + + * glob.scm (glob:match?? glob:match-ci??): fixed wrappers. + 1998-09-11 Aubrey Jaffer <jaffer@colorage.com> * Makefile (release): Uploads SLIB.html. @@ -17,7 +485,7 @@ * schmooz.scm (schmooz): Now tries harder to determine whether a definition is of a procedure or non-procedure variable. Recognizes DEFMACRO, DEFINE-SYNTAX. - + 1998-09-06 Aubrey Jaffer <jaffer@ai.mit.edu> * slib.texi (Schmooz): Added documentation. @@ -79,7 +547,7 @@ 1998-07-08 Aubrey Jaffer <jaffer@colorage.com> * prec.scm (prec:warn): now takes arbitrary number of arguments. - (prec:nofix): + (prec:nofix): (prec:postfix): extra arguments are appended to the rules list; not bound. @@ -98,7 +566,7 @@ 1998-06-08 Aubrey Jaffer <jaffer@colorage.com> * htmlform.scm (html:start-form): added rest of METHOD types. - (html:generate-form command->html): regularized argument order to + (html:generate-form command->html): regularized argument order to `command method action'. * dbutil.scm (add-domain): Changed from row:insert to row:update. @@ -142,7 +610,7 @@ o * require.scm (*SLIB-VERSION*): Bumped from 2c1 to 2c2. * schmooz.scm: Texinfo document generator for Scheme programs. 1998-06-02 Aubrey Jaffer <jaffer@colorage.com> - + * htmlform.scm: Added documentation. (http:send-error-page): scope of fluid-let was wrong. @@ -210,7 +678,7 @@ Tue Apr 14 16:28:20 EDT 1998 Aubrey Jaffer <jaffer@scm.colorage.net> 1998-02-11 Aubrey Jaffer <jaffer@colorage.com> - * slib.texi (Top): + * slib.texi (Top): (Extra-SLIB Packages): Converted to use of new texinfo feature @url. @@ -328,7 +796,7 @@ Wed Oct 29 22:49:15 1997 Aubrey Jaffer <jaffer@martigny.ai.mit.edu> vicinities. Thu Oct 23 23:14:33 1997 Eric Marsden <marsden@salines.cict.fr> - + * factor.scm (prime:product): added EXACT? test. Mon Oct 20 19:33:41 1997 Aubrey Jaffer <jaffer@martigny.ai.mit.edu> @@ -544,8 +1012,8 @@ Sat Feb 22 10:18:36 1997 Aubrey Jaffer <jaffer@martigny.ai.mit.edu> system is not provided. (system:success?): added. - * wttree.scm (error): - (error:wrong-type-argument): + * wttree.scm (error): + (error:wrong-type-argument): (error:bad-range-argument): Stubs added for non-MITScheme implementations. @@ -650,9 +1118,9 @@ Mon Feb 19 15:48:06 1996 Aubrey Jaffer <jaffer@jacal.bertronics> * scanf.scm (stdio:scan-and-set): Removed flush-whitespace from all conversion specifications per suggestion from - oleg@mozart.compsci.com (Oleg Kiselyov). + oleg@acm.org (Oleg Kiselyov). -Sat Feb 3 00:02:06 1996 Oleg Kiselyov (oleg@ponder.csci.unt.edu) +Sat Feb 3 00:02:06 1996 Oleg Kiselyov (oleg@acm.org) * strsrch.scm (string-index substring? find-string-from-port?): added. @@ -797,17 +1265,17 @@ Sat Feb 25 01:05:25 1995 Aubrey Jaffer (jaffer@jacal) Sun Feb 5 16:34:03 1995 Aubrey Jaffer (jaffer@jacal) - * paramlst.scm ((make-parameter-list parameter-names)): - ((fill-empty-parameters defaults parameter-list)): - ((check-parameters checks parameter-list)): - ((parameter-list->arglist positions arities parameter-list)): - ((parameter-list-ref parameter-list i)): - ((adjoin-parameters! parameter-list parameters)): + * paramlst.scm ((make-parameter-list parameter-names)): + ((fill-empty-parameters defaults parameter-list)): + ((check-parameters checks parameter-list)): + ((parameter-list->arglist positions arities parameter-list)): + ((parameter-list-ref parameter-list i)): + ((adjoin-parameters! parameter-list parameters)): Procedures for making, merging, defaulting, checking and converting `parameter lists' (named parameters). - ((getopt->parameter-list argc argv optnames arities aliases)): + ((getopt->parameter-list argc argv optnames arities aliases)): ((getopt->arglist argc argv optnames positions - arities defaults checks aliases)): + arities defaults checks aliases)): Procedures for converting options and arguments processed by getopt to parameter-list or arglist form. @@ -884,7 +1352,7 @@ Sat Dec 17 12:10:02 1994 Aubrey Jaffer (jaffer@jacal) `expression' fields no longer done when retrieved from base tables (which made copying of many tables impossible). - * alistab.scm + * alistab.scm (write-base): rewrote to not use pretty-print. * sc3.scm: removed (only contained last-pair, t, and nil). @@ -965,7 +1433,7 @@ Tue Aug 2 10:44:32 1994 Aubrey Jaffer (jaffer@jacal) Sun Jul 31 21:39:54 1994 Aubrey Jaffer (jaffer@jacal) * cltime.scm (get-decoded-time get-universal-time - decode-universal-time encode-universal-time): + decode-universal-time encode-universal-time): Common-Lisp time conversion routines created. * time.scm (*timezone* tzset gmtime localtime mktime asctime ctime): @@ -1056,7 +1524,7 @@ Sat Apr 9 21:28:46 1994 Aubrey Jaffer (jaffer@jacal) Wed Apr 6 00:55:16 1994 Aubrey Jaffer (jaffer@jacal) * require.scm (slib:report): - (slib:report-version): + (slib:report-version): (slib:report-locations): added to display SLIB configuration information. @@ -1094,7 +1562,7 @@ Thu Mar 3 23:06:41 1994 Aubrey Jaffer (jaffer@jacal) * format.scm slib.texi: Format 3.0. * format's configuration is rearranged to fit only into SLIB. All implementation dependent configurations are done in the SLIB init files - * format's output routines rely on call-with-output-string now if + * format's output routines rely on call-with-output-string now if output to a string is desired * The floating point formatting code (formatfl.scm) moved into format.scm so that there is only one source code file; this @@ -1104,7 +1572,7 @@ Thu Mar 3 23:06:41 1994 Aubrey Jaffer (jaffer@jacal) procedure except number->string now; all formatting is now based solely on string, character and integer manipulations * major rewrite of the floating point formatting code; use global - buffers now + buffers now * ~f,~e,~g, ~$ may use also number strings as an argument * ~r, ~:r, ~@r, ~:@r roman numeral, and ordinal and cardinal English number printing added (from dorai@cs.rice.edu) @@ -1118,7 +1586,7 @@ Thu Mar 3 23:06:41 1994 Aubrey Jaffer (jaffer@jacal) * ~:c prints control characters like emacs (eg. ^C) and 8bit characters as an octal number * ~q gives information and copyright notice on this format implementation - ~:q gives format:version + ~:q gives format:version * case type of symbol conversion can now be forced (see format:symbol-case-conv in format.scm) * case type of the representation of internal objects can now be @@ -1131,7 +1599,7 @@ Thu Mar 3 23:06:41 1994 Aubrey Jaffer (jaffer@jacal) * if format's destination is a string it is regarded as a format string now and output is the current output port; this is a contribution to Scheme->C to use format with the runtime system; the former semantics - to append tothe destination string is given up + to append tothe destination string is given up * obj->string syntax change and speedup * tested with scm4d, Elk 2.2, MIT Scheme 7.1, Scheme->C 01Nov91 @@ -1606,7 +2074,7 @@ Sat Jun 13 17:01:41 1992 Aubrey Jaffer (jaffer at Ivan) * hash.scm hashtab.scm scheme48.init: added. * sc-macro.scm (macro:repl): created. macro:load now uses - eval:eval!. + eval:eval!. * eval.scm (eval:eval!) created and eval done in terms of it. @@ -1,5 +1,5 @@ -FAQ (Frequently Asked Questions and answers) for SLIB Scheme Library (slib2c3). -Written by Aubrey Jaffer (http://www-swiss.ai.mit.edu/~jaffer). +FAQ (Frequently Asked Questions and answers) for SLIB Scheme Library (slib2c7). +Written by Aubrey Jaffer (http://swissnet.ai.mit.edu/~jaffer). INTRODUCTION AND GENERAL INFORMATION @@ -14,14 +14,16 @@ Scheme is a programming language in the Lisp family. [] Which implementations has SLIB been ported to? -SLIB is supported by Chez, ELK 2.1, GAMBIT, MacScheme, MITScheme, -scheme->C, Scheme48, T3.1, SCM and VSCM +SLIB is supported by Bigloo, Chez, ELK, GAMBIT, MacScheme, MITScheme, +PocketScheme, RScheme Scheme->C, Scheme48, SCM, SCSH, T3.1, +UMB-Scheme, and VSCM. [] How can I obtain SLIB? +SLIB is available via http from: + http://swissnet.ai.mit.edu/~jaffer/SLIB.html SLIB is available via ftp from: - ftp-swiss.ai.mit.edu:pub/scm/slib2c3.tar.gz - prep.ai.mit.edu:pub/gnu/jacal/slib2c3.tar.gz + ftp.gnu.org:pub/gnu/jacal/ SLIB is also included with SCM floppy disks. @@ -38,7 +40,7 @@ or `info' or a text editor. Programs for printing and viewing TexInfo documentation (which SLIB has) come with GNU Emacs or can be obtained via ftp from: -prep.ai.mit.edu:pub/gnu/texinfo-3.1.tar.gz + ftp.gnu.org:/pub/gnu/texinfo/texinfo-3.12.tar.gz [] How often is SLIB released? @@ -46,9 +48,9 @@ Several times a year. [] What is the latest version? -The version as of this writing is slib2c3. The latest documentation +The version as of this writing is slib2c7. The latest documentation is available online at: - http://www-swiss.ai.mit.edu/~jaffer/SLIB.html + http://swissnet.ai.mit.edu/~jaffer/SLIB.html [] Which version am I using? @@ -13,7 +13,7 @@ intro: srcdir=$(HOME)/slib/ dvidir=../dvi/ dvi: $(dvidir)slib.dvi -$(dvidir)slib.dvi: $(srcdir)slib.texi $(dvidir)slib.fn +$(dvidir)slib.dvi: version.txi slib.texi $(dvidir)slib.fn # cd $(dvidir);export TEXINPUTS=$(srcdir):;texi2dvi $(srcdir)slib.texi -(cd $(dvidir);export TEXINPUTS=$(srcdir):;texindex slib.??) cd $(dvidir);export TEXINPUTS=$(srcdir):;tex $(srcdir)slib.texi @@ -22,9 +22,16 @@ $(dvidir)slib.fn: xdvi: $(dvidir)slib.dvi xdvi -s 6 $(dvidir)slib.dvi htmldir=../public_html/ +slib_toc.html: version.txi slib.texi + texi2html -split -verbose slib.texi + +slib/slib_toc.html: + cd slib;make slib_toc.html + cd slib;texi2html -split -verbose slib.texi + html: $(htmldir)slib_toc.html -$(htmldir)slib_toc.html: $(srcdir)slib.texi - cd $(htmldir);make slib_toc.html +$(htmldir)slib_toc.html: slib slib_toc.html Makefile + hitch slib/slib_\*.html slib_\*.html $(htmldir) prefix = debian/tmp/usr exec_prefix = $(prefix) @@ -91,28 +98,38 @@ install48: slib48 (echo '#!/bin/sh'; \ echo exec $(RUNNABLE) -i '$(LIB)/$(IMAGE)' \"\$$\@\") \ > $(bindir)/slib48 - chmod +x $(bindir)/slib48 + chmod +x $(bindir)/slib48 + +#### Stuff for maintaining SLIB below #### + +VERSION = 2c7 +ver = $(VERSION) +version.txi: Makefile + echo @set SLIBVERSION $(VERSION) > version.txi + echo @set SLIBDATE `date +"%B %Y"` >> version.txi scheme = scm htmlform.txi: *.scm $(scheme) -rschmooz -e'(schmooz "slib.texi")' - -info: $(infodir)/slib.info - -slib.info: slib.texi htmlform.txi - makeinfo slib.texi -o slib.info -# /usr/sbin/install-info $(infodir)/slib.info $(infodir)/dir -# -rm $(infodir)/slib.info*.gz - -infoz: $(infodir)/slib.info.gz +slib$(VERSION).info: version.txi slib.texi htmlform.txi objdoc.txi + -mv slib.info slibtemp.info + makeinfo slib.texi --no-split -o slib.info + mv slib.info slib$(VERSION).info + -mv slibtemp.info slib.info +slib.info: slib$(VERSION).info +# infobar slib/slib.info slib$(VERSION).info slib.info +info: installinfo +installinfo: $(infodir)/slib.info +$(infodir)/slib.info: slib.info + cp -a slib.info $(infodir)/slib.info + -install-info $(infodir)/slib.info $(infodir)/dir + -rm $(infodir)/slib.info.gz +infoz: installinfoz +installinfoz: $(infodir)/slib.info.gz $(infodir)/slib.info.gz: $(infodir)/slib.info - gzip -f $(infodir)/slib.info* - -#### Stuff for maintaining SLIB below #### + gzip -f $(infodir)/slib.info -VERSION = 2c3 -ver = $(VERSION) ffiles = printf.scm format.scm genwrite.scm obj2str.scm pp.scm \ ppfile.scm strcase.scm debug.scm trace.scm lineio.scm \ strport.scm scanf.scm chap.scm qp.scm break.scm stdio.scm \ @@ -121,10 +138,10 @@ lfiles = sort.scm comlist.scm tree.scm logical.scm random.scm tsort.scm revfiles = sc4opt.scm sc4sc3.scm sc2.scm mularg.scm mulapply.scm \ trnscrpt.scm withfile.scm dynwind.scm promise.scm values.scm \ eval.scm -afiles = ratize.scm randinex.scm modular.scm primes.scm factor.scm \ +afiles = ratize.scm randinex.scm modular.scm factor.scm \ charplot.scm root.scm cring.scm determ.scm selfset.scm \ psxtime.scm cltime.scm timezone.scm tzfile.scm -bfiles = collect.scm fluidlet.scm struct.scm yasos.scm +bfiles = collect.scm fluidlet.scm struct.scm object.scm recobj.scm yasyn.scm scfiles = r4rsyn.scm scmacro.scm synclo.scm synrul.scm synchk.scm \ repl.scm macwork.scm mwexpand.scm mwdenote.scm mwsynrul.scm scafiles = scainit.scm scaglob.scm scamacr.scm scaoutp.scm scaexpp.scm \ @@ -133,17 +150,19 @@ dfiles = defmacex.scm mbe.scm efiles = record.scm dynamic.scm queue.scm process.scm \ priorque.scm hash.scm hashtab.scm alist.scm \ wttree.scm wttest.scm array.scm arraymap.scm \ - sierpinski.scm soundex.scm byte.scm + sierpinski.scm soundex.scm byte.scm nclients.scm rfiles = rdms.scm alistab.scm dbutil.scm paramlst.scm report.scm \ batch.scm makcrc.scm dbrowse.scm comparse.scm getopt.scm \ - htmlform.scm getparam.scm glob.scm + htmlform.scm getparam.scm glob.scm fft.scm gfiles = tek40.scm tek41.scm -docfiles = ANNOUNCE README FAQ ChangeLog slib.texi fmtdoc.txi +docfiles = ANNOUNCE README FAQ slib.info slib.texi objdoc.txi fmtdoc.txi \ + ChangeLog mfiles = Makefile require.scm Template.scm syncase.sh mklibcat.scm \ Bev2slib.scm -ifiles = chez.init elk.init macscheme.init \ - mitscheme.init scheme2c.init scheme48.init gambit.init t3.init \ - vscm.init mitcomp.pat scm.init scsh.init +ifiles = bigloo.init chez.init elk.init macscheme.init \ + mitscheme.init scheme2c.init scheme48.init gambit.init t3.init \ + vscm.init mitcomp.pat scm.init scsh.init pscheme.init STk.init \ + RScheme.init umbscheme.init tfiles = plottest.scm formatst.scm macrotst.scm scmactst.scm \ dwindtst.scm structst.scm sfiles = $(ffiles) $(lfiles) $(revfiles) $(afiles) $(scfiles) $(efiles) \ @@ -152,6 +171,7 @@ allfiles = $(docfiles) $(mfiles) $(ifiles) $(sfiles) $(tfiles) $(bfiles) makedev = make -f $(HOME)/makefile.dev CHPAT=$(HOME)/bin/chpat +RSYNC=rsync -v --rsync-path bin/rsync dest = $(HOME)/dist/ temp/slib: $(allfiles) -rm -rf temp @@ -164,22 +184,40 @@ infotemp/slib: slib.info mkdir infotemp mkdir infotemp/slib ln slib.info slib.info-* infotemp/slib +#For change-barred HTML. +slib: + unzip -a $(dest)slib[0-9]*.zip -distinfo: $(dest)slib.info.tar.gz -$(dest)slib.info.tar.gz: infotemp/slib - $(makedev) TEMP=infotemp/ DEST=$(dest) PROD=slib ver=.info tar.gz +distinfo: $(dest)slib.info.zip +$(dest)slib.info.zip: infotemp/slib + $(makedev) TEMP=infotemp/ DEST=$(dest) PROD=slib ver=.info zip rm -rf infotemp release: dist - rsync -v $(htmldir)SLIB.html martigny.ai.mit.edu:public_html/ - rsync -v $(dest)README $(dest)slib$(VERSION).tar.gz martigny.ai.mit.edu:dist/ - upload $(dest)README $(dest)slib$(VERSION).tar.gz prep.ai.mit.edu:gnu/jacal/ + cp $(srcdir)ANNOUNCE $(htmldir)SLIB_ANNOUNCE + $(RSYNC) $(htmldir)SLIB.html $(htmldir)SLIB_ANNOUNCE nestle.ai.mit.edu:public_html/ + $(RSYNC) $(dest)README $(dest)slib$(VERSION).zip nestle.ai.mit.edu:dist/ +# upload $(dest)README $(dest)slib$(VERSION).zip ftp.gnu.org:gnu/jacal/ +# $(MAKE) indiana +indiana: + upload $(dest)slib$(VERSION).zip ftp@ftp.cs.indiana.edu:/pub/scheme-repository/incoming + echo -e \ + 'I have uploaded slib$(VERSION).zip to ftp.cs.indiana.edu:/pub/scheme-repository/incoming\n' \ + 'for placement into ftp.cs.indiana.edu:/pub/scheme-repository/code/lib/' \ + | mail -s 'SLIB upload' -b jaffer scheme-repository-request@cs.indiana.edu + +postnews: + echo -e "Newsgroups: comp.lang.scheme\n" | cat - ANNOUNCE | \ + inews -h -O -S \ + -f "announce@docupress.com (Aubrey Jaffer & Radey Shouman)" \ + -t "SLIB$(VERSION) Released" -d world + upzip: $(HOME)/pub/slib.zip - rsync -v $(HOME)/pub/slib.zip martigny.ai.mit.edu:pub/ + $(RSYNC) $(HOME)/pub/slib.zip nestle.ai.mit.edu:pub/ -dist: $(dest)slib$(VERSION).tar.gz -$(dest)slib$(VERSION).tar.gz: temp/slib - $(makedev) DEST=$(dest) PROD=slib ver=$(VERSION) tar.gz +dist: $(dest)slib$(VERSION).zip +$(dest)slib$(VERSION).zip: temp/slib + $(makedev) DEST=$(dest) PROD=slib ver=$(VERSION) zip cvs tag -F slib$(VERSION) shar: slib.shar slib.shar: temp/slib @@ -191,10 +229,10 @@ slib.com: temp/slib zip: slib.zip slib.zip: temp/slib $(makedev) PROD=slib zip -distzip: slib$(VERSION).zip -slib$(VERSION).zip: temp/slib - $(makedev) DEST=$(dest) PROD=slib ver=$(VERSION) zip - mv $(dest)slib$(VERSION).zip /c/scm/dist/ +doszip: /c/scm/dist/slib$(VERSION).zip +/c/scm/dist/slib$(VERSION).zip: temp/slib + $(makedev) DEST=/c/scm/dist/ PROD=slib ver=$(VERSION) zip + zip -d /c/scm/dist/slib$(VERSION).zip slib/slib.info pubzip: temp/slib $(makedev) DEST=$(HOME)/pub/ PROD=slib zip @@ -204,7 +242,7 @@ pubdiffs: temp/slib distdiffs: temp/slib $(makedev) DEST=$(dest) PROD=slib ver=$(ver) distdiffs announcediffs: temp/slib - $(makedev) DEST=$(dest) PROD=slib ver=2c3 announcediffs + $(makedev) DEST=$(dest) PROD=slib ver=$(VERSION) announcediffs psdfiles=COPYING.psd README.psd cmuscheme.el comint.el instrum.scm pexpr.scm \ primitives.scm psd-slib.scm psd.el read.scm runtime.scm version.scm @@ -235,14 +273,15 @@ new: $(htmldir)README.html ../dist/README \ $(htmldir)SLIB.html $(htmldir)JACAL.html \ $(htmldir)SCM.html $(htmldir)Hobbit.html \ - $(htmldir)SIMSYNCH.html \ - ../scm/README ../scm/scm.texi \ + $(htmldir)SIMSYNCH.html ../scm/scm.texi \ /c/scm/dist/install.bat /c/scm/dist/makefile \ /c/scm/dist/mkdisk.bat $(CHPAT) $(VERSION) $(ver) README slib.texi require.scm Makefile \ $(htmldir)SLIB.html + cvs commit -m '(*SLIB-VERSION*): Bumped from $(VERSION) to $(ver).' + cvs tag -F slib$(ver) -tagfiles = slib.texi $(mfiles) $(sfiles) $(bfiles) $(tfiles) +tagfiles = version.txi slib.texi $(mfiles) $(sfiles) $(bfiles) $(tfiles) # README and $(ifiles) cause semgentation faults in ETAGS for Emacs version 19. tags: $(tagfiles) etags $(tagfiles) @@ -257,6 +296,8 @@ report: clean: -rm -f *~ *.bak *.orig *.rej core a.out *.o \#* -rm -rf *temp + -rm -f slib$(VERSION).info + distclean: realclean realclean: -rm -f *~ *.bak *.orig *.rej TAGS core a.out *.o \#* @@ -1,10 +1,10 @@ -This directory contains the distribution of Scheme Library slib2c3. +This directory contains the distribution of Scheme Library slib2c7. Slib conforms to Revised^5 Report on the Algorithmic Language Scheme and the IEEE P1178 specification. Slib supports Unix and similar systems, VMS, and MS-DOS. -The maintainer can be reached at jaffer @ life.ai.mit.edu. - http://www-swiss.ai.mit.edu/~jaffer/SLIB.html +The maintainer can be reached at jaffer @ ai.mit.edu. + http://swissnet.ai.mit.edu/~jaffer/SLIB.html MANIFEST @@ -16,6 +16,7 @@ The maintainer can be reached at jaffer @ life.ai.mit.edu. `Template.scm' Example configuration file. Copy and customize to reflect your system. + `bigloo.init' is a configuration file for Bigloo. `chez.init' is a configuration file for Chez Scheme. `elk.init' is a configuration file for ELK 2.1 `gambit.init' is a configuration file for Gambit Scheme. @@ -23,11 +24,15 @@ The maintainer can be reached at jaffer @ life.ai.mit.edu. `mitscheme.init' is a configuration file for MIT Scheme. `mitcomp.pat' is a patch file which adds definitions to SLIB files for the MitScheme compiler. - `scheme2c.init' is a configuration file for DEC's scheme->c. + `pscheme.init' is configuration file for PocketScheme 0.2.5 (WinCE SIOD) + `RScheme.init' is a configuration file for RScheme. + `scheme2c.init' is a configuration file for DEC's scheme->c. `scheme48.init' is a configuration file for Scheme48. `scsh.init' is a configuration file for Scheme-Shell `scm.init' is a configuration file for SCM. `t3.init' is a configuration file for T3.1 in Scheme mode. + `STk.init' is a configuration file for STk. + `umbscheme.init' is a configuration file for umb-scheme. `vscm.init' is a configuration file for VSCM. `mklibcat.scm' builds the *catalog* cache. `require.scm' has code which allows system independent access to @@ -116,7 +121,8 @@ The maintainer can be reached at jaffer @ life.ai.mit.edu. `values.scm' is multiple values. `queue.scm' has queues and stacks. - `yasos.scm' is object oriented programming (using R4RS macros). + `object.scm' is an object system. + `yasyn.scm' defines (syntax-rules) macros for object oriented programming. `collect.scm' is collection operators (like CL sequences). `priorque.scm' has code and documentation for priority queues. `wttree.scm' has weight-balanced trees. @@ -151,6 +157,7 @@ The maintainer can be reached at jaffer @ life.ai.mit.edu. `structure.scm' has syntax-case macros for the same. `structst.scm' has test code for struct.scm. `byte.scm' has arrays of small integers. + `nclients' provides a Scheme interface to FTP and WWW Browsers. INSTALLATION INSTRUCTIONS diff --git a/RScheme.init b/RScheme.init new file mode 100644 index 0000000..b16b286 --- /dev/null +++ b/RScheme.init @@ -0,0 +1,282 @@ +;;;"RScheme.init" Initialization for SLIB for RScheme -*-scheme-*- +;;;; From http://www.rscheme.org/rs/pg1/RScheme.scm +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. +;;; +;;; adapted for RScheme by Donovan Kolbly -- (v1 1997-09-14) +;;; +;Permission to copy this software, to redistribute it, and to use it +;for any purpose is granted, subject to the following restrictions and +;understandings. +; +;1. Any copy made of this software must include this copyright notice +;in full. +; +;2. I have made no warrantee or representation that the operation of +;this software will be error-free, and I am under no obligation to +;provide any services, by way of maintenance, update, or otherwise. +; +;3. In conjunction with products arising from the use of this +;material, there shall be no use of my name in any advertising, +;promotional, or sales literature without prior written consent in +;each case. + +;;; (software-type) should be set to the generic operating system type. +;;; UNIX, VMS, MACOS, AMIGA and MS-DOS are supported. + +(define (software-type) 'UNIX) + +;;; (scheme-implementation-type) should return the name of the scheme +;;; implementation loading this file. + +(define (scheme-implementation-type) 'RScheme) + +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) "http://www.rscheme.org/") + +;;; (scheme-implementation-version) should return a string describing +;;; the version the scheme implementation loading this file. + +(define (scheme-implementation-version) "0.7.1") + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. + +(define (implementation-vicinity) + (case (software-type) + ((UNIX) "/usr/local/lib/rs/0.7.1/") + ((VMS) "scheme$src:") + ((MS-DOS) "C:\\scheme\\"))) + +;;; (library-vicinity) should be defined to be the pathname of the +;;; directory where files of Scheme library functions reside. + +(define library-vicinity + (let ((library-path + (or + ;; Use this getenv if your implementation supports it. + (getenv "SCHEME_LIBRARY_PATH") + ;; Use this path if your scheme does not support GETENV + ;; or if SCHEME_LIBRARY_PATH is not set. + (case (software-type) + ((UNIX) "/usr/lib/slib/") + ((VMS) "lib$scheme:") + ((MS-DOS) "C:\\SLIB\\") + (else ""))))) + (lambda () library-path))) + +;;; *FEATURES* should be set to a list of symbols describing features +;;; of this implementation. Suggestions for features are: + +(define *features* + '( + source ;can load scheme source files + ;(slib:load-source "filename") +; compiled ;can load compiled files + ;(slib:load-compiled "filename") + rev4-report ;conforms to +; rev3-report ;conforms to +; ieee-p1178 ;conforms to +; sicp ;runs code from Structure and + ;Interpretation of Computer + ;Programs by Abelson and Sussman. + rev4-optional-procedures ;LIST-TAIL, STRING->LIST, + ;LIST->STRING, STRING-COPY, + ;STRING-FILL!, LIST->VECTOR, + ;VECTOR->LIST, and VECTOR-FILL! +; rev2-procedures ;SUBSTRING-MOVE-LEFT!, + ;SUBSTRING-MOVE-RIGHT!, + ;SUBSTRING-FILL!, + ;STRING-NULL?, APPEND!, 1+, + ;-1+, <?, <=?, =?, >?, >=? + multiarg/and- ;/ and - can take more than 2 args. + multiarg-apply ;APPLY can take more than 2 args. +; rationalize + delay ;has DELAY and FORCE + with-file ;has WITH-INPUT-FROM-FILE and + ;WITH-OUTPUT-FROM-FILE + string-port ;has CALL-WITH-INPUT-STRING and + ;CALL-WITH-OUTPUT-STRING +; transcript ;TRANSCRIPT-ON and TRANSCRIPT-OFF + char-ready? +; macro ;has R4RS high level macros +; defmacro ;has Common Lisp DEFMACRO +; eval ;SLIB:EVAL is single argument eval +; record ;has user defined data structures +; values ;proposed multiple values +; dynamic-wind ;proposed dynamic-wind +; ieee-floating-point ;conforms to + full-continuation ;can return multiple times +; object-hash ;has OBJECT-HASH + +; sort +; queue ;queues +; pretty-print +; object->string +; format +; trace ;has macros: TRACE and UNTRACE +; compiler ;has (COMPILER) +; ed ;(ED) is editor +; system ;posix (system <string>) + getenv ;posix (getenv <string>) +; program-arguments ;returns list of strings (argv) +; Xwindows ;X support +; curses ;screen management package +; termcap ;terminal description package +; terminfo ;sysV terminal description +; current-time ;returns time in seconds since 1/1/1970 + )) + +;;; (OUTPUT-PORT-WIDTH <port>) +(define (output-port-width . arg) 79) + +;;; (OUTPUT-PORT-HEIGHT <port>) +(define (output-port-height . arg) 24) + +;;; (CURRENT-ERROR-PORT) +;(define current-error-port +; (let ((port (current-output-port))) +; (lambda () port))) + +;;; (TMPNAM) makes a temporary file name. +(define tmpnam (let ((cntr 100)) + (lambda () (set! cntr (+ 1 cntr)) + (string-append "slib_" (number->string cntr))))) + +;;; (FILE-EXISTS? <string>) +(define (file-exists? f) (os-file-exists? f)) + +;;; (DELETE-FILE <string>) +(define (delete-file f) #f) + +;;; FORCE-OUTPUT flushes any pending output on optional arg output port +;;; use this definition if your system doesn't have such a procedure. +(define (force-output . arg) + (flush-output-port (if (null? arg) + (current-output-port) + (car arg)))) + +;;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string +;;; port versions of CALL-WITH-*PUT-FILE. + +;;; CHAR-CODE-LIMIT is one greater than the largest integer which can +;;; be returned by CHAR->INTEGER. +(define char-code-limit 65536) + +;;; MOST-POSITIVE-FIXNUM is used in modular.scm +(define most-positive-fixnum #x1FFFFFFF) + +;;; Return argument +;;(define (identity x) x) + +;;; If your implementation provides eval SLIB:EVAL is single argument +;;; eval using the top-level (user) environment. +(define slib:eval eval) + +;;; If your implementation provides R4RS macros: +;(define macro:eval slib:eval) +;(define macro:load load) + +(define *defmacros* + (list (cons 'defmacro + (lambda (name parms . body) + `(set! *defmacros* (cons (cons ',name (lambda ,parms ,@body)) + *defmacros*)))))) +(define (defmacro? m) (and (assq m *defmacros*) #t)) + +(define (macroexpand-1 e) + (if (pair? e) (let ((a (car e))) + (cond ((symbol? a) (set! a (assq a *defmacros*)) + (if a (apply (cdr a) (cdr e)) e)) + (else e))) + e)) + +(define (macroexpand e) + (if (pair? e) (let ((a (car e))) + (cond ((symbol? a) + (set! a (assq a *defmacros*)) + (if a (macroexpand (apply (cdr a) (cdr e))) e)) + (else e))) + e)) + +(define gentemp + (let ((*gensym-counter* -1)) + (lambda () + (set! *gensym-counter* (+ *gensym-counter* 1)) + (string->symbol + (string-append "slib:G" (number->string *gensym-counter*)))))) + +(define base:eval slib:eval) +(define (defmacro:eval x) (base:eval (defmacro:expand* x))) +(define (defmacro:expand* x) + (require 'defmacroexpand) (apply defmacro:expand* x '())) + +(define (defmacro:load <pathname>) + (slib:eval-load <pathname> defmacro:eval)) + +(define (slib:eval-load <pathname> evl) + (if (not (file-exists? <pathname>)) + (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) + (call-with-input-file <pathname> + (lambda (port) + (let ((old-load-pathname *load-pathname*)) + (set! *load-pathname* <pathname>) + (do ((o (read port) (read port))) + ((eof-object? o)) + (evl o)) + (set! *load-pathname* old-load-pathname))))) + +;;; define an error procedure for the library +(define (slib:error msg . args) + (error "~a ~j" msg args)) + +;;; define these as appropriate for your system. +(define slib:tab (integer->char 9)) +(define slib:form-feed (integer->char 12)) + +;;; Support for older versions of Scheme. Not enough code for its own file. +;(define (last-pair l) (if (pair? (cdr l)) (last-pair (cdr l)) l)) +(define t #t) +(define nil #f) + +;;; Define these if your implementation's syntax can support it and if +;;; they are not already defined. + +;(define (1+ n) (+ n 1)) +;(define (-1+ n) (+ n -1)) +;(define 1- -1+) + +(define in-vicinity string-append) + +;;; Define SLIB:EXIT to be the implementation procedure to exit or +;;; return if exitting not supported. +(define slib:exit (lambda args (process-exit 0))) + +;;; Here for backward compatability +(define scheme-file-suffix + (let ((suffix (case (software-type) + ((NOSVE) "_scm") + (else ".scm")))) + (lambda () suffix))) + +;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever +;;; suffix all the module files in SLIB have. See feature 'SOURCE. + +(define (slib:load-source f) (load (string-append f ".scm"))) + +;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced +;;; by compiling "foo.scm" if this implementation can compile files. +;;; See feature 'COMPILED. + +(define slib:load-compiled load) + +;;; At this point SLIB:LOAD must be able to load SLIB files. + +(define slib:load slib:load-source) + +(slib:load (in-vicinity (library-vicinity) "require")) diff --git a/STk.init b/STk.init new file mode 100644 index 0000000..47c2e2d --- /dev/null +++ b/STk.init @@ -0,0 +1,248 @@ +;;;"STk.init" SLIB Initialization for STk -*-scheme-*- +;;; Authors: Erick Gallesio (eg@unice.fr) and Aubrey Jaffer. +;;; +;;; This code is in the public domain. + +(require "unix") + +;;; (software-type) should be set to the generic operating system type. +;;; UNIX, VMS, MACOS, AMIGA and MSDOS are supported. + +(define (software-type) 'UNIX) + +;;; (scheme-implementation-type) should return the name of the scheme +;;; implementation loading this file. + +(define (scheme-implementation-type) '|STk|) + +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://kaolin.unice.fr/STk/STk.html") + +;;; (scheme-implementation-version) should return a string describing +;;; the version the scheme implementation loading this file. + +(define (scheme-implementation-version) (version)) + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. + +(define (implementation-vicinity) "/usr/local/lib/stk/3.99.3/") + +;;; (library-vicinity) should be defined to be the pathname of the +;;; directory where files of Scheme library functions reside. + +(define library-vicinity + (let ((library-path (or (getenv "SCHEME_LIBRARY_PATH") "/usr/local/lib/slib/"))) + (lambda () library-path))) + +;;; +;;; +(define home-vicinity + (let ((home-path (or (getenv "HOME") "/"))) + (lambda () home-path))) + +;;; *FEATURES* should be set to a list of symbols describing features +;;; of this implementation. Suggestions for features are: + +(define *features* + '( + source ;can load scheme source files + ;(slib:load-source "filename") + compiled ;can load compiled files + ;(slib:load-compiled "filename") + rev4-report ;conforms to +; rev3-report ;conforms to +; ieee-p1178 ;conforms to +; sicp ;runs code from Structure and + ;Interpretation of Computer + ;Programs by Abelson and Sussman. + rev4-optional-procedures ;LIST-TAIL, STRING->LIST, + ;LIST->STRING, STRING-COPY, + ;STRING-FILL!, LIST->VECTOR, + ;VECTOR->LIST, and VECTOR-FILL! +; rev3-procedures ;LAST-PAIR, T, and NIL +; rev2-procedures ;SUBSTRING-MOVE-LEFT!, + ;SUBSTRING-MOVE-RIGHT!, + ;SUBSTRING-FILL!, + ;STRING-NULL?, APPEND!, 1+, + ;-1+, <?, <=?, =?, >?, >=? + multiarg/and- ;/ and - can take more than 2 args. + multiarg-apply ;APPLY can take more than 2 args. +; rationalize + delay ;has DELAY and FORCE + with-file ;has WITH-INPUT-FROM-FILE and + ;WITH-OUTPUT-FROM-FILE + string-port ;has CALL-WITH-INPUT-STRING and + ;CALL-WITH-OUTPUT-STRING +; transcript ;TRANSCRIPT-ON and TRANSCRIPT-OFF +; char-ready? +; macro ;has R4RS high level macros +; defmacro ;has Common Lisp DEFMACRO + eval ;SLIB:EVAL is single argument eval +; record ;has user defined data structures +; values ;proposed multiple values + dynamic-wind ;proposed dynamic-wind + ieee-floating-point ;conforms to + full-continuation ;can return multiple times +; object-hash ;has OBJECT-HASH + +; sort ; commented because icomplete +; queue ;queues +; pretty-print +; object->string +; format +; compiler ;has (COMPILER) + ed ;(ED) is editor + system ;posix (system <string>) + getenv ;posix (getenv <string>) +; program-arguments ;returns list of strings (argv) +; Xwindows ;X support +; curses ;screen management package +; termcap ;terminal description package +; terminfo ;sysV terminal description + )) + +;;; (OUTPUT-PORT-WIDTH <port>) +(define (output-port-width . arg) 79) + +;;; (OUTPUT-PORT-HEIGHT <port>) +(define (output-port-height . arg) 24) + +;;; (TMPNAM) makes a temporary file name. +(define tmpnam (let ((cntr 100)) + (lambda () (set! cntr (+ 1 cntr)) + (string-append "slib_" (number->string cntr))))) + +;;; (DELETE-FILE <string>) +(define (delete-file f) (system (format #f "/bin/rm ~A" f))) + +;;; FORCE-OUTPUT flushes any pending output on optional arg output port +;;; use this definition if your system doesn't have such a procedure. +(define (force-output . arg) (apply flush arg)) + +;;; CHAR-CODE-LIMIT is one greater than the largest integer which can +;;; be returned by CHAR->INTEGER. +(define char-code-limit 256) + +;;; MOST-POSITIVE-FIXNUM is used in modular.scm +(define most-positive-fixnum #x0fffffff) + +;;; If your implementation provides eval SLIB:EVAL is single argument +;;; eval using the top-level (user) environment. +(define slib:eval eval) + +;;; If your implementation provides R4RS macros: +;(define macro:eval slib:eval) +;(define macro:load load) + +(define *macros* '()) + +(define-macro (defmacro name args . body) + `(begin + (define-macro (,name ,@args) ,@body) + (set! *macros* (cons ,name *macros*)))) + + +(define (defmacro? m) (and (memv m *macros*) #t)) + +(define macroexpand-1 MACRO-EXPAND-1) +(define macroexpand MACRO-EXPAND) + + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(define gentemp GENSYM) +(define base:eval slib:eval) + +(define (defmacro:eval x) (base:eval (defmacro:expand* x))) +(define (defmacro:expand* x) + (require 'defmacroexpand) (apply defmacro:expand* x '())) + +(define (defmacro:load <pathname>) + (slib:eval-load <pathname> defmacro:eval)) + +(define (slib:eval-load <pathname> evl) + (if (not (file-exists? <pathname>)) + (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) + (call-with-input-file <pathname> + (lambda (port) + (let ((old-load-pathname *load-pathname*)) + (set! *load-pathname* <pathname>) + (do ((o (read port) (read port))) + ((eof-object? o)) + (evl o)) + (set! *load-pathname* old-load-pathname))))) + +;;; define an error procedure for the library +(define (slib:error . args) + (error (apply string-append (map (lambda (x) (format #f " ~a" x)) args)))) + + +;;; define these as appropriate for your system. +(define slib:tab (integer->char 9)) +(define slib:form-feed (integer->char 12)) + +;;; Define these if your implementation's syntax can support it and if +;;; they are not already defined. +(define -1+ 1-) + +(define in-vicinity string-append) + +;;; Define SLIB:EXIT to be the implementation procedure to exit or +;;; return if exitting not supported. +(define slib:exit exit) + +;;; Here for backward compatability +(define scheme-file-suffix + (let ((suffix (case (software-type) + ((NOSVE) "_scm") + (else ".scm")))) + (lambda () suffix))) + +;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever +;;; suffix all the module files in SLIB have. See feature 'SOURCE. + +(define slib:load-source LOAD) + +;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced +;;; by compiling "foo.scm" if this implementation can compile files. +;;; See feature 'COMPILED. + +(define slib:load-compiled load) + +;;; +;;; Retain original require/provide before loading "require.scm" +;;; +(define stk:require require) +(define stk:provide provide) +(define stk:provided? provided?) + +(define slib:load slib:load-source) +(slib:load (in-vicinity (library-vicinity) "require")) + + +;;; +;;; Redefine require/provide so that symbols use SLIB one and strings use STk one +;;; + +(define require + (let ((slib:require require)) + (lambda (item) + ((if (symbol? item) slib:require stk:require) item )))) + +(define provide + (let ((slib:provide provide)) + (lambda (item) + ((if (symbol? item) slib:provide stk:provide) item)))) + +(define provided? + (let ((slib:provided? provided?)) + (lambda (item) + ((if (symbol? item) slib:provided? stk:provided?) item)))) + +(define identity (lambda (x) x)) diff --git a/Template.scm b/Template.scm index e3d2687..9d30d40 100644 --- a/Template.scm +++ b/Template.scm @@ -1,21 +1,7 @@ -;"Template.scm" configuration template of *features* for Scheme -*-scheme-*- -; Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer. -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; "Template.scm" configuration template of *features* for Scheme -*-scheme-*- +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; (software-type) should be set to the generic operating system type. ;;; UNIX, VMS, MACOS, AMIGA and MS-DOS are supported. @@ -27,6 +13,12 @@ (define (scheme-implementation-type) 'Template) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) #f) + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. diff --git a/alistab.scm b/alistab.scm index f0e8d59..426a4e3 100644 --- a/alistab.scm +++ b/alistab.scm @@ -42,12 +42,13 @@ (list resources (list 'free-id 1)))) (define (open-base infile writable) - (cons (if (input-port? infile) #f infile) - ((lambda (fun) - (if (input-port? infile) - (fun infile) - (call-with-input-file infile fun))) - read))) + (and (or (input-port? infile) (file-exists? infile)) + (cons (if (input-port? infile) #f infile) + ((lambda (fun) + (if (input-port? infile) + (fun infile) + (call-with-input-file infile fun))) + read)))) (define (write-base lldb outfile) ((lambda (fun) @@ -306,7 +307,7 @@ (define (supported-key-type? type) (case type - ((atom integer symbol string) #t) + ((atom integer number symbol string) #t) (else #f))) ;;make-table open-table remover assoc* make-assoc* diff --git a/arraymap.scm b/arraymap.scm index d3dedba..ab3d7c8 100644 --- a/arraymap.scm +++ b/arraymap.scm @@ -1,4 +1,4 @@ -;;;; "arraymap.scm", applicative routines for arrays in Scheme. +;;;; "arraymap.scm", applicative routines for arrays in Scheme. ;;; Copyright (c) 1993 Aubrey Jaffer ; ;Permission to copy this software, to redistribute it, and to use it @@ -36,74 +36,77 @@ (define (batch:port parms) (let ((bp (parameter-list-ref parms 'batch-port))) (cond ((or (not (pair? bp)) (not (output-port? (car bp)))) - ;;(slib:error 'batch-line "missing batch-port parameter" bp) + (slib:warn 'batch-line "missing batch-port parameter" bp) (current-output-port)) (else (car bp))))) (define (batch:dialect parms) ; was batch-family (car (parameter-list-ref parms 'batch-dialect))) -(define (batch:line-length-limit parms) - (let ((bl (parameter-list-ref parms 'batch-line-length-limit))) - (cond (bl (car bl)) - (else (case (batch:dialect parms) - ((unix) 1023) - ((dos) 127) - ((vms) 1023) - ((system) 1023) - ((*unknown*) -1)))))) - (define (write-batch-line str line-limit port) - (cond ((and line-limit (>= (string-length str) line-limit)) #f) + (cond ((and line-limit (>= (string-length str) line-limit)) + (slib:warn 'write-batch-line 'too-long + (string-length str) '> line-limit) + #f) (else (write-line str port) #t))) (define (batch-line parms str) (write-batch-line str (batch:line-length-limit parms) (batch:port parms))) ;;; add a Scheme batch-dialect? -(define (batch:apply-chop-to-fit proc . args) - (define args-but-last (butlast args 1)) +(define (batch:try-chopped-command parms . args) + (define args-but-last (batch:flatten (butlast args 1))) + (define line-limit (batch:line-length-limit parms)) (let loop ((fodder (car (last-pair args)))) - (let ((hlen (quotient (length fodder) 2))) - (cond ((apply proc (append args-but-last (list fodder)))) - ((not (positive? hlen)) - (slib:error 'batch:apply-chop-to-fit "can't split" - (cons proc (append args-but-last (list fodder))))) - (else (loop (nthcdr (+ 1 hlen) fodder)) - (loop (butlast fodder hlen))))))) - -(define (batch:try-system parms . strings) - (set! strings (batch:flatten strings)) + (let ((str (batch:glued-line parms + (batch:flatten + (append args-but-last (list fodder)))))) + (cond ((< (string-length str) line-limit) + (batch:try-command parms str)) + ((< (length fodder) 2) + (slib:warn 'batch:try-chopped-command "can't fit in " line-limit + (cons proc (append args-but-last (list fodder)))) + #f) + (else (let ((hlen (quotient (length fodder) 2))) + (and (loop (last fodder hlen)) + (loop (butlast fodder hlen))))))))) + +(define (batch:glued-line parms strings) (case (batch:dialect parms) - ((unix) (batch-line parms (apply string-join " " strings))) - ((dos) (batch-line parms (apply string-join " " strings))) - ((vms) (batch-line parms (apply string-join " " "$" strings))) - ((system) - (let ((port (batch:port parms)) - (str (apply string-join " " strings))) - (write `(system ,str) port) (newline port) - (and (provided? 'system) (system:success? (system str))))) - ((*unknown*) - (let ((port (batch:port parms)) - (str (apply string-join " " strings))) - (write `(system ,str) port) (newline port)) - #t) + ((vms) (apply string-join " " "$" strings)) + ((unix dos amigados system *unknown*) (apply string-join " " strings)) (else #f))) -(define (batch:system parms . strings) - (cond ((apply batch:try-system parms strings)) - (else (slib:error 'batch:system 'failed strings)))) +(define (batch:try-command parms . strings) + (set! strings (batch:flatten strings)) + (let ((line (batch:glued-line parms strings))) + (and line + (case (batch:dialect parms) + ((unix dos vms amigados) (batch-line parms line)) + ((system) + (let ((port (batch:port parms))) + (write `(system ,line) port) (newline port) + (and (provided? 'system) (system:success? (system line))))) + ((*unknown*) + (let ((port (batch:port parms))) + (write `(system ,line) port) (newline port) #t)) + (else #f))))) + +(define (batch:command parms . strings) + (cond ((apply batch:try-command parms strings)) + (else (slib:error 'batch:command 'failed strings)))) (define (batch:run-script parms name . strings) (case (batch:dialect parms strings) - ((vms) (batch:system parms (string-append "@" name) strings)) - (else (batch:system parms name strings)))) + ((vms) (batch:command parms (string-append "@" name) strings)) + (else (batch:command parms name strings)))) (define (batch:write-comment-line dialect line port) (case dialect ((unix) (write-batch-line (string-append "# " line) #f port)) ((dos) (write-batch-line (string-append "rem " line) #f port)) ((vms) (write-batch-line (string-append "$! " line) #f port)) + ((amigados) (write-batch-line (string-append "; " line) #f port)) ((system) (write-batch-line (string-append "; " line) #f port)) ((*unknown*) (write-batch-line (string-append ";;; " line) #f port) ;;(newline port) @@ -139,6 +142,24 @@ (every (lambda (string) (batch-line parms string)) lines) (batch-line parms (string-append "$EOD")))) + ((amigados) (batch-line parms (string-append "delete force " file)) + (every + (lambda (str) + (letrec ((star-quote + (lambda (str) + (if (equal? "" str) + str + (let* ((ch (string-ref str 0)) + (s (if (char=? ch #\") + (string #\* ch) + (string ch)))) + (string-append + s + (star-quote + (substring str 1 (string-length str))))))))) + (batch-line parms (string-append "echo \"" (star-quote str) + "\" >> " file)))) + lines)) ((system) (write `(delete-file ,file) port) (newline port) (delete-file file) (require 'pretty-print) @@ -174,6 +195,8 @@ #t) ((vms) (batch-line parms (string-append "$DELETE " file)) #t) + ((amigados) (batch-line parms (string-append "delete force " file)) + #t) ((system) (write `(delete-file ,file) port) (newline port) (delete-file file)) ; SLIB provides ((*unknown*) (write `(delete-file ,file) port) (newline port) @@ -186,6 +209,9 @@ ;;((dos) (batch-line parms (string-join " " "REN" old-name new-name))) ((dos) (batch-line parms (string-join " " "MOVE" "/Y" old-name new-name))) ((vms) (batch-line parms (string-join " " "$RENAME" old-name new-name))) + ((amigados) (batch-line parms (string-join " " "failat 21")) + (batch-line parms (string-join " " "delete force" new-name)) + (batch-line parms (string-join " " "rename" old-name new-name))) ((system) (batch:extender 'rename-file batch:rename-file)) ((*unknown*) (write `(rename-file ,old-name ,new-name) port) (newline port) @@ -244,6 +270,17 @@ ;;(write-line "$DEFINE/USER SYS$OUTPUT BUILD.LOG" port) (proc port)))) + ((amigados) ((cond ((and (string? name) (provided? 'system)) + (lambda (proc) + (let ((ans (call-with-output-file name proc))) + (system (string-append "protect " name " rswd")) + ans))) + ((output-port? name) (lambda (proc) (proc name))) + (else (lambda (proc) (proc (current-output-port))))) + (lambda (port) + (batch:write-header-comment dialect name port) + (proc port)))) + ((system) ((cond ((and (string? name) (provided? 'system)) (lambda (proc) (let ((ans (call-with-output-file name @@ -340,9 +377,12 @@ (delete-file file-name)))) (define batch:database #f) -(define (os->batch-dialect os) - ((((batch:database 'open-table) 'operating-system #f) - 'get 'os-family) os)) +(define os->batch-dialect #f) +(define batch-dialect->line-length-limit #f) + +(define (batch:line-length-limit parms) + (let ((bl (parameter-list-ref parms 'batch-line-length-limit))) + (if bl (car bl) (batch-dialect->line-length-limit (batch:dialect parms))))) (define (batch:initialize! database) (set! batch:database database) @@ -350,12 +390,13 @@ '(batch-dialect ((family atom)) - () - ((unix) - (dos) - (vms) - (system) - (*unknown*))) + ((line-length-limit number)) + ((unix 1023) + (dos 127) + (vms 1023) + (amigados 511) + (system 1023) + (*unknown* -1))) '(operating-system ((name symbol)) @@ -365,7 +406,7 @@ (acorn *unknown*) (aix unix) (alliant *unknown*) - (amiga *unknown*) + (amiga amigados) (apollo unix) (apple2 *unknown*) (arm *unknown*) @@ -378,6 +419,7 @@ (harris *unknown*) (hp-ux unix) (hp48 *unknown*) + (irix unix) (isis *unknown*) (linux unix) (mac *unknown*) @@ -404,4 +446,9 @@ ))) ((database 'add-domain) '(operating-system operating-system #f symbol #f)) + (set! os->batch-dialect (((batch:database 'open-table) 'operating-system #f) + 'get 'os-family)) + (set! batch-dialect->line-length-limit + (((batch:database 'open-table) 'batch-dialect #f) + 'get 'line-length-limit)) ) diff --git a/bigloo.init b/bigloo.init new file mode 100644 index 0000000..14b9c9e --- /dev/null +++ b/bigloo.init @@ -0,0 +1,248 @@ +;; "bigloo.init" Initialization for SLIB for Bigloo -*-scheme-*- +;; Copyright 1994 Robert Sanders +;; Copyright 1991, 1992, 1993 Aubrey Jaffer +;; Copyright 1991 David Love +;; +;; Permission to copy this software, to redistribute it, and to use it +;; for any purpose is granted, subject to the following restrictions and +;; understandings. +;; +;; 1. Any copy made of this software must include this copyright notice +;; in full. +;; +;; 2. I have made no warrantee or representation that the operation of +;; this software will be error-free, and I am under no obligation to +;; provide any services, by way of maintenance, update, or otherwise. +;; +;; 3. In conjunction with products arising from the use of this +;; material, there shall be no use of my name in any advertising, +;; promotional, or sales literature without prior written consent in +;; each case. + +(define (software-type) 'UNIX) + +;;; (scheme-implementation-type) should return the name of the scheme +;;; implementation loading this file. + +(define (scheme-implementation-type) 'Bigloo) + +;;; (scheme-implementation-version) should return a string describing +;;; the version the scheme implementation loading this file. + +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://kaolin.unice.fr/~serrano/bigloo/bigloo.html") + +(define (scheme-implementation-version) "2.0c") + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. + +(define (implementation-vicinity) + (case (software-type) + ((UNIX) "/usr/unsup/lib/bigloo/") + ((VMS) "scheme$src:") + ((MSDOS) "C:\\scheme\\"))) + +;;; (library-vicinity) should be defined to be the pathname of the +;;; directory where files of Scheme library functions reside. + +(define library-vicinity + (let ((library-path + (or + ;; Use this getenv if your implementation supports it. + (getenv "SCHEME_LIBRARY_PATH") + ;; Use this path if your scheme does not support GETENV + ;; or if SCHEME_LIBRARY_PATH is not set. + (case (software-type) + ((UNIX) "/home/bambam/leavens/unsup-src/scheme/scm/slib/") + ((VMS) "lib$scheme:") + ((MSDOS) "C:\\SLIB\\") + (else ""))))) + (lambda () library-path))) + +;;; (home-vicinity) should return the vicinity of the user's HOME +;;; directory, the directory which typically contains files which +;;; customize a computer environment for a user. + +(define home-vicinity + (let ((home-path (getenv "HOME"))) + (lambda () home-path))) + +;;; *FEATURES* should be set to a list of symbols describing features +;;; of this implementation. See Template.scm for the list of feature +;;; names. + +(define *features* + '( + source ;can load scheme source files + ;(slib:load-source "filename") + rev4-report ;conforms to + rev3-report ;conforms to + ieee-p1178 ;conforms to + rev4-optional-procedures + rev3-procedures + multiarg/and- + multiarg-apply + rationalize + object-hash + delay + promise + with-file + transcript + ieee-floating-point + eval + pretty-print + object->string + string-case + string-port + system + getenv + defmacro + ;;full-continuation ;not without the -call/cc switch + )) + +(define pretty-print pp) + +(define (object->string x) (obj->string x)) + +;;; Define these if your implementation's syntax can support it and if +;;; they are not already defined. + +(define (1+ n) (+ n 1)) +(define (-1+ n) (+ n -1)) +(define 1- -1+) + +;;; (OUTPUT-PORT-WIDTH <port>) +(define (output-port-width . arg) 79) + +;;; (OUTPUT-PORT-HEIGHT <port>) +(define (output-port-height . arg) 24) + +;;; (TMPNAM) makes a temporary file name. +(define tmpnam + (let ((cntr 100)) + (lambda () + (set! cntr (+ 1 cntr)) + (let ((tmp (string-append "slib_" (number->string cntr)))) + (if (file-exists? tmp) (tmpnam) tmp))))) + +;;; FORCE-OUTPUT flushes any pending output on optional arg output port +;;; use this definition if your system doesn't have such a procedure. +(define (force-output . args) + (flush-output-port (if (pair? args) (car args) (current-output-port)))) + +;;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string +;;; port versions of CALL-WITH-*PUT-FILE. +(define (call-with-output-string f) + (let ((outsp (open-output-string))) + (f outsp) + (close-output-port outsp))) + +(define (call-with-input-string s f) + (let* ((insp (open-input-string s)) + (res (f insp))) + (close-input-port insp) + res)) + +;;; CHAR-CODE-LIMIT is one greater than the largest integer which can +;;; be returned by CHAR->INTEGER. +(define char-code-limit 256) + +;; MOST-POSITIVE-FIXNUM is used in modular.scm +(define most-positive-fixnum 536870911) + +;;; Return argument +(define (identity x) x) + +;; define an error procedure for the library + +;;; If your implementation provides eval, SLIB:EVAL is single argument +;;; eval using the top-level (user) environment. +(define slib:eval eval) + +(define-macro (defmacro name . forms) + `(define-macro (,name . ,(car forms)) ,@(cdr forms))) + +(define (defmacro? m) (get-eval-expander m)) +(define (macroexpand-1 body) (expand-once body)) +(define (macroexpand body) (expand body)) + +(define (gentemp) (gensym)) + +(define (slib:eval-load <pathname> evl) + (if (not (file-exists? <pathname>)) + (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) + (call-with-input-file <pathname> + (lambda (port) + (let ((old-load-pathname *load-pathname*)) + (set! *load-pathname* <pathname>) + (do ((o (read port) (read port))) + ((eof-object? o)) + (evl o)) + (set! *load-pathname* old-load-pathname))))) + +(define (slib:error . args) + (error 'slib:error "" args)) + +;; define these as appropriate for your system. +(define slib:tab (integer->char 9)) +(define slib:form-feed (integer->char 12)) + +;;; records +(defmacro define-record forms + (let* ((name (car forms)) + (maker-name (symbol-append 'make- name))) + `(begin + (define-struct ,name ,@(cadr forms)) + (define ,maker-name ,name)) + )) + + +(define (promise:force p) (force p)) + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. + +(define in-vicinity string-append) + +;;; Define SLIB:EXIT to be the implementation procedure to exit or +;;; return if exitting not supported. +(define slib:exit (lambda args (exit 0))) + +;;; Here for backward compatability +(define scheme-file-suffix + (let ((suffix (case (software-type) + ((NOSVE) "_scm") + (else ".scm")))) + (lambda () suffix))) + +;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever +;;; suffix all the module files in SLIB have. See feature 'SOURCE. + +(define (slib:load-source f) (loadq (string-append f (scheme-file-suffix)))) + +;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced +;;; by compiling "foo.scm" if this implementation can compile files. +;;; See feature 'COMPILED. + +(define slib:load-compiled loadq) + +;;; At this point SLIB:LOAD must be able to load SLIB files. + +(define slib:load slib:load-source) + +(define defmacro:eval slib:eval) +(define defmacro:load slib:load) + +;;; If your implementation provides R4RS macros: +;(define macro:eval slib:eval) +;(define macro:load load) + +(slib:load (in-vicinity (library-vicinity) "require")) +; eof @@ -89,7 +89,7 @@ ((char-lower-case? (string-ref s (+ -1 p))) (chap:inc-string s (+ -1 p))) (else - (string-append + (string-append (substring s 0 p) "a" (substring s p (string-length s)))))) @@ -99,7 +99,7 @@ ((char-upper-case? (string-ref s (+ -1 p))) (chap:inc-string s (+ -1 p))) (else - (string-append + (string-append (substring s 0 p) "A" (substring s p (string-length s)))))) @@ -109,7 +109,7 @@ ((char-numeric? (string-ref s (+ -1 p))) (chap:inc-string s (+ -1 p))) (else - (string-append + (string-append (substring s 0 p) "1" (substring s p (string-length s)))))) diff --git a/charplot.scm b/charplot.scm index 2a2a49a..2c64615 100644 --- a/charplot.scm +++ b/charplot.scm @@ -18,6 +18,7 @@ ;each case. (require 'sort) +(require 'printf) (define charplot:rows 24) (define charplot:columns (output-port-width (current-output-port))) @@ -43,6 +44,9 @@ (display str) (charplot:printn! (- width (+ (string-length str) lpad)) #\ ))) +(define (charplot:number->string x) + (sprintf #f "%g" x)) + (define (scale-it z scale) (if (and (exact? z) (integer? z)) (quotient (* z (car scale)) (cadr scale)) @@ -86,8 +90,8 @@ (string-set! a (caar data) charplot:curve1) (set! data (cdr data))) (if (zero? (modulo (- ht xaxis) ystep)) - (let* ((v (number->string (/ (* (- ht xaxis) (cadr yscale)) - (car yscale)))) + (let* ((v (charplot:number->string (/ (* (- ht xaxis) (cadr yscale)) + (car yscale)))) (l (string-length v))) (if (> l 10) (display (substring v 0 10)) @@ -119,12 +123,16 @@ (charplot:center-print! xlabel (+ 12 fudge (- xstep/2))) (do ((i fudge (+ i xstep))) ((> (+ i xstep) charplot:width)) - (charplot:center-print! (number->string (/ (* (- i yaxis) (cadr xscale)) - (car xscale))) + (charplot:center-print! (charplot:number->string + (/ (* (- i yaxis) (cadr xscale)) + (car xscale))) xstep)) (newline))) (define (charplot:plot! data xlabel ylabel) + (cond ((array? data) + (set! data (map (lambda (lst) (cons (car lst) (cadr lst))) + (array->list data))))) (let* ((xmax (apply max (map car data))) (xmin (apply min (map car data))) (xscale (find-scale charplot:width (- xmax xmin))) @@ -139,4 +147,14 @@ data) xlabel ylabel xmin xscale ymin yscale))) +(define (plot-function func vlo vhi . npts) + (set! npts (if (null? npts) 100 (car npts))) + (let ((dats (make-array 0.0 npts 2))) + (array-index-map! (make-shared-array dats (lambda (idx) (list idx 0)) npts) + (lambda (idx) (+ vlo (* (- vhi vlo) (/ idx npts))))) + (array-map! (make-shared-array dats (lambda (idx) (list idx 1)) npts) + func + (make-shared-array dats (lambda (idx) (list idx 0)) npts)) + (charplot:plot! dats "" ""))) + (define plot! charplot:plot!) @@ -1,105 +1,55 @@ -;"chez.init" Initialization file for SLIB for Chez Scheme 5.0c -*-scheme-*- -; Copyright (C) 1993 dorai@cs.rice.edu (Dorai Sitaram) -; Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer. -; Adapted to version 5.0c by stone@math.grin.edu (John David Stone) 1997 -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. - -;; The SOFTWARE-TYPE procedure returns a symbol indicating the generic -;; operating system type. UNIX, VMS, MACOS, AMIGA and MS-DOS are -;; supported. - -(define software-type - (lambda () 'unix)) - -;; The SCHEME-IMPLEMENTATION-TYPE procedure returns a symbol denoting the -;; Scheme implementation that loads this file. - -(define scheme-implementation-type - (lambda () 'chez)) - -;; The SCHEME-IMPLEMENTATION-VERSION procedure returns a string describing -;; the version of the Scheme implementation that loads this file. - -(define scheme-implementation-version - (lambda () "5.0c")) - -;; The IMPLEMENTATION-VICINITY procedure returns a string giving the -;; pathname of the directory that includes any auxiliary files used by this -;; Scheme implementation. +;;;"chez.init" Initialization file for SLIB for Chez Scheme 6.0a -*-scheme-*- +;;; Authors: dorai@cs.rice.edu (Dorai Sitaram) and Aubrey Jaffer. +;;; +;;; This code is in the public domain. + +;;; Adapted to version 5.0c by stone@math.grin.edu (John David Stone) 1997 +;;; Adapted to version 6.0a by Gary T. Leavens <leavens@cs.iastate.edu>, 1999 + +;;; (software-type) should be set to the generic operating system type. +;;; UNIX, VMS, MACOS, AMIGA and MS-DOS are supported. + +(define (software-type) 'UNIX) + +;;; (scheme-implementation-type) should return the name of the scheme +;;; implementation loading this file. + +(define (scheme-implementation-type) 'chez) + +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://www.cs.indiana.edu/chezscheme/") + +;;; (scheme-implementation-version) should return a string describing +;;; the version the scheme implementation loading this file. + +(define (scheme-implementation-version) "6.0a") + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. (define implementation-vicinity - (lambda () "/usr/local/chez/5.0c/")) - -;; The GETENV returns the value of a shell environment variable. - -;; In some implementations of Chez Scheme, this can be done with foreign -;; procedures. However, I [JDS] am using the HP version, which does not -;; support them, so a different approach is needed. -;; -;; Here's the version that doesn't work on HPs: -;; -;; (provide-foreign-entries '("getenv")) -;; -;; (define getenv -;; (foreign-procedure "getenv" -;; (string) string)) -;; -;; And here's a version that parses the value out of the output of the -;; /bin/env command: - -(define getenv - (lambda (env-var) - (let ((env-port (car (process "exec /bin/env"))) - (read-line - (lambda (source) - (let ((next (peek-char source))) - (if (eof-object? next) - next - (let loop ((ch (read-char source)) - (so-far '())) - (if (or (eof-object? ch) - (char=? ch #\newline)) - (apply string (reverse so-far)) - (loop (read-char source) (cons ch so-far)))))))) - (position-of-copula - (lambda (str) - (let ((len (string-length str))) - (do ((position 0 (+ position 1))) - ((or (= position len) - (char=? (string-ref str position) #\=)) - position)))))) - (let loop ((equation (read-line env-port))) - (if (eof-object? equation) - #f - (let ((break (position-of-copula equation)) - (len (string-length equation))) - (if (string=? (substring equation 0 break) env-var) - (if (= break len) - "" - (substring equation (+ break 1) len)) - (loop (read-line env-port))))))))) - -;; The LIBRARY-VICINITY procedure returns the pathname of the directory -;; where Scheme library functions reside. + (lambda () "/usr/unsup/scheme/chez/")) + +;;; (library-vicinity) should be defined to be the pathname of the +;;; directory where files of Scheme library functions reside. (define library-vicinity - (let ((library-path (or (getenv "SCHEME_LIBRARY_PATH") - "/usr/local/lib/slib/"))) + (let ((library-path + (or + ;; Use this getenv if your implementation supports it. + (getenv "SCHEME_LIBRARY_PATH") + ;; Use this path if your scheme does not support GETENV + ;; or if SCHEME_LIBRARY_PATH is not set. + (case (software-type) + ((UNIX) "/usr/local/lib/slib/") + ((VMS) "lib$scheme:") + ((MS-DOS) "C:\\SLIB\\") + (else ""))))) (lambda () library-path))) ;;; (home-vicinity) should return the vicinity of the user's HOME @@ -110,88 +60,219 @@ (let ((home-path (getenv "HOME"))) (lambda () home-path))) -;; The OUTPUT-PORT-WIDTH procedure returns the number of graphic characters -;; that can reliably be displayed on one line of the standard output port. +;;; *FEATURES* should be set to a list of symbols describing features +;;; of this implementation. Suggestions for features are: + +(define *features* + '( + source ; Chez Scheme can load Scheme source files, with the + ; command (slib:load-source "filename") -- see below. + + compiled ; Chez Scheme can also load compiled Scheme files, with the + ; command (slib:load-compiled "filename") -- see below. + rev4-report ;conforms to + rev3-report ;conforms to + ieee-p1178 ;conforms to +; sicp ;runs code from Structure and + ;Interpretation of Computer + ;Programs by Abelson and Sussman. + rev4-optional-procedures ;LIST-TAIL, STRING->LIST, + ;LIST->STRING, STRING-COPY, + ;STRING-FILL!, LIST->VECTOR, + ;VECTOR->LIST, and VECTOR-FILL! +; rev2-procedures ;SUBSTRING-MOVE-LEFT!, + ;SUBSTRING-MOVE-RIGHT!, + ;SUBSTRING-FILL!, + ;STRING-NULL?, APPEND!, 1+, + ;-1+, <?, <=?, =?, >?, >=? + multiarg/and- ;/ and - can take more than 2 args. + multiarg-apply ;APPLY can take more than 2 args. + rationalize + delay ;has DELAY and FORCE + with-file ;has WITH-INPUT-FROM-FILE and + ;WITH-OUTPUT-FROM-FILE + string-port ;has CALL-WITH-INPUT-STRING and + ;CALL-WITH-OUTPUT-STRING + transcript ;TRANSCRIPT-ON and TRANSCRIPT-OFF + char-ready? + macro ;has R4RS high level macros +; defmacro ;has Common Lisp DEFMACRO + eval ;R5RS two-argument eval + record ;has user defined data structures + values ;proposed multiple values + dynamic-wind ;proposed dynamic-wind +; ieee-floating-point ;conforms to + full-continuation ;can return multiple times +; object-hash ;has OBJECT-HASH + + sort +; queue ;queues + pretty-print +; object->string + format + trace ;has macros: TRACE and UNTRACE +; compiler ;has (COMPILER) +; ed ;(ED) is editor + system ;posix (system <string>) + getenv ;posix (getenv <string>) +; program-arguments ;returns list of strings (argv) +; Xwindows ;X support +; curses ;screen management package +; termcap ;terminal description package +; terminfo ;sysV terminal description +; current-time ;returns time in seconds since 1/1/1970 + fluid-let + random + rev3-procedures + )) + +;;; (OUTPUT-PORT-WIDTH <port>) returns the number of graphic characters +;;; that can reliably be displayed on one line of the standard output port. (define output-port-width (lambda arg (let ((env-width-string (getenv "COLUMNS"))) (if (and env-width-string - (let loop ((remaining (string-length env-width-string))) - (or (zero? remaining) - (let ((next (- remaining 1))) - (and (char-numeric? (string-ref env-width-string - next)) - (loop next)))))) - (- (string->number env-width-string) 1) - 79)))) - -;; The OUTPUT-PORT-HEIGHT procedure returns the number of lines of text -;; that can reliably be displayed simultaneously in the standard output -;; port. + (let loop ((remaining (string-length env-width-string))) + (or (zero? remaining) + (let ((next (- remaining 1))) + (and (char-numeric? (string-ref env-width-string + next)) + (loop next)))))) + (- (string->number env-width-string) 1) + 79)))) + +;;; (OUTPUT-PORT-HEIGHT <port>) returns the number of lines of text that +;;; can reliably be displayed simultaneously in the standard output port. (define output-port-height (lambda arg (let ((env-height-string (getenv "LINES"))) (if (and env-height-string - (let loop ((remaining (string-length env-height-string))) - (or (zero? remaining) - (let ((next (- remaining 1))) - (and (char-numeric? (string-ref env-height-string - next)) - (loop next)))))) - (string->number env-height-string) - 24)))) - -;; *FEATURES* is a list of symbols describing features of this -;; implementation; SLIB procedures sometimes consult this list to figure -;; out whether to attempt some incompletely standard operation. + (let loop ((remaining (string-length env-height-string))) + (or (zero? remaining) + (let ((next (- remaining 1))) + (and (char-numeric? (string-ref env-height-string + next)) + (loop next)))))) + (string->number env-height-string) + 24)))) + +;;; (CURRENT-ERROR-PORT) +(define current-error-port + (let ((port (console-output-port))) ; changed from current-output-port + (lambda () port))) -(define *features* - '(source ; Chez Scheme can load Scheme source files, with the - ; command (slib:load-source "filename") -- see below. +;;; (TMPNAM) makes a temporary file name. +(define tmpnam + (let ((cntr 100)) + (lambda () + (set! cntr (+ 1 cntr)) + (let ((tmp (string-append "slib_" (number->string cntr)))) + (if (file-exists? tmp) (tmpnam) tmp))))) - compiled ; Chez Scheme can also load compiled Scheme files, with the - ; command (slib:load-compiled "filename") -- see below. +;;; (FILE-EXISTS? <string>) is built-in to Chez Scheme - char-ready? delay dynamic-wind fluid-let format - full-continuation getenv ieee-p1178 macro multiarg/and- - multiarg-apply pretty-print random random-inexact rationalize - rev3-procedures rev3-report rev4-optional-procedures rev4-report - sort string-port system transcript values with-file)) +;;; (DELETE-FILE <string>) is built-in to Chez Scheme -;; Version 5.0c has R4RS macros, but not defmacro. +;; The FORCE-OUTPUT requires buffered output that has been written to a +;; port to be transferred all the way out to its ultimate destination. +(define force-output flush-output-port) -(define *defmacros* - (list (cons 'defmacro - (lambda (name parms . body) - `(set! *defmacros* (cons (cons ',name (lambda ,parms ,@body)) - *defmacros*)))))) -(define (defmacro? m) (and (assq m *defmacros*) #t)) +;;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string +;;; port versions of CALL-WITH-*PUT-FILE. -(define (macroexpand-1 e) - (if (pair? e) (let ((a (car e))) - (cond ((symbol? a) (set! a (assq a *defmacros*)) - (if a (apply (cdr a) (cdr e)) e)) - (else e))) - e)) +;;; CHAR-CODE-LIMIT is one greater than the largest integer which can +;;; be returned by CHAR->INTEGER. +(define char-code-limit 256) -(define (macroexpand e) - (if (pair? e) (let ((a (car e))) - (cond ((symbol? a) - (set! a (assq a *defmacros*)) - (if a (macroexpand (apply (cdr a) (cdr e))) e)) - (else e))) - e)) +;;; MOST-POSITIVE-FIXNUM is used in modular.scm +;; Chez's MOST-POSITIVE-FIXNUM is a thunk rather than a number. -(define base:eval eval) -(define (defmacro:eval x) (base:eval (defmacro:expand* x))) -(define (defmacro:expand* x) - (require 'defmacroexpand) (apply defmacro:expand* x '())) +(if (procedure? most-positive-fixnum) + (set! most-positive-fixnum (most-positive-fixnum))) + +;;; Return argument +(define (identity x) x) -;; Chez's sorting routines take parameters in the order opposite to SLIB's. -;; The following definitions override the predefined procedures with the -;; parameters-reversed versions. +;;; SLIB:EVAL is single argument eval using the top-level (user) environment. +(define slib:eval eval) + +;;; define an error procedure for the library +(define slib:error + (lambda args + (let ((port (current-error-port))) + (display "Error: " port) + (for-each (lambda (x) (display x port)) args) + (error #f "")))) + +;;; define these as appropriate for your system. +(define slib:tab #\tab) +(define slib:form-feed #\page) + +;;; Support for older versions of Scheme. Not enough code for its own file. +;;; last-pair is built-in to Chez Scheme +(define t #t) +(define nil #f) + +;;; Define these if your implementation's syntax can support it and if +;;; they are not already defined. +;;; 1+, -1+, and 1- are built-in to Chez Scheme +;(define (1+ n) (+ n 1)) +;(define (-1+ n) (+ n -1)) +;(define 1- -1+) + +;;; (IN-VICINITY <string>) is simply STRING-APPEND, conventionally used +;;; to attach a directory pathname to the name of a file that is expected to +;;; be in that directory. +(define in-vicinity string-append) + +;;; Define SLIB:EXIT to be the implementation procedure to exit or +;;; return if exitting not supported. +(define slib:chez:quit + (let ((arg (call-with-current-continuation identity))) + (cond ((procedure? arg) arg) + (arg (exit)) + (else (exit 1))))) + +(define slib:exit + (lambda args + (cond ((null? args) (slib:chez:quit #t)) + ((eqv? #t (car args)) (slib:chez:quit #t)) + ((eqv? #f (car args)) (slib:chez:quit #f)) + ((zero? (car args)) (slib:chez:quit #t)) + (else (slib:chez:quit #f))))) + +;;; For backward compatability, the SCHEME-FILE-SUFFIX procedure is defined +;;; to return the string ".scm". Note, however, that ".ss" is a common Chez +;;; file suffix. +(define scheme-file-suffix + (let ((suffix (case (software-type) + ((NOSVE) "_scm") + (else ".scm")))) + (lambda () suffix))) + +;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever +;;; suffix all the module files in SLIB have. See feature 'SOURCE. + +(define (slib:load-source f) (load (string-append f ".scm"))) + +;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced +;;; by compiling "foo.scm" if this implementation can compile files. +;;; See feature 'COMPILED. + +(define slib:load-compiled load) + +;;; At this point SLIB:LOAD must be able to load SLIB files. + +(define slib:load slib:load-source) + +;;; The following make procedures in Chez Scheme compatible with +;;; the assumptions of SLIB. + +;;; Chez's sorting routines take parameters in the order opposite to SLIB's. +;;; The following definitions override the predefined procedures with the +;;; parameters-reversed versions. See the SORT feature. (define chez:sort sort) (define chez:sort! sort!) @@ -211,7 +292,8 @@ (lambda (s1 s2 p) (chez:merge! p s1 s2))) -;; Chez's (FORMAT F . A) corresponds to SLIB's (FORMAT #F F . A) +;;; Chez's (FORMAT F . A) corresponds to SLIB's (FORMAT #F F . A) +;;; See the FORMAT feature. (define chez:format format) @@ -222,173 +304,86 @@ ((eq? where #t) (display str)) (else (display str where)))))) -;; Chez's NIL variable is bound to '(); SLIB's is bound to #F. - -(define nil #f) - -;; SLIB provides identifiers for the TAB (ASCII 9) and FORM-FEED (ASCII 12) -;; characters. - -(define slib:tab #\tab) -(define slib:form-feed #\page) - ;; The following definitions implement a few widely useful procedures that ;; Chez Scheme does not provide or provides under a different name. -;; The RENAME-FILE procedure constructs and executes a Unix mv command to -;; change the name of a file. - -(define rename-file - (lambda (src dst) - (system (string-append "mv " src " " dst)))) - -;; The CURRENT-ERROR-PORT procedure returns a port to which error -;; messages are to be displayed; this is the original standard output -;; port (even if the program subsequently changes the current output port -;; somehow). - -(define current-error-port - (let ((port (current-output-port))) - (lambda () port))) - -;; SLIB provides its own version of the ERROR procedure. - -(define slib:error - (lambda args - (let ((port (current-error-port))) - (display "Error: " port) - (for-each (lambda (x) (display x port)) args) - (error #f "")))) - -;; The TMPNAM procedure constructs and returns a temporary file name, -;; presumably unique and not a duplicate of one already existing. - -(define tmpnam - (let ((cntr 100)) - (lambda () - (set! cntr (+ 1 cntr)) - (let ((tmp (string-append "slib_" (number->string cntr)))) - (if (file-exists? tmp) (tmpnam) tmp))))) - -;; The FORCE-OUTPUT requires buffered output that has been written to a -;; port to be transferred all the way out to its ultimate destination. - -(define force-output flush-output) - -;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string -;; port versions of CALL-WITH-INPUT-FILE and CALL-WITH-OUTPUT-FILE. +;;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string +;;; port versions of CALL-WITH-INPUT-FILE and CALL-WITH-OUTPUT-FILE. +;;; See the STRING-PORT feature. (define call-with-output-string (lambda (f) (let ((outsp (open-output-string))) (f outsp) (let ((s (get-output-string outsp))) - (close-output-port outsp) - s)))) + (close-output-port outsp) + s)))) (define call-with-input-string (lambda (s f) (let* ((insp (open-input-string s)) - (res (f insp))) + (res (f insp))) (close-input-port insp) res))) -;; CHAR-CODE-LIMIT is the number of characters in the character set; only -;; non-negative integers less than CHAR-CODE-LIMIT are eligible as -;; arguments to INTEGER->CHAR. - -(define char-code-limit 256) - -;; Chez's MOST-POSITIVE-FIXNUM is a thunk rather than a number. - -(if (procedure? most-positive-fixnum) - (set! most-positive-fixnum (most-positive-fixnum))) - -;; The IDENTITY procedure returns its argument without change. - -(define identity - (lambda (x) x)) - -;; The GENTEMP procedure generates unused symbols and marks them as -;; belonging to the SLIB package. - -(define gentemp - (let ((*gensym-counter* -1)) - (lambda () - (set! *gensym-counter* (+ *gensym-counter* 1)) - (string->symbol - (string-append "slib:G" (number->string *gensym-counter*)))))) - -;; The IN-VICINITY procedure is simply STRING-APPEND, conventionally used -;; to attach a directory pathname to the name of a file that is expected to -;; be in that directory. - -(define in-vicinity string-append) - -;; For backward compatability, the SCHEME-FILE-SUFFIX procedure is defined -;; to return the string ".scm". Note, however, that ".ss" is a common Chez -;; file suffix. - -(define scheme-file-suffix - (lambda () ".scm")) - -;; SLIB appropriates Chez Scheme's EVAL procedure. - -(define slib:eval eval) +;;; If your implementation provides R4RS macros: (define macro:eval slib:eval) +;;; macro:load also needs the default suffix. +(define macro:load slib:load-source) -(define slib:eval-load - (lambda (<pathname> evl) - (if (not (file-exists? <pathname>)) - (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) - (call-with-input-file <pathname> - (lambda (port) - (let ((old-load-pathname *load-pathname*)) - (set! *load-pathname* <pathname>) - (do ((o (read port) (read port))) - ((eof-object? o)) - (evl o)) - (set! *load-pathname* old-load-pathname)))))) - -;; SLIB:EXIT is the implementation procedure that exits, or returns -;; if exiting is not supported. - -(define slib:chez:quit - (let ((arg (call-with-current-continuation identity))) - (cond ((procedure? arg) arg) - (arg (exit)) - (else (exit 1))))) - -(define slib:exit - (lambda args - (cond ((null? args) (slib:chez:quit #t)) - ((eqv? #t (car args)) (slib:chez:quit #t)) - ((eqv? #f (car args)) (slib:chez:quit #f)) - ((zero? (car args)) (slib:chez:quit #t)) - (else (slib:chez:quit #f))))) - -;; The SLIB:LOAD-SOURCE procedure, given a string argument, should attach -;; the appropriate file suffix to the string and load the file named -;; by the resulting string. - -(define slib:load-source - (lambda (f) - (load (string-append f (scheme-file-suffix))))) - -;;; defmacro:load and macro:load also need the default suffix. +(define *defmacros* + (list (cons 'defmacro + (lambda (name parms . body) + `(set! *defmacros* (cons (cons ',name (lambda ,parms ,@body)) + *defmacros*)))))) +(define (defmacro? m) (and (assq m *defmacros*) #t)) -(define macro:load slib:load-source) +(define (macroexpand-1 e) + (if (pair? e) (let ((a (car e))) + (cond ((symbol? a) (set! a (assq a *defmacros*)) + (if a (apply (cdr a) (cdr e)) e)) + (else e))) + e)) -;; The SLIB:LOAD-COMPILED procedure, given a string argument, finds and -;; loads the file, assumed to have been compiled. +(define (macroexpand e) + (if (pair? e) (let ((a (car e))) + (cond ((symbol? a) + (set! a (assq a *defmacros*)) + (if a (macroexpand (apply (cdr a) (cdr e))) e)) + (else e))) + e)) -(define slib:load-compiled load) +;;; According to Kent Dybvig, you can improve the Chez Scheme init +;;; file by defining gentemp to be gensym in Chez Scheme. +(define gentemp gensym) -;; SLIB:LOAD can now be defined to load SLIB files. +(define base:eval slib:eval) +(define (defmacro:eval x) (base:eval (defmacro:expand* x))) +(define (defmacro:expand* x) + (require 'defmacroexpand) (apply defmacro:expand* x '())) -(define slib:load slib:load-source) +(define (slib:eval-load <pathname> evl) + (if (not (file-exists? <pathname>)) + (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) + (call-with-input-file <pathname> + (lambda (port) + (let ((old-load-pathname *load-pathname*)) + (set! *load-pathname* <pathname>) + (do ((o (read port) (read port))) + ((eof-object? o)) + (evl o)) + (set! *load-pathname* old-load-pathname))))) + +(define (defmacro:load <pathname>) + (slib:eval-load <pathname> defmacro:eval)) + +(define slib:warn + (lambda args + (let ((port (current-error-port))) + (display "Warn: " port) + (for-each (lambda (x) (display x port)) args)))) -;; Load the REQUIRE package. +;;; Load the REQUIRE package. (slib:load (in-vicinity (library-vicinity) "require")) diff --git a/collect.scm b/collect.scm index abdf209..35a333d 100644 --- a/collect.scm +++ b/collect.scm @@ -23,10 +23,10 @@ (define-operation (collect:gen-elts <collection>) ;; return element generator ;; default behavior (cond ;; see utilities, below, for generators - ((vector? <collection>) (collect:vector-gen-elts <collection>)) + ((vector? <collection>) (collect:vector-gen-elts <collection>)) ((list? <collection>) (collect:list-gen-elts <collection>)) ((string? <collection>) (collect:string-gen-elts <collection>)) - (else + (else (slib:error "Operation not supported: GEN-ELTS " (yasos:print obj #f))) ) ) @@ -117,7 +117,7 @@ (let loop ( (count 0) ) (cond ((< count max+1) - (set! <seed> + (set! <seed> (apply <proc> <seed> (map (lambda (g) (g)) generators))) (loop (collect:add1 count)) ) @@ -171,7 +171,7 @@ (define (set-loop last this idx) (cond - ((zero? idx) + ((zero? idx) (set-cdr! last (cons <value> (cdr this))) <list> ) @@ -203,7 +203,7 @@ (let ( (max+1 (yasos:size vec)) (index 0) ) - (lambda () + (lambda () (cond ((< index max+1) (set! index (collect:add1 index)) (<accessor> vec (collect:sub1 index)) diff --git a/comlist.scm b/comlist.scm index 1751c7f..8ecf525 100644 --- a/comlist.scm +++ b/comlist.scm @@ -31,7 +31,7 @@ (define (comlist:copy-list lst) (append lst '())) -(define (comlist:adjoin e l) (if (memq e l) l (cons e l))) +(define (comlist:adjoin e l) (if (memv e l) l (cons e l))) (define (comlist:union l1 l2) (cond ((null? l1) l2) @@ -176,13 +176,22 @@ ((car args) #t) (else (apply comlist:or? (cdr args))))) -; Checks to see if a list has any duplicates. +;;; Checks to see if a list has any duplicate MEMBERs. (define (comlist:has-duplicates? lst) (cond ((null? lst) #f) ((member (car lst) (cdr lst)) #t) (else (comlist:has-duplicates? (cdr lst))))) -(define (comlist:list* x . y) +;;; remove duplicates of MEMBERs of a list +(define (comlist:remove-duplicates lst) + (letrec ((rem-dup + (lambda (lst nlst) + (cond ((null? lst) nlst) + ((member (car lst) nlst) (rem-dup (cdr lst) nlst)) + (else (rem-dup (cdr lst) (cons (car lst) nlst))))))) + (rem-dup lst '()))) + +(define (comlist:list* x . y) (define (list*1 x) (if (null? (cdr x)) (car x) @@ -283,7 +292,7 @@ ((equal? obj (car list)) (delete (cdr list))) (else (set-cdr! list (delete (cdr list))) - list)))) + list)))) (define (comlist:delete-if pred list) (let delete-if ((list list)) @@ -291,7 +300,7 @@ ((pred (car list)) (delete-if (cdr list))) (else (set-cdr! list (delete-if (cdr list))) - list)))) + list)))) (define (comlist:delete-if-not pred list) (let delete-if ((list list)) @@ -299,7 +308,7 @@ ((not (pred (car list))) (delete-if (cdr list))) (else (set-cdr! list (delete-if (cdr list))) - list)))) + list)))) ;;; exports @@ -330,6 +339,7 @@ (define and? comlist:and?) (define or? comlist:or?) (define has-duplicates? comlist:has-duplicates?) +(define remove-duplicates comlist:remove-duplicates) (define delete-if-not comlist:delete-if-not) (define delete-if comlist:delete-if) @@ -1,5 +1,5 @@ ;;;"cring.scm" Extend Scheme numerics to any commutative ring. -;Copyright (C) 1997 Aubrey Jaffer +;Copyright (C) 1997, 1998 Aubrey Jaffer ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -22,6 +22,68 @@ (require 'database-utilities) (require 'sort) +(define cring:db (create-database #f 'alist-table)) +(define (make-ruleset . rules) + (define name #f) + (cond ((and (not (null? rules)) (symbol? (car rules))) + (set! name (car rules)) + (set! rules (cdr rules))) + (else (set! name (gentemp)))) + (define-tables cring:db + (list name + '((op symbol) + (sub-op1 symbol) + (sub-op2 symbol)) + '((reduction expression)) + rules)) + (let ((table ((cring:db 'open-table) name #t))) + (and table + (list (table 'get 'reduction) + (table 'row:update) + table)))) +(define *ruleset* (make-ruleset 'default)) +(define (cring:define-rule . args) + (if *ruleset* + ((cadr *ruleset*) args) + (slib:warn "No ruleset in *ruleset*"))) + +(define (combined-rulesets . rulesets) + (define name #f) + (cond ((symbol? (car rulesets)) + (set! name (car rulesets)) + (set! rulesets (cdr rulesets))) + (else (set! name (gentemp)))) + (apply make-ruleset name + (apply append + (map (lambda (ruleset) (((caddr ruleset) 'row:retrieve*))) + rulesets)))) + +;;; Distribute * over + (and -) +(define distribute* + (make-ruleset + 'distribute* + `(* + identity + ,(lambda (exp1 exp2) + ;;(print 'distributing '* '+ exp1 exp2 '==>) + (apply + (map (lambda (trm) (* trm exp2)) (cdr exp1))))) + `(* - identity + ,(lambda (exp1 exp2) + ;;(print 'distributing '* '- exp1 exp2 '==>) + (apply - (map (lambda (trm) (* trm exp2)) (cdr exp1))))))) + +;;; Distribute / over + (and -) +(define distribute/ + (make-ruleset + 'distribute/ + `(/ + identity + ,(lambda (exp1 exp2) + ;;(print 'distributing '/ '+ exp1 exp2 '==>) + (apply + (map (lambda (trm) (/ trm exp2)) (cdr exp1))))) + `(/ - identity + ,(lambda (exp1 exp2) + ;;(print 'distributing '/ '- exp1 exp2 '==>) + (apply - (map (lambda (trm) (/ trm exp2)) (cdr exp1))))))) + (define (symbol-alpha? sym) (char-alphabetic? (string-ref (symbol->string sym) 0))) (define (expression-< x y) @@ -41,36 +103,6 @@ (else (expression-< (cdr x) (cdr y))))) (define (expression-sort seq) (sort! seq expression-<)) -(define cring:db (create-database #f 'alist-table)) -(define-tables cring:db - `(operation - ((op symbol) - (sub-op1 symbol) - (sub-op2 symbol)) - ((reduction expression)) - (;; This is the distributive rule (* over +) - (* + identity - ,(lambda (exp1 exp2) - ;;(print 'distributing '* '+ exp1 exp2 '==>) - (apply + (map (lambda (trm) (* trm exp2)) (cdr exp1))))) - (* - identity - ,(lambda (exp1 exp2) - ;;(print 'distributing '* '- exp1 exp2 '==>) - (apply - (map (lambda (trm) (* trm exp2)) (cdr exp1))))) - (/ + identity - ,(lambda (exp1 exp2) - ;;(print 'distributing '/ '+ exp1 exp2 '==>) - (apply + (map (lambda (trm) (/ trm exp2)) (cdr exp1))))) - (/ - identity - ,(lambda (exp1 exp2) - ;;(print 'distributing '/ '- exp1 exp2 '==>) - (apply - (map (lambda (trm) (/ trm exp2)) (cdr exp1)))))))) - -(define cring:op-tab ((cring:db 'open-table) 'operation #t)) -(define cring:rule (cring:op-tab 'get 'reduction)) -(define cring:defrule (cring:op-tab 'row:update)) -(define (cring:define-rule . args) (cring:defrule args)) - (define number* *) (define number+ +) (define number- -) @@ -425,8 +457,9 @@ (arg-loop arg.pows))))) (define (cring:try-rule op sop1 sop2 exp1 exp2) - (let ((rule (cring:rule op sop1 sop2))) - (and rule (rule exp1 exp2)))) + (and *ruleset* + (let ((rule ((car *ruleset*) op sop1 sop2))) + (and rule (rule exp1 exp2))))) (define (cring:apply-rule op exp1 exp2) (and (pair? exp1) diff --git a/dbrowse.scm b/dbrowse.scm index 8008c04..082cef3 100644 --- a/dbrowse.scm +++ b/dbrowse.scm @@ -1,5 +1,5 @@ ;;; "dbrowse.scm" relational-database-browser -; Copyright 1996, 1997 Aubrey Jaffer +; Copyright 1996, 1997, 1998 Aubrey Jaffer ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -47,13 +47,9 @@ table-name)))))))) (define (browse:display-dir table-name table) - (printf "%s Tables: -" table-name) + (printf "%s Tables:\\n" table-name) ((table 'for-each-row) - (lambda (row) - (printf " %s -" - (car row))))) + (lambda (row) (printf "\\t%s\\n" (car row))))) (define (browse:display-table table-name table) (let* ((width 18) @@ -65,8 +61,7 @@ (dw-integer (string-append dw "d")) (underline (string-append (make-string (+ -1 width) #\=) " ")) (form "")) - (printf "Table: %s -" table-name) + (printf "Table: %s\\n" table-name) (for-each (lambda (name) (printf dwp-string name)) (table 'column-names)) (newline) @@ -88,8 +83,7 @@ (printf dwp-string type)) (table 'column-types)) (newline) - (set! form (string-append form " -")) + (set! form (string-append form "\\n")) (for-each (lambda (domain) (printf underline)) (table 'column-domains)) (newline) diff --git a/debian/changelog b/debian/changelog index 3c6329a..1c67c6c 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,72 @@ +slib (2c7-1) unstable; urgency=low + + * New upstream. + * Add slibconfig back in. + + -- James LewisMoss <dres@debian.org> Mon, 6 Dec 1999 19:32:57 -0500 + +slib (2c6-2) unstable; urgency=low + + * Remove the slib$(VERSION).info file. Cut the diff back down to + size. + + -- James LewisMoss <dres@debian.org> Sat, 13 Nov 1999 14:10:38 -0500 + +slib (2c6-1) unstable; urgency=low + + * New upstream. + * Move docs to /usr/share. Up standards version. add /usr/doc symlink. + Move info files. Remove undocumented link. + + -- James LewisMoss <dres@debian.org> Sat, 13 Nov 1999 12:56:18 -0500 + +slib (2c5-6) unstable; urgency=low + + * Lowercase two vars in yasyn.scm (Fixes bug #37222) + + -- James LewisMoss <dres@debian.org> Sat, 10 Jul 1999 19:17:04 -0400 + +slib (2c5-5) unstable; urgency=low + + * Fix it so string-index isn't defined (now there is a + strsrch:string-index) (Fixes #38812) + + -- James LewisMoss <dres@debian.org> Fri, 9 Jul 1999 21:30:19 -0400 + +slib (2c5-4) unstable; urgency=low + + * Don't run slibconfig in postinst. (Fixes bug #38253, #37733, #37715, + #37746, #37809, #37917, #38123, #38462) + + -- James LewisMoss <dres@debian.org> Thu, 3 Jun 1999 20:19:53 -0400 + +slib (2c5-3) unstable; urgency=low + + * Run slibconfig in postinst. It was commented out there, but I don't + see any old bug reports on why it was commented out, so let's try + again. :) (Fixes bug #37221) + + -- James LewisMoss <dres@debian.org> Wed, 12 May 1999 22:37:02 -0400 + +slib (2c5-2) unstable; urgency=low + + * Link mklibcat.scm to mklibcat. Fixes a problem with using slib with + guile. + + -- James LewisMoss <dres@debian.org> Sun, 7 Mar 1999 21:51:35 -0500 + +slib (2c5-1) unstable; urgency=low + + * New upstream. + + -- James LewisMoss <dres@debian.org> Sun, 7 Mar 1999 10:10:27 -0500 + +slib (2c3-4) unstable; urgency=low + + * New maintainer. + + -- James LewisMoss <dres@debian.org> Fri, 26 Feb 1999 00:52:26 -0500 + slib (2c3-3) frozen unstable; urgency=low * Fixes #16235. @@ -49,4 +118,5 @@ slib (2a6-1) unstable; urgency=low Local variables: mode: debian-changelog +add-log-mailing-address: "dres@debian.org" End: diff --git a/debian/control b/debian/control index a1211f3..3b3cde5 100644 --- a/debian/control +++ b/debian/control @@ -1,8 +1,8 @@ Source: slib Section: devel Priority: optional -Maintainer: David N. Welton <davidw@efn.org> -Standards-Version: 2.1.1.2 +Maintainer: James LewisMoss <dres@debian.org> +Standards-Version: 3.0.0 Package: slib Architecture: all diff --git a/debian/postinst b/debian/postinst index b298e51..2e719ac 100644 --- a/debian/postinst +++ b/debian/postinst @@ -3,5 +3,15 @@ set -e install-info --quiet --section "Development" "Development" \ --description="The SLIB portable Scheme library" \ - /usr/info/slib.info.gz -# /usr/sbin/slibconfig + /usr/share/info/slib.info.gz + +# OK. This is bad because it really should be in the guile config or in some +# emacs-commond sort of package. +#/usr/sbin/slibconfig + +if [ "$1" = "configure" ]; then + if [ -d /usr/doc -a ! -e /usr/doc/slib -a -d /usr/share/doc/slib ]; then + ln -sf ../share/doc/slib /usr/doc/slib + fi +fi + diff --git a/debian/postrm b/debian/postrm index 03e39ad..abf12d1 100644 --- a/debian/postrm +++ b/debian/postrm @@ -2,3 +2,4 @@ set -e install-info --quiet --remove slib + diff --git a/debian/prerm b/debian/prerm new file mode 100644 index 0000000..853a5c4 --- /dev/null +++ b/debian/prerm @@ -0,0 +1,8 @@ +#!/bin/sh + +set -e + +if [ \( "$1" = "upgrade" -o "$1" = "remove" \) -a -L /usr/doc/slib ]; then + rm -f /usr/doc/slib +fi + diff --git a/debian/rules b/debian/rules index 7cba850..1a8c9a9 100755 --- a/debian/rules +++ b/debian/rules @@ -39,43 +39,42 @@ binary-indep: checkroot build $(INSTALL_DIR) debian/tmp $(INSTALL_DIR) debian/tmp/DEBIAN $(INSTALL_PROGRAM) debian/postinst debian/tmp/DEBIAN + $(INSTALL_PROGRAM) debian/prerm debian/tmp/DEBIAN $(INSTALL_PROGRAM) debian/postrm debian/tmp/DEBIAN # library $(INSTALL_DIR) debian/tmp/usr/share/slib $(INSTALL_DATA) *.scm debian/tmp/usr/share/slib + # this fixes a load problem with guile + ( cd debian/tmp/usr/share/slib ; ln -s mklibcat.scm mklibcat ) # documentation - $(INSTALL_DIR) debian/tmp/usr/doc/slib - $(INSTALL_DATA) debian/copyright debian/tmp/usr/doc/slib + $(INSTALL_DIR) debian/tmp/usr/share/doc/slib + $(INSTALL_DATA) debian/copyright debian/tmp/usr/share/doc/slib $(INSTALL_DATA) debian/changelog \ - debian/tmp/usr/doc/slib/changelog.Debian - gzip -9v debian/tmp/usr/doc/slib/changelog.Debian + debian/tmp/usr/share/doc/slib/changelog.Debian + gzip -9v debian/tmp/usr/share/doc/slib/changelog.Debian - $(INSTALL_DATA) ChangeLog debian/tmp/usr/doc/slib - gzip -9v debian/tmp/usr/doc/slib/ChangeLog - $(INSTALL_DATA) README debian/tmp/usr/doc/slib - gzip -9v debian/tmp/usr/doc/slib/README - $(INSTALL_DATA) FAQ debian/tmp/usr/doc/slib - gzip -9v debian/tmp/usr/doc/slib/FAQ - $(INSTALL_DATA) slib.html debian/tmp/usr/doc/slib + $(INSTALL_DATA) ChangeLog debian/tmp/usr/share/doc/slib/changelog + gzip -9v debian/tmp/usr/share/doc/slib/changelog + $(INSTALL_DATA) README debian/tmp/usr/share/doc/slib + gzip -9v debian/tmp/usr/share/doc/slib/README + $(INSTALL_DATA) FAQ debian/tmp/usr/share/doc/slib + gzip -9v debian/tmp/usr/share/doc/slib/FAQ + $(INSTALL_DATA) slib.html debian/tmp/usr/share/doc/slib $(INSTALL_DIR) debian/tmp/usr/share/slib/init $(INSTALL_DATA) *.init debian/tmp/usr/share/slib/init # info pages - $(INSTALL_DIR) debian/tmp/usr/info - $(INSTALL_DATA) slib.info* debian/tmp/usr/info - gzip -9v debian/tmp/usr/info/* + $(INSTALL_DIR) debian/tmp/usr/share/info + $(INSTALL_DATA) slib.info* debian/tmp/usr/share/info + gzip -9v debian/tmp/usr/share/info/* # slibconfig $(INSTALL_DIR) debian/tmp/usr/sbin $(INSTALL_PROGRAM) debian/slibconfig debian/tmp/usr/sbin - $(INSTALL_DIR) debian/tmp/usr/man/man8 - (cd debian/tmp/usr/man/man8; \ - ln -s ../man7/undocumented.7.gz slibconfig.8.gz \ - ) dpkg-gencontrol dpkg --build debian/tmp .. @@ -19,12 +19,12 @@ (require 'trace) (require 'break) +(require 'line-i/o) (define (for-each-top-level-definition-in-file file proc) (call-with-input-file file - (lambda - (port) + (lambda (port) (letrec ((walk (lambda (exp) @@ -45,6 +45,8 @@ ((defmacro define-syntax) "should do something clever here") ((define) (proc exp)))))))) + (if (eqv? #\# (peek-char port)) + (read-line port)) ;remove `magic-number' (do ((form (read port) (read port))) ((eof-object? form)) (walk form)))))) @@ -1,21 +1,7 @@ ;;;"elk.init" Initialisation file for SLIB for ELK 2.1 -*- Scheme -*- -;;; Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer. -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ; No guarantees are given about the correctness of any of the ; choices made below. Only enough work was done to get the require @@ -38,6 +24,13 @@ (define (scheme-implementation-type) 'Elk) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://www.informatik.uni-bremen.de/~net/elk/") + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. @@ -1,5 +1,5 @@ -;;;; "factor.scm", prime test and factorization for Scheme -;;; Copyright (C) 1991, 1992, 1993 Aubrey Jaffer. +;;;; "factor.scm" factorization, prime test and generation +;;; Copyright (C) 1991, 1992, 1993, 1998 Aubrey Jaffer. ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -17,8 +17,31 @@ ;promotional, or sales literature without prior written consent in ;each case. -(require 'random) +(require 'common-list-functions) (require 'modular) +(require 'random) +(require 'byte) + +;;@body +;;@0 is the random-state (@pxref{Random Numbers}) used by these +;;procedures. If you call these procedures from more than one thread +;;(or from interrupt), @code{random} may complain about reentrant +;;calls. +(define prime:prngs + (make-random-state "repeatable seed for primes")) + + +;;@emph{Note:} The prime test and generation procedures implement (or +;;use) the Solovay-Strassen primality test. See +;; +;;@itemize @bullet +;;@item Robert Solovay and Volker Strassen, +;;@cite{A Fast Monte-Carlo Test for Primality}, +;;SIAM Journal on Computing, 1977, pp 84-85. +;;@end itemize + +;;; Solovay-Strassen Prime Test +;;; if n is prime, then J(a,n) is congruent mod n to a**((n-1)/2) ;;; (modulo p 16) is because we care only about the low order bits. ;;; The odd? tests are inline of (expt -1 ...) @@ -35,41 +58,104 @@ (if (odd? (quotient (- (* qq qq) 1) 8)) (- (prime:jacobi-symbol (quotient p 2) q)) (prime:jacobi-symbol (quotient p 2) q)))))) +;;@args p q +;;Returns the value (+1, @minus{}1, or 0) of the Jacobi-Symbol of +;;exact non-negative integer @1 and exact positive odd integer @2. +(define jacobi-symbol prime:jacobi-symbol) -;;;; Solovay-Strassen Prime Test -;;; if n is prime, then J(a,n) is congruent mod n to a**((n-1)/2) - -;;; See: -;;; Robert Solovay and Volker Strassen, -;;; "A Fast Monte-Carlo Test for Primality," -;;; SIAM Journal on Computing, 1977, pp 84-85. +;;@body +;;@0 the maxinum number of iterations of Solovay-Strassen that will +;;be done to test a number for primality. +(define prime:trials 30) ;;; checks if n is prime. Returns #f if not prime. #t if (probably) prime. ;;; probability of a mistake = (expt 2 (- prime:trials)) ;;; choosing prime:trials=30 should be enough -(define prime:trials 30) -;;; prime:product is a product of small primes. -(define prime:product - (let ((p 210)) - (for-each (lambda (s) - (set! s (string->number s)) - (set! p (or (and s (exact? s) s) p))) - '("2310" "30030" "510510" "9699690" "223092870" - "6469693230" "200560490130")) - p)) +(define (Solovay-Strassen-prime? n) + (do ((i prime:trials (- i 1)) + (a (+ 2 (random (- n 2) prime:prngs)) + (+ 2 (random (- n 2) prime:prngs)))) + ((not (and (positive? i) + (= (gcd a n) 1) + (= (modulo (prime:jacobi-symbol a n) n) + (modular:expt n a (quotient (- n 1) 2))))) + (if (positive? i) #f #t)))) + +;;; prime:products are products of small primes. +(define (primes-gcd? n comps) + (comlist:notevery (lambda (prd) (= 1 (gcd n prd))) comps)) +(define prime:prime-sqr 121) +(define prime:products '(105)) +(define prime:sieve (bytes 0 0 1 1 0 1 0 1 0 0 0)) +(letrec ((lp (lambda (comp comps primes nexp) + (cond ((< comp (quotient most-positive-fixnum nexp)) + (let ((ncomp (* nexp comp))) + (lp ncomp comps + (cons nexp primes) + (next-prime nexp (cons ncomp comps))))) + ((< (quotient comp nexp) (* nexp nexp)) + (set! prime:prime-sqr (* nexp nexp)) + (set! prime:sieve (make-bytes nexp 0)) + (for-each (lambda (prime) + (byte-set! prime:sieve prime 1)) + primes) + (set! prime:products (reverse (cons comp comps)))) + (else + (lp nexp (cons comp comps) + (cons nexp primes) + (next-prime nexp (cons comp comps))))))) + (next-prime (lambda (nexp comps) + (set! comps (reverse comps)) + (do ((nexp (+ 2 nexp) (+ 2 nexp))) + ((not (primes-gcd? nexp comps)) nexp))))) + (lp 3 '() '(2 3) 5)) (define (prime:prime? n) (set! n (abs n)) - (cond ((<= n 36) (and (memv n '(2 3 5 7 11 13 17 19 23 29 31)) #t)) - ((= 1 (gcd n prime:product)) - (do ((i prime:trials (- i 1)) - (a (+ 1 (random (- n 1))) (+ 1 (random (- n 1))))) - ((not (and (positive? i) - (= (gcd a n) 1) - (= (modulo (prime:jacobi-symbol a n) n) - (modular:expt n a (quotient (- n 1) 2))))) - (if (positive? i) #f #t)))) - (else #f))) + (cond ((< n (bytes-length prime:sieve)) (positive? (byte-ref prime:sieve n))) + ((even? n) #f) + ((primes-gcd? n prime:products) #f) + ((< n prime:prime-sqr) #t) + (else (Solovay-Strassen-prime? n)))) +;;@args n +;;Returns @code{#f} if @1 is composite; @code{#t} if @1 is prime. +;;There is a slight chance @code{(expt 2 (- prime:trials))} that a +;;composite will return @code{#t}. +(define prime? prime:prime?) +(define probably-prime? prime:prime?) ;legacy + +(define (prime:prime< start) + (do ((nbr (+ -1 start) (+ -1 nbr))) + ((or (negative? nbr) (prime:prime? nbr)) + (if (negative? nbr) #f nbr)))) + +(define (prime:primes< start count) + (do ((cnt (+ -2 count) (+ -1 cnt)) + (lst '() (cons prime lst)) + (prime (prime:prime< start) (prime:prime< prime))) + ((or (not prime) (negative? cnt)) + (if prime (cons prime lst) lst)))) +;;@args start count +;;Returns a list of the first @2 prime numbers less than +;;@1. If there are fewer than @var{count} prime numbers +;;less than @var{start}, then the returned list will have fewer than +;;@var{start} elements. +(define primes< prime:primes<) + +(define (prime:prime> start) + (do ((nbr (+ 1 start) (+ 1 nbr))) + ((prime:prime? nbr) nbr))) + +(define (prime:primes> start count) + (set! start (max 0 start)) + (do ((cnt (+ -2 count) (+ -1 cnt)) + (lst '() (cons prime lst)) + (prime (prime:prime> start) (prime:prime> prime))) + ((negative? cnt) + (reverse (cons prime lst))))) +;;@args start count +;;Returns a list of the first @2 prime numbers greater than @1. +(define primes> prime:primes>) ;;;;Lankinen's recursive factoring algorithm: ;From: ld231782@longs.LANCE.ColoState.EDU (L. Detweiler) @@ -81,7 +167,7 @@ ; | f(u,v,2b,n/2) or f(u+b,v+b,2b,(n-u-v-b)/2) if n even ;Thm: f(1,1,2,(m-1)/2) = (p,q) iff pq=m for odd m. - + ;It may be illuminating to consider the relation of the Lankinen function in ;a `computational hierarchy' of other factoring functions.* Assumptions are ;made herein on the basis of conventional digital (binary) computers. Also, @@ -89,7 +175,7 @@ ;be factored is prime). However, all algorithms would probably perform to ;the same constant multiple of the given orders for complete composite ;factorizations. - + ;Thm: Eratosthenes' Sieve is very roughtly O(ln(n)/n) in time and ; O(n*log2(n)) in space. ;Pf: It works with all prime factors less than n (about ln(n)/n by the prime @@ -101,7 +187,7 @@ ;Pf: It tests all odd factors less than the square root of n (about ; sqrt(n)/2), with log2(n) time for each division. It requires only ; log2(n) space for the number and divisors. - + ;Thm: Lankinen's algorithm is O(sqrt(n)/2) in time and O((sqrt(n)/2)*log2(n)) ; in space. ;Pf: The algorithm is easily modified to seach only for factors p<q for all @@ -129,26 +215,31 @@ (or (prime:f (+ u b) v (+ b b) (quotient (- n v) 2)) (prime:f u (+ v b) (+ b b) (quotient (- n u) 2)))))) -(define (prime:factor m) - (case m - ((-1 0 1) (list m)) - (else - (if (negative? m) (cons -1 (prime:factor (- m))) - (let* ((s (gcd m prime:product)) - (r (quotient m s))) - (if (even? s) - (append - (if (= 1 r) '() (prime:factor r)) - (cons 2 (let ((s/2 (quotient s 2))) - (if (= s/2 1) '() - (or (prime:f 1 1 2 (quotient (- s/2 1) 2)) - (list s/2)))))) - (if (= 1 s) (or (prime:f 1 1 2 (quotient (- m 1) 2)) (list m)) - (append - (if (= 1 r) '() - (or (prime:f 1 1 2 (quotient (- r 1) 2)) (list r))) - (or (prime:f 1 1 2 (quotient (- s 1) 2)) (list s)))))))))) +(define (prime:fo m) + (let* ((s (gcd m (car prime:products))) + (r (quotient m s))) + (if (= 1 s) + (or (prime:f 1 1 2 (quotient (- m 1) 2)) (list m)) + (append + (if (= 1 r) '() + (or (prime:f 1 1 2 (quotient (- r 1) 2)) (list r))) + (or (prime:f 1 1 2 (quotient (- s 1) 2)) (list s)))))) -(define jacobi-symbol prime:jacobi-symbol) -(define prime? prime:prime?) +(define (prime:fe m) + (if (even? m) + (cons 2 (prime:fe (quotient m 2))) + (if (eqv? 1 m) + '() + (prime:fo m)))) + +(define (prime:factor k) + (case k + ((-1 0 1) (list k)) + (else (if (negative? k) + (cons -1 (prime:fe (- k))) + (prime:fe k))))) +;;@args k +;;Returns a list of the prime factors of @1. The order of the +;;factors is unspecified. In order to obtain a sorted list do +;;@code{(sort! (factor @var{k}) <)}. (define factor prime:factor) diff --git a/factor.txi b/factor.txi new file mode 100644 index 0000000..8277c2b --- /dev/null +++ b/factor.txi @@ -0,0 +1,73 @@ + + + +@defvar prime:prngs + + @var{prime:prngs} is the random-state (@pxref{Random Numbers}) used by these + procedures. If you call these procedures from more than one thread + (or from interrupt), @code{random} may complain about reentrant + calls. +@end defvar + + + + + + +@defun jacobi-symbol p q + + Returns the value (+1, @minus{}1, or 0) of the Jacobi-Symbol of + exact non-negative integer @var{p} and exact positive odd integer @var{q}. +@end defun + + +@defvar prime:trials + + @var{prime:trials} the maxinum number of iterations of Solovay-Strassen that will + be done to test a number for primality. +@end defvar + + + + +@defun prime? n + + Returns @code{#f} if @var{n} is composite; @code{#t} if @var{n} is prime. + There is a slight chance @code{(expt 2 (- prime:trials))} that a + composite will return @code{#t}. +@end defun + + + +@defun primes< start count + + Returns a list of the first @var{count} prime numbers less than + @var{start}. If there are fewer than @var{count} prime numbers + less than @var{start}, then the returned list will have fewer than + @var{start} elements. +@end defun + + + +@defun primes> start count + + Returns a list of the first @var{count} prime numbers greater than @var{start}. +@end defun + + + + + + + + + + + + +@defun factor k + + Returns a list of the prime factors of @var{k}. The order of the + factors is unspecified. In order to obtain a sorted list do + @code{(sort! (factor @var{k}) <)}. +@end defun @@ -0,0 +1,70 @@ +;;;"fft.scm" Fast Fourier Transform +;Copyright (C) 1999 Aubrey Jaffer +; +;Permission to copy this software, to redistribute it, and to use it +;for any purpose is granted, subject to the following restrictions and +;understandings. +; +;1. Any copy made of this software must include this copyright notice +;in full. +; +;2. I have made no warrantee or representation that the operation of +;this software will be error-free, and I am under no obligation to +;provide any services, by way of maintenance, update, or otherwise. +; +;3. In conjunction with products arising from the use of this +;material, there shall be no use of my name in any advertising, +;promotional, or sales literature without prior written consent in +;each case. + +;;;; See: +;;; Introduction to Algorithms (MIT Electrical +;;; Engineering and Computer Science Series) +;;; by Thomas H. Cormen, Charles E. Leiserson (Contributor), +;;; Ronald L. Rivest (Contributor) +;;; MIT Press; ISBN: 0-262-03141-8 (July 1990) + +;;; http://www.astro.virginia.edu/~eww6n/math/DiscreteFourierTransform.html +;;; differs in the direction of rotation of the complex unit vectors. + +(require 'array) + +(define (fft:shuffled&scaled ara n scale) + (define lgn (integer-length (+ -1 n))) + (define new (apply make-array 0 (array-dimensions ara))) + (define bit-reverse (lambda (width in) + (if (zero? width) 0 + (+ (bit-reverse (+ -1 width) (quotient in 2)) + (ash (modulo in 2) (+ -1 width)))))) + (if (not (eqv? n (expt 2 lgn))) + (slib:error 'fft "array length not power of 2" n)) + (do ((k 0 (+ 1 k))) + ((>= k n) new) + (array-set! new (* (array-ref ara k) scale) (bit-reverse lgn k)))) + +(define (dft! ara n dir) + (define lgn (integer-length (+ -1 n))) + (define pi2i (* 0+8i (atan 1))) + (do ((s 1 (+ 1 s))) + ((> s lgn) ara) + (let* ((m (expt 2 s)) + (w_m (exp (* dir (/ pi2i m)))) + (m/2-1 (+ (quotient m 2) -1))) + (do ((j 0 (+ 1 j)) + (w 1 (* w w_m))) + ((> j m/2-1)) + (do ((k j (+ m k))) + ((>= k n)) + (let* ((k+m/2 (+ k m/2-1 1)) + (t (* w (array-ref ara k+m/2))) + (u (array-ref ara k))) + (array-set! ara (+ u t) k) + (array-set! ara (- u t) k+m/2))))))) + +(define (fft ara) + (define n (car (array-dimensions ara))) + (dft! (fft:shuffled&scaled ara n 1) n 1)) + +(define (fft-1 ara) + (define n (car (array-dimensions ara))) + (dft! (fft:shuffled&scaled ara n (/ n)) n -1)) diff --git a/fluidlet.scm b/fluidlet.scm index c93b288..59ba481 100644 --- a/fluidlet.scm +++ b/fluidlet.scm @@ -1,5 +1,5 @@ ; "fluidlet.scm", FLUID-LET for Scheme -; Copyright (c) 1992, Dorai Sitaram (dorai@cs.rice.edu) +; Copyright (c) 1998, Aubrey Jaffer ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -17,29 +17,24 @@ ;promotional, or sales literature without prior written consent in ;each case. -(require 'rev4-optional-procedures) -(require 'common-list-functions) (require 'dynamic-wind) -(require 'macro) +(require 'common-list-functions) ;MAKE-LIST -(define list-set! (lambda (s i v) (set-car! (list-tail s i) v))) - -(define-syntax fluid-let - (syntax-rules () - ((fluid-let ((x v) ...) . body) - (let ((%x-names (list 'x ...)) - (%x-values (list x ...)) - (%fluid-x-values (list v ...))) +(defmacro fluid-let (clauses . body) + (let ((ids (map car clauses)) + (new-tmps (map (lambda (x) (gentemp)) clauses)) + (old-tmps (map (lambda (x) (gentemp)) clauses))) + `(let (,@(map list new-tmps (map cadr clauses)) + ,@(map list old-tmps (make-list (length clauses) #f))) (dynamic-wind - (lambda () - (set! x (list-ref %fluid-x-values - (comlist:position 'x %x-names))) - ...) - (lambda () . body) - (lambda () - (let ((%x-position (comlist:position 'x %x-names))) - (list-set! %fluid-x-values %x-position x) - (set! x (list-ref %x-values %x-position))) - ...)))))) - -;--- end of file + (lambda () + ,@(map (lambda (ot id) `(set! ,ot ,id)) + old-tmps ids) + ,@(map (lambda (id nt) `(set! ,id ,nt)) + ids new-tmps)) + (lambda () ,@body) + (lambda () + ,@(map (lambda (nt id) `(set! ,nt ,id)) + new-tmps ids) + ,@(map (lambda (id ot) `(set! ,id ,ot)) + ids old-tmps)))))) @@ -113,9 +113,9 @@ (substring format-string 0 format:pos) (substring format-string format:pos (string-length format-string)) - (list-head (cddr format:args) format:arg-pos) + (format:list-head (cddr format:args) format:arg-pos) (list-tail (cddr format:args) format:arg-pos))) - (format port + (format port "~%FORMAT: error with call: (format~{ ~a~})~% " format:args)) (apply format port args) @@ -140,28 +140,34 @@ (set! format:pos 0) (if (< (length args) 1) (format:error "not enough arguments")) - (let ((destination (car args)) - (arglist (cdr args))) - (cond - ((or (and (boolean? destination) ; port output - destination) - (output-port? destination) - (number? destination)) - (format:out (cond - ((boolean? destination) (current-output-port)) - ((output-port? destination) destination) - ((number? destination) (current-error-port))) - (car arglist) (cdr arglist))) - ((and (boolean? destination) ; string output - (not destination)) - (call-with-output-string - (lambda (port) (format:out port (car arglist) (cdr arglist))))) - ((string? destination) ; dest. is format string (Scheme->C) - (call-with-output-string - (lambda (port) - (format:out port destination arglist)))) - (else - (format:error "illegal destination `~a'" destination))))) + + ;; If the first argument is a string, then that's the format string. + ;; (Scheme->C) + ;; In this case, put the argument list in canonical form. + (let ((args (if (string? (car args)) + (cons #f args) + args))) + ;; Use this canonicalized version when reporting errors. + (set! format:args args) + + (let ((destination (car args)) + (arglist (cdr args))) + (cond + ((or (and (boolean? destination) ; port output + destination) + (output-port? destination) + (number? destination)) + (format:out (cond + ((boolean? destination) (current-output-port)) + ((output-port? destination) destination) + ((number? destination) (current-error-port))) + (car arglist) (cdr arglist))) + ((and (boolean? destination) ; string output + (not destination)) + (call-with-output-string + (lambda (port) (format:out port (car arglist) (cdr arglist))))) + (else + (format:error "illegal destination `~a'" destination)))))) (define (format:out port fmt args) ; the output handler for a port (set! format:port port) ; global port for output routines @@ -248,7 +254,7 @@ (if (= k 0) l (loop (cdr l) (- k 1)))))) (add-arg-pos - (lambda (n) + (lambda (n) (set! arg-pos (+ n arg-pos)) (set! format:arg-pos arg-pos))) @@ -491,7 +497,7 @@ ((#\() ; Case conversion begin (set! format:case-conversion (case modifier - ((at) string-capitalize-first) + ((at) format:string-capitalize-first) ((colon) string-capitalize) ((colon-at) string-upcase) (else string-downcase))) @@ -529,7 +535,7 @@ (cond ((eq? modifier 'colon) (set! clause-default #t) - (substring format-string clause-pos + (substring format-string clause-pos (- format:pos 3))) ((memq modifier '(at colon-at)) (format:error "illegal modifier in ~~;")) @@ -689,13 +695,14 @@ ;; format directive modifiers and parameters ((#\@) ; `@' modifier - (if (eq? modifier 'colon-at) + (if (memq modifier '(at colon-at)) (format:error "double `@' modifier")) (set! modifier (if (eq? modifier 'colon) 'colon-at 'at)) (tilde-dispatch)) ((#\:) ; `:' modifier - (if modifier (format:error "illegal `:' modifier position")) - (set! modifier 'colon) + (if (memq modifier '(colon colon-at)) + (format:error "double `:' modifier")) + (set! modifier (if (eq? modifier 'at) 'colon-at 'colon)) (tilde-dispatch)) ((#\') ; Character parameter (if modifier (format:error "misplaced modifier")) @@ -782,29 +789,29 @@ (loop j (+ j 1))) (loop i (+ j 1)))))))) obj)) - + ((boolean? obj) (if obj "#t" "#f")) - + ((number? obj) (number->string obj)) - ((symbol? obj) + ((symbol? obj) (if format:symbol-case-conv (format:symbol-case-conv (symbol->string obj)) (symbol->string obj))) - + ((char? obj) (if slashify (format:char->str obj) (string obj))) - + ((null? obj) "()") ((input-port? obj) (format:iobj->str obj)) - + ((output-port? obj) (format:iobj->str obj)) - + ((list? obj) (string-append "(" (let loop ((obj-list obj)) @@ -822,16 +829,16 @@ " . " (format:obj->str (cdr obj) #t) ")")) - + ((vector? obj) (string-append "#" (format:obj->str (vector->list obj) #t))) - (else ; only objects with an #<...> + (else ; only objects with an #<...> (format:iobj->str obj)))) ; representation should fall in here -;; format:iobj->str reveals the implementation dependent representation of +;; format:iobj->str reveals the implementation dependent representation of ;; #<...> objects with the use of display and call-with-output-string. -;; If format:read-proof is set to #t the resulting string is additionally +;; If format:read-proof is set to #t the resulting string is additionally ;; set into string quotes. (define format:read-proof #f) @@ -839,7 +846,7 @@ (define (format:iobj->str iobj) (if (or format:read-proof format:iobj-case-conv) - (string-append + (string-append (if format:read-proof "\"" "") (if format:iobj-case-conv (format:iobj-case-conv @@ -881,7 +888,7 @@ (if par (if name (if (< par 0) - (format:error + (format:error "~s parameter must be a positive integer" name) par) par) @@ -927,7 +934,7 @@ (if (and (memq modifier '(at colon-at)) (> number 0)) (set! numlen (+ numlen 1))) (if (memq modifier '(colon colon-at)) - (set! numlen (+ (quotient (- numstr-len + (set! numlen (+ (quotient (- numstr-len (if (< number 0) 2 1)) commawidth) numlen))) @@ -1071,7 +1078,8 @@ (if (> ones 0) (cons #\- (string->list - (list-ref format:cardinal-ones-list ones)))))))))) + (list-ref format:cardinal-ones-list ones))) + '()))))))) (define format:cardinal-thousand-block-list '("" " thousand" " million" " billion" " trillion" " quadrillion" @@ -1173,7 +1181,7 @@ (if digits (begin ; fixed precision - (format:parse-float + (format:parse-float (if (string? number) number (number->string number)) #t scale) (if (<= (- format:fn-len format:fn-dot) digits) (format:fn-zfill #f (- digits (- format:fn-len format:fn-dot))) @@ -1230,7 +1238,7 @@ (overch (format:par pars l 4 #f #f)) (padch (format:par pars l 5 format:space-ch #f)) (expch (format:par pars l 6 #f #f))) - + (if digits ; fixed precision (let ((digits (if (> scale 0) @@ -1238,7 +1246,7 @@ (+ (- digits scale) 1) 0) digits))) - (format:parse-float + (format:parse-float (if (string? number) number (number->string number)) #f scale) (if (<= (- format:fn-len format:fn-dot) digits) (format:fn-zfill #f (- digits (- format:fn-len format:fn-dot))) @@ -1250,11 +1258,11 @@ (if (or (not format:fn-pos?) (eq? modifier 'at)) (set! numlen (+ numlen 1))) (if (and (= format:fn-dot 0) (> width (+ digits 1))) - (set! numlen (+ numlen 1))) + (set! numlen (+ numlen 1))) (set! numlen - (+ numlen + (+ numlen (if (and edigits (>= edigits format:en-len)) - edigits + edigits format:en-len))) (if (< numlen width) (format:out-fill (- width numlen) @@ -1283,7 +1291,7 @@ (set! numlen (+ numlen (if (and edigits (>= edigits format:en-len)) - edigits + edigits format:en-len))) (if (< numlen width) (format:out-fill (- width numlen) @@ -1292,7 +1300,7 @@ (let ((f (- format:fn-len format:fn-dot))) ; fract len (if (> (- numlen f) width) (if overch ; numstr too big for required width - (format:out-fill width + (format:out-fill width (integer->char overch)) (begin (format:fn-out modifier #t) @@ -1307,7 +1315,7 @@ (begin (format:fn-out modifier #t) (format:en-out edigits expch)))))))) - + ;; format general flonums (~G) (define (format:out-general modifier number pars) @@ -1429,7 +1437,7 @@ (begin ; fixed format m.nnn or .nnn (if (and (> left-zeros 0) (> format:fn-dot 0)) - (if (> format:fn-dot left-zeros) + (if (> format:fn-dot left-zeros) (begin ; norm 0{0}nn.mm to nn.mm (format:fn-shiftleft left-zeros) (set! left-zeros 0) @@ -1470,7 +1478,7 @@ (set! format:fn-dot 1))) (format:en-set (- (+ (- format:fn-dot scale) (format:en-int)) negexp)) - (cond + (cond (all-zeros? (format:en-set 0) (set! format:fn-dot 1)) @@ -1484,10 +1492,10 @@ (set! format:fn-dot scale))))) #t) - ;; do body + ;; do body (set! c (string-ref num-str i)) ; parse the output of number->string (cond ; which can be any valid number - ((char-numeric? c) ; representation of R4RS except + ((char-numeric? c) ; representation of R4RS except (if mantissa? ; complex numbers (begin (if (char=? c #\0) @@ -1521,7 +1529,7 @@ 0 (do ((i 0 (+ i 1)) (n 0)) - ((= i format:en-len) + ((= i format:en-len) (if format:en-pos? n (- n))) @@ -1581,14 +1589,14 @@ (set! c (+ (- (char->integer (string-ref format:fn-str i)) format:zero-ch) c)) (string-set! format:fn-str i (integer->char - (if (< c 10) + (if (< c 10) (+ c format:zero-ch) (+ (- c 10) format:zero-ch)))) (set! c (if (< c 10) 0 1)))) (define (format:fn-out modifier add-leading-zero?) (if format:fn-pos? - (if (eq? modifier 'at) + (if (eq? modifier 'at) (format:out-char #\+)) (format:out-char #\-)) (if (= format:fn-dot 0) @@ -1601,7 +1609,7 @@ (define (format:en-out edigits expch) (format:out-char (if expch (integer->char expch) format:expch)) (format:out-char (if format:en-pos? #\+ #\-)) - (if edigits + (if edigits (if (< format:en-len edigits) (format:out-fill (- edigits format:en-len) #\0))) (format:out-substr format:en-str 0 format:en-len)) @@ -1624,18 +1632,7 @@ ;;; some global functions not found in SLIB -;; string-index finds the index of the first occurence of the character `c' -;; in the string `s'; it returns #f if there is no such character in `s'. - -(define (string-index s c) - (let ((slen-1 (- (string-length s) 1))) - (let loop ((i 0)) - (cond - ((char=? c (string-ref s i)) i) - ((= i slen-1) #f) - (else (loop (+ i 1))))))) - -(define (string-capitalize-first str) ; "hello" -> "Hello" +(define (format:string-capitalize-first str) ; "hello" -> "Hello" (let ((cap-str (string-copy str)) ; "hELLO" -> "Hello" (non-first-alpha #f) ; "*hello" -> "*Hello" (str-len (string-length str))) ; "hello you" -> "Hello you" @@ -1649,10 +1646,10 @@ (set! non-first-alpha #t) (string-set! cap-str i (char-upcase c))))))))) -(define (list-head l k) +(define (format:list-head l k) (if (= k 0) '() - (cons (car l) (list-head (cdr l) (- k 1))))) + (cons (car l) (format:list-head (cdr l) (- k 1))))) ;; Aborts the program when a formatting error occures. This is a null diff --git a/formatst.scm b/formatst.scm index 370a39c..3f19130 100644 --- a/formatst.scm +++ b/formatst.scm @@ -7,7 +7,7 @@ ; Failure reports for various scheme interpreters: ; -; SCM4d +; SCM4d ; None. ; Elk 2.2: ; None. @@ -16,7 +16,7 @@ ; represented as `#f'. ; Scheme->C 01nov91: ; None, if format:symbol-case-conv and format:iobj-case-conv are set -; to string-downcase. +; to string-downcase. (require 'format) (if (not (string=? format:version "3.0")) @@ -82,7 +82,7 @@ (test '("~a" #t) "#t") (test '("~a" #f) "#f") (test '("~a" "abc") "abc") -(test '("~a" '#(1 2 3)) "#(1 2 3)") +(test '("~a" #(1 2 3)) "#(1 2 3)") (test '("~a" ()) "()") (test '("~a" (a)) "(a)") (test '("~a" (a b)) "(a b)") @@ -294,7 +294,7 @@ def") (test '("~a" "abc \" abc") "abc \" abc") (test '("~s" #\space) "#\\space") (test '("~s" #\newline) "#\\newline") -(test '("~s" #\tab) "#\\ht") +(test `("~s" ,slib:tab) "#\\ht") (test '("~s" #\a) "#\\a") (test '("~a" (a "b" c)) "(a \"b\" c)") @@ -576,7 +576,7 @@ def") " 31. | 31.4 | 31.4 | 31. ") (test '("~9,2,1,,'*g|~9,3,2,3,'?,,'$g|~9,3,2,0,'%g|~9,2g" 314.159 314.159 314.159 314.159) - " 3.14E+2| 314. | 314. | 3.14E+2") + " 3.14E+2| 314. | 314. | 3.14E+2") (test '("~9,2,1,,'*g|~9,3,2,3,'?,,'$g|~9,3,2,0,'%g|~9,2g" 3141.59 3141.59 3141.59 3141.59) " 3.14E+3|314.2$+01|0.314E+04| 3.14E+3") @@ -586,8 +586,8 @@ def") (test '("~9,2,1,,'*g|~9,3,2,3,'?,,'$g|~9,3,2,0,'%g|~9,2g" 3.14E120 3.14E120 3.14E120 3.14E120) "*********|?????????|%%%%%%%%%|3.14E+120") - - (test '("~g" 0.0) "0.0 ") ; further ~g tests + + (test '("~g" 0.0) "0.0 ") ; further ~g tests (test '("~g" 0.1) "0.1 ") (test '("~g" 0.01) "1.0E-2") (test '("~g" 123.456) "123.456 ") @@ -624,7 +624,7 @@ def") ; complex numbers -(cond +(cond (format:complex-numbers (test '("~i" 3.0) "3.0+0.0i") (test '("~,3i" 3.0) "3.000+0.000i") @@ -634,7 +634,7 @@ def") (test `("~7,2,,,'*@i" ,(string->number "3.0+5.0i")) "**+3.00**+5.00i") )) ; note: some parsers choke syntactically on reading a complex ; number though format:complex is #f; this is why we put them in - ; strings + ; strings ; inquiry test diff --git a/gambit.init b/gambit.init index 255476f..45dd4e2 100644 --- a/gambit.init +++ b/gambit.init @@ -1,21 +1,7 @@ -;;;"gambit.init" Initialisation for SLIB for Gambit -*-scheme-*- -;;; Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;;"gambit.init" Initialization for SLIB for Gambit -*-scheme-*- +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; Updated 1992 February 1 for Gambit v1.71 -- by Ken Dickey ;;; Date: Wed, 12 Jan 1994 15:03:12 -0500 @@ -23,11 +9,25 @@ ;;; Relative pathnames for Slib in MacGambit ;;; Hacked yet again for Gambit v2.4, Jan 1997, by Mike Pope -(define (software-type) 'UNIX) ; 'MACOS for MacGambit. +(define (software-type) 'MACOS) ; for MacGambit. +(define (software-type) 'UNIX) ; for Unix platforms. (define (scheme-implementation-type) 'gambit) -(define (scheme-implementation-version) "2.4") +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://www.iro.umontreal.ca/~gambit/index.html") + +(define (scheme-implementation-version) "3.0") +;;; Jefferson R. Lowrey reports that in Gambit Version 3.0 +;;; (argv) returns '(""). +(define argv + (if (equal? '("") (argv)) ;Fix only if it is broken. + (lambda () '("Lowrey HD:Development:MacGambit 3.0:Interpreter")) + argv)) ;;; (implementation-vicinity) should be defined to be the pathname of ;;; the directory where any auxillary files to your Scheme @@ -58,7 +58,7 @@ (let ((library-path (case (software-type) ((UNIX) "/usr/local/lib/slib/") - ((MACOS) (string-append (implementation-vicinity) ":slib:")) + ((MACOS) (string-append (implementation-vicinity) "slib:")) ((AMIGA) "dh0:scm/Library/") ((VMS) "lib$scheme:") ((WINDOWS MS-DOS) "C:\\SLIB\\") @@ -1,4 +1,4 @@ -;;; glob.scm: String matching for filenames (a la BASH). +;;; "glob.scm" String matching for filenames (a la BASH). ;;; Copyright (C) 1998 Radey Shouman. ; ;Permission to copy this software, to redistribute it, and to use it @@ -17,26 +17,68 @@ ;promotional, or sales literature without prior written consent in ;each case. -;;$Header: /usr/local/cvsroot/slib/glob.scm,v 1.2 1998/09/03 15:34:59 jaffer Exp $ +;;$Header: /usr/local/cvsroot/slib/glob.scm,v 1.15 1999/11/01 01:37:08 jaffer Exp $ ;;$Name: $ -(define (glob:match?? pat) - (glob:make-matcher pat char-ci=? char=?)) -(define (glob:match-ci?? pat) - (glob:make-matcher pat char-ci<=? char<=?)) +(define (glob:pattern->tokens pat) + (cond + ((string? pat) + (let loop ((i 0) + (toks '())) + (if (>= i (string-length pat)) + (reverse toks) + (let ((pch (string-ref pat i))) + (case pch + ((#\? #\*) + (loop (+ i 1) + (cons (substring pat i (+ i 1)) toks))) + ((#\[) + (let ((j + (let search ((j (+ i 2))) + (cond + ((>= j (string-length pat)) + (slib:error 'glob:make-matcher + "unmatched [" pat)) + ((char=? #\] (string-ref pat j)) + (if (and (< (+ j 1) (string-length pat)) + (char=? #\] (string-ref pat (+ j 1)))) + (+ j 1) + j)) + (else (search (+ j 1))))))) + (loop (+ j 1) (cons (substring pat i (+ j 1)) toks)))) + (else + (let search ((j (+ i 1))) + (cond ((= j (string-length pat)) + (loop j (cons (substring pat i j) toks))) + ((memv (string-ref pat j) '(#\? #\* #\[)) + (loop j (cons (substring pat i j) toks))) + (else (search (+ j 1))))))))))) + ((pair? pat) + (for-each (lambda (elt) (or (string? elt) + (slib:error 'glob:pattern->tokens + "bad pattern" pat))) + pat) + pat) + (else (slib:error 'glob:pattern->tokens "bad pattern" pat)))) (define (glob:make-matcher pat ch=? ch<=?) - (define (match-end str k) - (= k (string-length str))) - (define (match-char ch nxt) - (lambda (str k) - (and (< k (string-length str)) - (ch=? ch (string-ref str k)) - (nxt str (+ k 1))))) + (define (match-end str k kmatch) + (and (= k (string-length str)) (reverse (cons k kmatch)))) + (define (match-str pstr nxt) + (let ((plen (string-length pstr))) + (lambda (str k kmatch) + (and (<= (+ k plen) (string-length str)) + (let loop ((i 0)) + (cond ((= i plen) + (nxt str (+ k plen) (cons k kmatch))) + ((ch=? (string-ref pstr i) + (string-ref str (+ k i))) + (loop (+ i 1))) + (else #f))))))) (define (match-? nxt) - (lambda (str k) + (lambda (str k kmatch) (and (< k (string-length str)) - (nxt str (+ k 1))))) + (nxt str (+ k 1) (cons k kmatch))))) (define (match-set1 chrs) (let recur ((i 0)) (cond ((= i (string-length chrs)) @@ -53,67 +95,133 @@ (chrsi (string-ref chrs i))) (lambda (ch) (or (ch=? chrsi ch) (nxt ch)))))))) - (define (match-set chrs nxt) - (if (and (positive? (string-length chrs)) - (memv (string-ref chrs 0) '(#\^ #\!))) - (let ((pred (match-set1 (substring chrs 1 (string-length chrs))))) - (lambda (str k) - (and (< k (string-length str)) - (not (pred (string-ref str k))) - (nxt str (+ k 1))))) - (let ((pred (match-set1 chrs))) - (lambda (str k) - (and (< k (string-length str)) - (pred (string-ref str k)) - (nxt str (+ k 1))))))) + (define (match-set tok nxt) + (let ((chrs (substring tok 1 (- (string-length tok) 1)))) + (if (and (positive? (string-length chrs)) + (memv (string-ref chrs 0) '(#\^ #\!))) + (let ((pred (match-set1 (substring chrs 1 (string-length chrs))))) + (lambda (str k kmatch) + (and (< k (string-length str)) + (not (pred (string-ref str k))) + (nxt str (+ k 1) (cons k kmatch))))) + (let ((pred (match-set1 chrs))) + (lambda (str k kmatch) + (and (< k (string-length str)) + (pred (string-ref str k)) + (nxt str (+ k 1) (cons k kmatch)))))))) (define (match-* nxt) - (lambda (str k) - (let loop ((kk (string-length str))) - (and (>= kk k) - (or (nxt str kk) - (loop (- kk 1))))))) + (lambda (str k kmatch) + (let ((kmatch (cons k kmatch))) + (let loop ((kk (string-length str))) + (and (>= kk k) + (or (nxt str kk kmatch) + (loop (- kk 1)))))))) (let ((matcher - (let recur ((i 0)) - (if (= i (string-length pat)) + (let recur ((toks (glob:pattern->tokens pat))) + (if (null? toks) match-end - (let ((pch (string-ref pat i))) + (let ((pch (or (string=? (car toks) "") + (string-ref (car toks) 0)))) (case pch - ((#\?) - (let ((nxt (recur (+ i 1)))) - (match-? nxt))) - ((#\*) - (let ((nxt (recur (+ i 1)))) - (match-* nxt))) - ((#\[) - (let ((j - (let search ((j (+ i 2))) - (cond - ((>= j (string-length pat)) - (slib:error 'glob:make-matcher - "unmatched [" pat)) - ((char=? #\] (string-ref pat j)) - (if (and (< (+ j 1) (string-length pat)) - (char=? #\] (string-ref pat (+ j 1)))) - (+ j 1) - j)) - (else (search (+ j 1))))))) - (let ((nxt (recur (+ j 1)))) - (match-set (substring pat (+ i 1) j) nxt)))) - (else (let ((nxt (recur (+ i 1)))) - (match-char pch nxt))))))))) - (lambda (str) (matcher str 0)))) + ((#\?) (match-? (recur (cdr toks)))) + ((#\*) (match-* (recur (cdr toks)))) + ((#\[) (match-set (car toks) (recur (cdr toks)))) + (else (match-str (car toks) (recur (cdr toks)))))))))) + (lambda (str) (matcher str 0 '())))) + +(define (glob:caller-with-matches pat proc ch=? ch<=?) + (define (glob:wildcard? pat) + (cond ((string=? pat "") #f) + ((memv (string-ref pat 0) '(#\* #\? #\[)) #t) + (else #f))) + (let* ((toks (glob:pattern->tokens pat)) + (wild? (map glob:wildcard? toks)) + (matcher (glob:make-matcher toks ch=? ch<=?))) + (lambda (str) + (let loop ((inds (matcher str)) + (wild? wild?) + (res '())) + (cond ((not inds) #f) + ((null? wild?) + (apply proc (reverse res))) + ((car wild?) + (loop (cdr inds) + (cdr wild?) + (cons (substring str (car inds) (cadr inds)) res))) + (else + (loop (cdr inds) (cdr wild?) res))))))) + +(define (glob:make-substituter pattern template ch=? ch<=?) + (define (wildcard? pat) + (cond ((string=? pat "") #f) + ((memv (string-ref pat 0) '(#\* #\? #\[)) #t) + (else #f))) + (define (countq val lst) + (do ((lst lst (cdr lst)) + (c 0 (if (eq? val (car lst)) (+ c 1) c))) + ((null? lst) c))) + (let ((tmpl-literals (map (lambda (tok) + (if (wildcard? tok) #f tok)) + (glob:pattern->tokens template))) + (pat-wild? (map wildcard? (glob:pattern->tokens pattern))) + (matcher (glob:make-matcher pattern ch=? ch<=?))) + (or (= (countq #t pat-wild?) (countq #f tmpl-literals)) + (slib:error 'glob:make-substituter + "number of wildcards doesn't match" pattern template)) + (lambda (str) + (let ((indices (matcher str))) + (and indices + (let loop ((inds indices) + (wild? pat-wild?) + (lits tmpl-literals) + (res '())) + (cond + ((null? lits) + (apply string-append (reverse res))) + ((car lits) + (loop inds wild? (cdr lits) (cons (car lits) res))) + ((null? wild?) ;this should never happen. + (loop '() '() lits res)) + ((car wild?) + (loop (cdr inds) (cdr wild?) (cdr lits) + (cons (substring str (car inds) (cadr inds)) + res))) + (else + (loop (cdr inds) (cdr wild?) lits res))))))))) + +(define (glob:match?? pat) + (glob:make-matcher pat char=? char<=?)) +(define (glob:match-ci?? pat) + (glob:make-matcher pat char-ci=? char-ci<=?)) (define filename:match?? glob:match??) (define filename:match-ci?? glob:match-ci??) +(define (glob:substitute?? pat templ) + (cond ((procedure? templ) + (glob:caller-with-matches pat templ char=? char<=?)) + ((string? templ) + (glob:make-substituter pat templ char=? char<=?)) + (else + (slib:error 'glob:substitute "bad second argument" templ)))) +(define (glob:substitute-ci?? pat templ) + (cond ((procedure? templ) + (glob:caller-with-matches pat templ char-ci=? char-ci<=?)) + ((string? templ) + (glob:make-substituter pat templ char-ci=? char-ci<=?)) + (else + (slib:error 'glob:substitute "bad second argument" templ)))) +(define filename:substitute?? glob:substitute??) +(define filename:substitute-ci?? glob:substitute-ci??) + (define (replace-suffix str old new) - (define (cs str) - (let* ((len (string-length str)) - (re (- len (string-length old)))) - (cond ((string-ci=? old (substring str re len)) - (string-append (substring str 0 re) new)) - (else - (slib:error 'replace-suffix "suffix doesn't match:" - old str))))) - (if (string? str) (cs str) (map cs str))) + (let* ((f (glob:make-substituter (list "*" old) (list "*" new) + char=? char<=?)) + (g (lambda (st) + (or (f st) + (slib:error 'replace-suffix "suffix doesn't match:" + old st))))) + (if (pair? str) + (map g str) + (g str)))) diff --git a/htmlform.scm b/htmlform.scm index f8656e2..02dc63a 100644 --- a/htmlform.scm +++ b/htmlform.scm @@ -1,5 +1,4 @@ -;;; "htmlform.scm" Generate HTML 2.0 forms and -*-scheme-*- -;;; service CGI requests from RDB command table. +;;; "htmlform.scm" Generate HTML 2.0 forms; service CGI requests. -*-scheme-*- ; Copyright 1997, 1998 Aubrey Jaffer ; ;Permission to copy this software, to redistribute it, and to use it @@ -25,6 +24,8 @@ (require 'parameters) (require 'fluid-let) (require 'dynamic-wind) +(require 'pretty-print) +(require 'object->string) (require 'string-case) (require 'string-port) (require 'string-search) @@ -41,71 +42,267 @@ ;;@body Returns a string with character substitutions appropriate to ;;send @1 as an @dfn{attribute-value}. -(define (html:atval txt) ; attribute-value +(define (make-atval txt) ; attribute-value (if (symbol? txt) (set! txt (symbol->string txt))) - (string-subst txt - "&" "&" - "\"" """ - "<" "<" - ">" ">")) + (if (number? txt) + (number->string txt) + (string-subst (if (string? txt) txt (object->string txt)) + "&" "&" + "\"" """ + "<" "<" + ">" ">"))) ;;@body Returns a string with character substitutions appropriate to ;;send @1 as an @dfn{plain-text}. -(define (html:plain txt) ; plain-text `Data Characters' +(define (make-plain txt) ; plain-text `Data Characters' (if (symbol? txt) (set! txt (symbol->string txt))) - (string-subst txt - "&" "&" - "<" "<" - ">" ">")) + (if (number? txt) + (number->string txt) + (string-subst (if (string? txt) txt (object->string txt)) + "&" "&" + "<" "<" + ">" ">"))) + +;;@args title backlink tags ... +;;@args title backlink +;;@args title +;; +;;Outputs headers for an HTML page named @1. If string arguments @2 +;;... are supplied they are printed verbatim within the @t{<HEAD>} +;;section. +(define (html:start-page title . args) + (define backlink (if (null? args) #f (car args))) + (if (not (null? args)) (set! args (cdr args))) + (html:printf "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2 Final//EN\">\\n") + (html:printf "<HTML>\\n") + (html:comment "HTML by SLIB" + "http://swissnet.ai.mit.edu/~jaffer/SLIB.html") + (html:printf "<HEAD>%s<TITLE>%s</TITLE></HEAD>\\n" + (apply string-append args) (make-plain title)) + (html:printf "<BODY><H1>%s</H1>\\n" + (or backlink (make-plain title)))) + +;;@body Outputs HTML codes to end a page. +(define (html:end-page) + (html:printf "</BODY>\\n") + (html:printf "</HTML>\\n")) + +;;@body Writes (using @code{html:printf}) the strings @1, @2 as +;;@dfn{PRE}formmated plain text (rendered in fixed-width font). +;;Newlines are inserted between @1, @2. HTML tags (@samp{<tag>}) +;;within @2 will be visible verbatim. +(define (html:pre line1 . lines) + (html:printf "<PRE>\\n%s" (make-plain line1)) + (for-each (lambda (line) (html:printf "\\n%s" (make-plain line))) lines) + (html:printf "</PRE>\\n")) ;;@body Writes (using @code{html:printf}) the strings @1 as HTML ;;comments. -(define (html:comment . lines) +(define (html:comment line1 . lines) (html:printf "<!") + (if (substring? "--" line1) + (slib:error 'html:comment "line contains --" line1) + (html:printf "--%s--" line1)) (for-each (lambda (line) (if (substring? "--" line) (slib:error 'html:comment "line contains --" line) - (html:printf "--%s--\\n" line))) + (html:printf "\\n --%s--" line))) lines) (html:printf ">\\n")) +;;@section HTML Tables + +;;@body +(define (html:start-table caption) + (html:printf "<TABLE BORDER WIDTH=\"100%%\">\\n") + (html:printf "<CAPTION ALIGN=BOTTOM>%s</CAPTION>\\n" (make-plain caption))) + +;;@body +(define (html:end-table) + (html:printf "</TABLE>\\n")) + +;;@body Outputs a heading row for the currently-started table. +(define (html:heading columns) + (html:printf "<TR VALIGN=\"TOP\">\\n") + (for-each (lambda (datum) (html:printf "<TH>%s\\n" (or datum ""))) columns)) + +;;@body Outputs a heading row with column-names @1 linked to URLs @2. +(define (html:href-heading columns urls) + (html:heading + (map (lambda (column url) + (if url + (sprintf #f "<A HREF=\"%s\">%s</A>" url column) + column)) + columns urls))) + +;;@args k foreigns +;; +;;The positive integer @1 is the primary-key-limit (number of +;;primary-keys) of the table. @2 is a list of the filenames of +;;foreign-key field pages and #f for non foreign-key fields. +;; +;;@0 returns a procedure taking a row for its single argument. This +;;returned procedure prints the table row to @var{*html:output-port*}. +(define (make-row-converter pkl foreigns) + (lambda (data-row) + (define anchored? #f) + (define (present datum) + (cond ((or (string? datum) (symbol? datum)) + (html:printf "%s" (make-plain datum))) + (else + (html:printf + "<PRE>\\n%s</PRE>\\n" + (make-plain (call-with-output-string + (lambda (port) + (pretty-print datum port)))))))) + (html:printf "<TR VALIGN=\"TOP\">") + (for-each (lambda (datum foreign) + (html:printf "<TD>") + (cond ((not datum)) + ((null? datum)) + ((not anchored?) + (html:printf "<A NAME=\"") + (cond + ((zero? pkl) + (html:printf "%s" (make-atval datum))) + (else (html:printf + "%s" (make-atval (car data-row))) + (do ((idx 1 (+ 1 idx)) + (contents (cdr data-row) (cdr contents))) + ((>= idx pkl)) + (html:printf + " %s" (make-atval (car contents)))))) + (html:printf "\">") + (set! anchored? (not (zero? pkl))))) + (cond ((not datum)) ((null? datum)) + ((not foreign) (present datum)) + ((zero? pkl) + (html:printf "<A HREF=\"%s\">" foreign) + (present datum) + (html:printf "</A>")) + (else + (html:printf "<A HREF=\"%s#%s\">" + foreign (make-atval datum)) + (present datum) + (html:printf "</A>")))) + data-row foreigns) + (html:printf "\\n"))) + +;;@body +;;Returns the symbol @1 converted to a filename. +(define (table-name->filename table-name) + (and table-name (string-append + (string-subst (symbol->string table-name) "*" "" ":" "_") + ".html"))) + +(define (table-name->column-table-name db table-name) + ((((db 'open-table) '*catalog-data* #f) 'get 'coltab-name) + table-name)) + +;;@args caption db table-name match-key1 @dots{} +;;Writes HTML for @2 table @3 to @var{*html:output-port*}. +;; +;;The optional @4 @dots{} arguments restrict actions to a subset of +;;the table. @xref{Table Operations, match-key}. +(define (table->html caption db table-name . args) + (let* ((table ((db 'open-table) table-name #f)) + (foreigns (table 'column-foreigns)) + (tags (map table-name->filename foreigns)) + (names (table 'column-names)) + (primlim (table 'primary-limit))) + (html:start-table caption) + (html:href-heading + names + (append (make-list primlim (table-name->filename + (table-name->column-table-name db table-name))) + (make-list (- (length names) primlim) #f))) + (html:heading (table 'column-domains)) + (html:href-heading foreigns tags) + (html:heading (table 'column-types)) + (apply (table 'for-each-row) (make-row-converter primlim tags) args) + (html:end-table))) + +;;@body +;;Writes a complete HTML page to @var{*html:output-port*}. The string +;;@3 names the page which refers to this one. +(define (table->page db table-name index-filename) + (dynamic-wind + (lambda () + (if index-filename + (html:start-page + table-name + (sprintf #f "<A HREF=\"%s#%s\">%s</A>" + index-filename + (make-atval table-name) + (make-plain table-name))) + (html:start-page table-name))) + (lambda () (table->html table-name db table-name)) + html:end-page)) + +;;@body +;;Writes HTML for the catalog table of @1 to @var{*html:output-port*}. +(define (catalog->html db caption) + (html:start-table caption) + (html:heading '(table columns)) + ((((db 'open-table) '*catalog-data* #f) 'for-each-row) + (lambda (row) + (cond ((and (eq? '*columns* (caddr row)) + (not (eq? '*columns* (car row))))) + (else ((make-row-converter + 0 (list (table-name->filename (car row)) + (table-name->filename (caddr row)))) + (list (car row) (caddr row)))))))) + +;;@body +;;Writes a complete HTML page for the catalog of @1 to +;;@var{*html:output-port*}. +(define (catalog->page db caption) + (dynamic-wind + (lambda () (html:start-page caption)) + (lambda () + (catalog->html db caption) + (html:end-table)) + html:end-page)) + +;;@section HTML Forms + (define (html:dt-strong-doc name doc) (if (and (string? doc) (not (equal? "" doc))) (html:printf "<DT><STRONG>%s</STRONG> (%s)\\n" - (html:plain name) (html:plain doc)) - (html:printf "<DT><STRONG>%s</STRONG>\\n" (html:plain name)))) + (make-plain name) (make-plain doc)) + (html:printf "<DT><STRONG>%s</STRONG>\\n" (make-plain name)))) (define (html:checkbox name doc pname) (html:printf "<DT><INPUT TYPE=CHECKBOX NAME=%#a VALUE=T>\\n" - (html:atval pname)) + (make-atval pname)) (if (and (string? doc) (not (equal? "" doc))) (html:printf "<DD><STRONG>%s</STRONG> (%s)\\n" - (html:plain name) (html:plain doc)) - (html:printf "<DD><STRONG>%s</STRONG>\\n" (html:plain name)))) + (make-plain name) (make-plain doc)) + (html:printf "<DD><STRONG>%s</STRONG>\\n" (make-plain name)))) (define (html:text name doc pname default) (cond (default (html:dt-strong-doc name doc) (html:printf "<DD><INPUT NAME=%#a SIZE=%d VALUE=%#a>\\n" - (html:atval pname) + (make-atval pname) (max 20 (string-length (if (symbol? default) (symbol->string default) default))) - (html:atval default))) + (make-atval default))) (else (html:dt-strong-doc name doc) - (html:printf "<DD><INPUT NAME=%#a>\\n" (html:atval pname))))) + (html:printf "<DD><INPUT NAME=%#a>\\n" (make-atval pname))))) (define (html:text-area name doc pname default-list) (html:dt-strong-doc name doc) (html:printf "<DD><TEXTAREA NAME=%#a ROWS=%d COLS=%d>\\n" - (html:atval pname) (max 2 (length default-list)) + (make-atval pname) (max 2 (length default-list)) (apply max 32 (map (lambda (d) (string-length (if (symbol? d) (symbol->string d) d))) default-list))) - (for-each (lambda (line) (html:printf "%s\\n" (html:plain line))) default-list) + (for-each (lambda (line) (html:printf "%s\\n" (make-plain line))) default-list) (html:printf "</TEXTAREA>\\n")) (define (html:s<? s1 s2) @@ -118,7 +315,7 @@ (set! value-list (sort! value-list html:s<?)) (html:dt-strong-doc name doc) (html:printf "<DD><SELECT NAME=%#a SIZE=%d%s>\\n" - (html:atval pname) + (make-atval pname) (case arity ((single optional) 1) ((nary nary1) 5)) @@ -127,10 +324,10 @@ (else ""))) (for-each (lambda (value) (html:printf "<OPTION VALUE=%#a%s>%s\\n" - (html:atval value) + (make-atval value) (if (member value default-list) " SELECTED" "") - (html:plain value))) + (make-plain value))) (case arity ((optional nary) (cons (string->symbol "") value-list)) (else value-list))) @@ -145,17 +342,17 @@ (for-each (lambda (value) (html:printf "<LI><INPUT TYPE=RADIO NAME=%#a VALUE=%#a%s> %s\\n" - (html:atval pname) (html:atval value) + (make-atval pname) (make-atval value) (if (member value default-list) " CHECKED" "") - (html:plain value))) + (make-plain value))) value-list)) ((nary nary1) (for-each (lambda (value) (html:printf "<LI><INPUT TYPE=CHECKBOX NAME=%#a VALUE=%#a%s> %s\\n" - (html:atval pname) (html:atval value) + (make-atval pname) (make-atval value) (if (member value default-list) " CHECKED" "") - (html:plain value))) + (make-plain value))) value-list))) (html:printf "</MENU>")) @@ -166,7 +363,7 @@ (cond ((not (memq method '(get head post put delete))) (slib:error 'html:start-form "method unknown:" method))) (html:printf "<FORM METHOD=%#a ACTION=%#a>\\n" - (html:atval method) (html:atval action)) + (make-atval method) (make-atval action)) (html:printf "<DL>\\n")) ;;@body @0 prints the footer for an HTML @dfn{form}. The string @2 @@ -174,20 +371,9 @@ (define (html:end-form pname submit-label) (html:printf "</DL>\\n") (html:printf "<INPUT TYPE=SUBMIT NAME=%#a VALUE=%#a> <INPUT TYPE=RESET>\\n" - (html:atval '*command*) (html:atval submit-label)) + (make-atval '*command*) (make-atval submit-label)) (html:printf "</FORM><HR>\\n")) -;;@body Outputs headers for an HTML page named @1. -(define (html:start-page title) - (html:printf "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\\n") - (html:comment) - (html:printf "<HEAD><TITLE>%s</TITLE></HEAD>\\n" (html:plain title)) - (html:printf "<BODY><H1>%s</H1>\\n" (html:plain title))) - -;;@body Outputs HTML codes to end a page. -(define (html:end-page) - (html:printf "</BODY>\\n")) - (define (html:generate-form comname method action docu pnames docs aliases arities types default-lists value-lists) (define aliast (map list pnames)) @@ -198,7 +384,7 @@ (dynamic-wind (lambda () (html:printf "<H2>%s:</H2><BLOCKQUOTE>%s</BLOCKQUOTE>\\n" - (html:plain comname) (html:plain docu)) + (make-plain comname) (make-plain docu)) (html:start-form 'post action)) (lambda () (for-each @@ -303,7 +489,7 @@ (define len (string-length str)) (define (sub str) (cond - ((string-index str #\%) + ((strsrch:string-index str #\%) => (lambda (idx) (if (and (< (+ 2 idx) len) (string->number (substring str (+ 1 idx) (+ 2 idx)) 16) @@ -319,7 +505,7 @@ (sub str)) (define (form:split-lines txt) - (let ((idx (string-index txt #\newline)) + (let ((idx (strsrch:string-index txt #\newline)) (carriage-return (integer->char #xd))) (if idx (cons (substring txt 0 @@ -336,11 +522,11 @@ (if (symbol? txt) (set! txt (symbol->string txt))) (set! txt (string-subst txt " " "" "+" " ")) (do ((lst '()) - (edx (string-index txt #\=) - (string-index txt #\=))) + (edx (strsrch:string-index txt #\=) + (strsrch:string-index txt #\=))) ((not edx) lst) (let* ((rxt (substring txt (+ 1 edx) (string-length txt))) - (adx (string-index rxt #\&)) + (adx (strsrch:string-index rxt #\&)) (name (cgi:process-% (substring txt 0 edx)))) (set! lst (append @@ -484,7 +670,7 @@ (set! http:crlf (string (string-ref line 0) #\newline))) (if (eof-object? line) line alist)) (let ((len (string-length line)) - (idx (string-index line #\:))) + (idx (strsrch:string-index line #\:))) (if (char-whitespace? (string-ref line (+ -1 len))) (set! len (+ -1 len))) (and idx (do ((idx2 (+ idx 1) (+ idx2 1))) @@ -505,9 +691,9 @@ (let* ((request-uri (cadr request-line)) (len (string-length request-uri))) (and (> len 3) - (string-index request-uri #\?) + (strsrch:string-index request-uri #\?) (substring request-uri - (+ 1 (string-index request-uri #\?)) + (+ 1 (strsrch:string-index request-uri #\?)) (if (eqv? #\/ (string-ref request-uri (+ -1 len))) (+ -1 len) len))))) diff --git a/htmlform.txi b/htmlform.txi index 47dceaf..c16818f 100644 --- a/htmlform.txi +++ b/htmlform.txi @@ -10,26 +10,117 @@ to the port @var{*html:output-port*}. @var{*html:output-port*} is initially the -@defun html:atval txt +@defun make-atval txt Returns a string with character substitutions appropriate to send @var{txt} as an @dfn{attribute-value}. @cindex attribute-value @end defun -@defun html:plain txt +@defun make-plain txt Returns a string with character substitutions appropriate to send @var{txt} as an @dfn{plain-text}. @cindex plain-text @end defun -@defun html:comment line @dots{} -Writes (using @code{html:printf}) the strings @var{lines} as HTML +@defun html:start-page title backlink @dots{} +Outputs headers for an HTML page named @var{title}. +@end defun + + +@defun html:end-page +Outputs HTML codes to end a page. +@end defun + + +@defun html:pre line1 line @dots{} +Writes (using @code{html:printf}) the strings @var{line1}, @var{lines} as +@dfn{PRE}formmated plain text (rendered in fixed-width font). +@cindex PRE +Newlines are inserted between @var{line1}, @var{lines}. HTML tags (@samp{<tag>}) +within @var{lines} will be visible verbatim. +@end defun + + +@defun html:comment line1 line @dots{} +Writes (using @code{html:printf}) the strings @var{line1} as HTML comments. @end defun +@section HTML Tables + +@defun html:start-table caption + +@end defun + + +@defun html:end-table + +@end defun + + +@defun html:heading columns +Outputs a heading row for the currently-started table. +@end defun + + +@defun html:href-heading columns urls +Outputs a heading row with column-names @var{columns} linked to URLs @var{urls}. +@end defun + + +@defun make-row-converter k foreigns + + +The positive integer @var{k} is the primary-key-limit (number of +primary-keys) of the table. @var{foreigns} is a list of the filenames of +foreign-key field pages and #f for non foreign-key fields. + +@code{make-row-converter} returns a procedure taking a row for its single argument. This +returned procedure prints the table row to @var{*html:output-port*}. +@end defun + + +@defun table-name->filename table-name + +Returns the symbol @var{table-name} converted to a filename. +@end defun + + + +@defun table->html caption db table-name match-key1 @dots{} + +Writes HTML for @var{db} table @var{table-name} to @var{*html:output-port*}. + +The optional @var{match-key1} @dots{} arguments restrict actions to a subset of +the table. @xref{Table Operations, match-key}. +@end defun + + +@defun table->page db table-name index-filename + +Writes a complete HTML page to @var{*html:output-port*}. The string +@var{index-filename} names the page which refers to this one. +@end defun + + +@defun catalog->html db caption + +Writes HTML for the catalog table of @var{db} to @var{*html:output-port*}. +@end defun + + +@defun catalog->page db caption + +Writes a complete HTML page for the catalog of @var{db} to +@var{*html:output-port*}. +@end defun + + +@section HTML Forms + @@ -52,16 +143,6 @@ appears on the button which submits the form. @end defun -@defun html:start-page title -Outputs headers for an HTML page named @var{title}. -@end defun - - -@defun html:end-page -Outputs HTML codes to end a page. -@end defun - - @defun command->html rdb command-table command method action The symbol @var{command-table} names a command table in the @var{rdb} relational @@ -129,15 +210,8 @@ parameters and invokes the @var{rdb} command named by the parameter -@defvar http:crlf -@end defvar - -@defun http:send-status-line status-code reason -@defunx http:send-header alist -@end defun - @@ -17,34 +17,66 @@ ;promotional, or sales literature without prior written consent in ;each case. -(define (read-line . arg) - (let* ((char (apply read-char arg))) + +;;@args +;;@args port +;;Returns a string of the characters up to, but not including a +;;newline or end of file, updating @var{port} to point to the +;;character following the newline. If no characters are available, an +;;end of file object is returned. The @var{port} argument may be +;;omitted, in which case it defaults to the value returned by +;;@code{current-input-port}. +(define (read-line . port) + (let* ((char (apply read-char port))) (if (eof-object? char) char - (do ((char char (apply read-char arg)) + (do ((char char (apply read-char port)) (clist '() (cons char clist))) ((or (eof-object? char) (char=? #\newline char)) (list->string (reverse clist))))))) -(define (read-line! str . arg) - (let* ((char (apply read-char arg)) - (len (+ -1 (string-length str)))) +;;@args string +;;@args string port +;;Fills @1 with characters up to, but not including a newline or end +;;of file, updating the @var{port} to point to the last character read +;;or following the newline if it was read. If no characters are +;;available, an end of file object is returned. If a newline or end +;;of file was found, the number of characters read is returned. +;;Otherwise, @code{#f} is returned. The @var{port} argument may be +;;omitted, in which case it defaults to the value returned by +;;@code{current-input-port}. +(define (read-line! str . port) + (let* ((char (apply read-char port)) + (midx (+ -1 (string-length str)))) (if (eof-object? char) char - (do ((char char (apply read-char arg)) + (do ((char char (apply read-char port)) (i 0 (+ 1 i))) ((or (eof-object? char) (char=? #\newline char) - (>= i len)) - (cond ((or (eof-object? char) (char=? #\newline char)) - i) - (else - (string-set! str i char) - (set! char (apply peek-char arg)) - (if (or (eof-object? char) (char=? #\newline char)) - (+ 1 i) #f)))) + (> i midx)) + (if (> i midx) #f i)) (string-set! str i char))))) -(define (write-line str . arg) - (apply display str arg) - (apply newline arg)) +;;@args string +;;@args string port +;;Writes @1 followed by a newline to the given @var{port} and returns +;;an unspecified value. The @var{Port} argument may be omited, in +;;which case it defaults to the value returned by +;;@code{current-input-port}.@refill +(define (write-line str . port) + (apply display str port) + (apply newline port)) + +;;@args path +;;@args path port +;;Displays the contents of the file named by @1 to @var{port}. The +;;@var{port} argument may be ommited, in which case it defaults to the +;;value returned by @code{current-output-port}. +(define (display-file path . port) + (set! port (if (null? port) (current-output-port) (car port))) + (call-with-input-file path + (lambda (inport) + (do ((line (read-line inport) (read-line inport))) + ((eof-object? line)) + (write-line line port))))) diff --git a/lineio.txi b/lineio.txi new file mode 100644 index 0000000..c067678 --- /dev/null +++ b/lineio.txi @@ -0,0 +1,51 @@ + + + +@defun read-line read-line + + +@defunx read-line read-line port +Returns a string of the characters up to, but not including a +newline or end of file, updating @var{port} to point to the +character following the newline. If no characters are available, an +end of file object is returned. The @var{port} argument may be +omitted, in which case it defaults to the value returned by +@code{current-input-port}. +@end defun + + +@defun read-line! read-line! string + + +@defunx read-line! read-line! string port +Fills @var{read-line!} with characters up to, but not including a newline or end +of file, updating the @var{port} to point to the last character read +or following the newline if it was read. If no characters are +available, an end of file object is returned. If a newline or end +of file was found, the number of characters read is returned. +Otherwise, @code{#f} is returned. The @var{port} argument may be +omitted, in which case it defaults to the value returned by +@code{current-input-port}. +@end defun + + + +@defun write-line write-line string + + +@defunx write-line write-line string port +Writes @var{write-line} followed by a newline to the given @var{port} and returns +an unspecified value. The @var{Port} argument may be omited, in +which case it defaults to the value returned by +@code{current-input-port}.@refill +@end defun + + +@defun display-file path + + +@defunx display-file path port +Displays the contents of the file named by @var{path} to @var{port}. The +@var{port} argument may be ommited, in which case it defaults to the +value returned by @code{current-output-port}. +@end defun diff --git a/macscheme.init b/macscheme.init index 58927ee..16c53bb 100644 --- a/macscheme.init +++ b/macscheme.init @@ -1,21 +1,7 @@ ;;;"macscheme.init" Configuration of *features* for MacScheme -*-scheme-*- -;Copyright (C) 1994, 1997 Aubrey Jaffer -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; From: jjb@isye.gatech.edu (John Bartholdi) @@ -29,6 +15,12 @@ (define (scheme-implementation-type) 'MacScheme) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) #f) + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. @@ -1,5 +1,5 @@ ;;;; "mbe.scm" "Macro by Example" (Eugene Kohlbecker, R4RS) -;;; From: Dorai Sitaram, dorai@cs.rice.edu, 1991, 1997 +;;; From: Dorai Sitaram, dorai@cs.rice.edu, 1991, 1999 ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -20,6 +20,7 @@ ;;; revised Dec. 6, 1993 to R4RS syntax (if not semantics). ;;; revised Mar. 2 1994 for SLIB (jaffer@ai.mit.edu). ;;; corrections, Apr. 24, 1997. +;;; corr., Jan. 30, 1999. (mflatt@cs.rice.edu, dorai@cs.rice.edu) ;;; A vanilla implementation of hygienic macro-by-example as described ;;; by Eugene Kohlbecker and in R4RS Appendix. This file requires @@ -34,29 +35,29 @@ (lambda (k al) (let loop ((al al)) (if (null? al) #f - (let ((c (car al))) - (if (eq? (cdr c) k) c - (loop (cdr al)))))))) + (let ((c (car al))) + (if (eq? (cdr c) k) c + (loop (cdr al)))))))) (define hyg:tag (lambda (e kk al) (cond ((pair? e) - (let* ((a-te-al (hyg:tag (car e) kk al)) - (d-te-al (hyg:tag (cdr e) kk (cdr a-te-al)))) - (cons (cons (car a-te-al) (car d-te-al)) - (cdr d-te-al)))) + (let* ((a-te-al (hyg:tag (car e) kk al)) + (d-te-al (hyg:tag (cdr e) kk (cdr a-te-al)))) + (cons (cons (car a-te-al) (car d-te-al)) + (cdr d-te-al)))) ((vector? e) - (list->vector - (hyg:tag (vector->list e) kk al))) + (list->vector + (hyg:tag (vector->list e) kk al))) ((symbol? e) - (cond ((eq? e '...) (cons '... al)) - ((memq e kk) (cons e al)) - ((hyg:rassq e al) => - (lambda (c) - (cons (car c) al))) - (else - (let ((te (gentemp))) - (cons te (cons (cons te e) al)))))) + (cond ((eq? e '...) (cons '... al)) + ((memq e kk) (cons e al)) + ((hyg:rassq e al) => + (lambda (c) + (cons (car c) al))) + (else + (let ((te (gentemp))) + (cons te (cons (cons te e) al)))))) (else (cons e al))))) ;;untagging @@ -65,140 +66,184 @@ (lambda (e al tmps) (if (pair? e) (let ((a (hyg:untag (car e) al tmps))) - (if (list? e) - (case a - ((quote) (hyg:untag-no-tags e al)) - ((if begin) - `(,a ,@(map (lambda (e1) - (hyg:untag e1 al tmps)) (cdr e)))) - ((set! define) - `(,a ,(hyg:untag-vanilla (cadr e) al tmps) - ,@(map (lambda (e1) - (hyg:untag e1 al tmps)) (cddr e)))) - ((lambda) (hyg:untag-lambda (cadr e) (cddr e) al tmps)) - ((letrec) (hyg:untag-letrec (cadr e) (cddr e) al tmps)) - ((let) - (let ((e2 (cadr e))) - (if (symbol? e2) - (hyg:untag-named-let e2 (caddr e) (cdddr e) al tmps) - (hyg:untag-let e2 (cddr e) al tmps)))) - ((let*) (hyg:untag-let* (cadr e) (cddr e) al tmps)) - ((do) (hyg:untag-do (cadr e) (caddr e) (cdddr e) al tmps)) - ((case) - `(case ,(hyg:untag-vanilla (cadr e) al tmps) - ,@(map - (lambda (c) - `(,(hyg:untag-vanilla (car c) al tmps) - ,@(hyg:untag-list (cdr c) al tmps))) - (cddr e)))) - ((cond) - `(cond ,@(map - (lambda (c) - (hyg:untag-list c al tmps)) - (cdr e)))) - (else (cons a (hyg:untag-list (cdr e) al tmps)))) - (cons a (hyg:untag-list* (cdr e) al tmps)))) + (if (list? e) + (case a + ((quote) (hyg:untag-no-tags e al)) + ((quasiquote) (list a (hyg:untag-quasiquote (cadr e) al tmps))) + ((if begin) + `(,a ,@(map (lambda (e1) + (hyg:untag e1 al tmps)) (cdr e)))) + ((set! define) + `(,a ,(hyg:untag-vanilla (cadr e) al tmps) + ,@(map (lambda (e1) + (hyg:untag e1 al tmps)) (cddr e)))) + ((lambda) (hyg:untag-lambda (cadr e) (cddr e) al tmps)) + ((letrec) (hyg:untag-letrec (cadr e) (cddr e) al tmps)) + ((let) + (let ((e2 (cadr e))) + (if (symbol? e2) + (hyg:untag-named-let e2 (caddr e) (cdddr e) al tmps) + (hyg:untag-let e2 (cddr e) al tmps)))) + ((let*) (hyg:untag-let* (cadr e) (cddr e) al tmps)) + ((do) (hyg:untag-do (cadr e) (caddr e) (cdddr e) al tmps)) + ((case) + `(case ,(hyg:untag-vanilla (cadr e) al tmps) + ,@(map + (lambda (c) + `(,(hyg:untag-vanilla (car c) al tmps) + ,@(hyg:untag-list (cdr c) al tmps))) + (cddr e)))) + ((cond) + `(cond ,@(map + (lambda (c) + (hyg:untag-list c al tmps)) + (cdr e)))) + (else (cons a (hyg:untag-list (cdr e) al tmps)))) + (cons a (hyg:untag-list* (cdr e) al tmps)))) (hyg:untag-vanilla e al tmps)))) (define hyg:untag-list (lambda (ee al tmps) (map (lambda (e) - (hyg:untag e al tmps)) ee))) + (hyg:untag e al tmps)) ee))) (define hyg:untag-list* (lambda (ee al tmps) (let loop ((ee ee)) (if (pair? ee) - (cons (hyg:untag (car ee) al tmps) - (loop (cdr ee))) - (hyg:untag ee al tmps))))) + (cons (hyg:untag (car ee) al tmps) + (loop (cdr ee))) + (hyg:untag ee al tmps))))) (define hyg:untag-no-tags (lambda (e al) (cond ((pair? e) - (cons (hyg:untag-no-tags (car e) al) - (hyg:untag-no-tags (cdr e) al))) + (cons (hyg:untag-no-tags (car e) al) + (hyg:untag-no-tags (cdr e) al))) ((vector? e) - (list->vector - (hyg:untag-no-tags (vector->list e) al))) + (list->vector + (hyg:untag-no-tags (vector->list e) al))) ((not (symbol? e)) e) ((assq e al) => cdr) (else e)))) +(define hyg:untag-quasiquote + (lambda (form al tmps) + (let qq ((x form) (level 0)) + (cond + ((pair? x) + (let ((first (qq (car x) level))) + (cond + ((and (eq? first 'unquote) (list? x)) + (let ((rest (cdr x))) + (if (or (not (pair? rest)) + (not (null? (cdr rest)))) + (slib:error 'unquote 'takes-exactly-one-expression) + (if (zero? level) + (list 'unquote (hyg:untag (car rest) al tmps)) + (cons first (qq rest (sub1 level))))))) + ((and (eq? first 'quasiquote) (list? x)) + (cons 'quasiquote (qq (cdr x) (add1 level)))) + ((and (eq? first 'unquote-splicing) (list? x)) + (slib:error 'unquote-splicing 'invalid-context-within-quasiquote)) + ((pair? first) + (let ((car-first (qq (car first) level))) + (if (and (eq? car-first 'unquote-splicing) + (list? first)) + (let ((rest (cdr first))) + (if (or (not (pair? rest)) + (not (null? (cdr rest)))) + (slib:error 'unquote-splicing + 'takes-exactly-one-expression) + (list (list 'unquote-splicing + (if (zero? level) + (hyg:untag (cadr rest) al tmps) + (qq (cadr rest) (sub1 level))) + (qq (cdr x) level))))) + (cons (cons car-first + (qq (cdr first) level)) + (qq (cdr x) level))))) + (else + (cons first (qq (cdr x) level)))))) + ((vector? x) + (list->vector + (qq (vector->list x) level))) + (else (hyg:untag-no-tags x al)))))) + (define hyg:untag-lambda (lambda (bvv body al tmps) (let ((tmps2 (nconc (hyg:flatten bvv) tmps))) `(lambda ,bvv - ,@(hyg:untag-list body al tmps2))))) + ,@(hyg:untag-list body al tmps2))))) (define hyg:untag-letrec (lambda (varvals body al tmps) (let ((tmps (nconc (map car varvals) tmps))) `(letrec - ,(map - (lambda (varval) - `(,(car varval) - ,(hyg:untag (cadr varval) al tmps))) - varvals) - ,@(hyg:untag-list body al tmps))))) + ,(map + (lambda (varval) + `(,(car varval) + ,(hyg:untag (cadr varval) al tmps))) + varvals) + ,@(hyg:untag-list body al tmps))))) (define hyg:untag-let (lambda (varvals body al tmps) (let ((tmps2 (nconc (map car varvals) tmps))) `(let - ,(map - (lambda (varval) - `(,(car varval) - ,(hyg:untag (cadr varval) al tmps))) - varvals) - ,@(hyg:untag-list body al tmps2))))) + ,(map + (lambda (varval) + `(,(car varval) + ,(hyg:untag (cadr varval) al tmps))) + varvals) + ,@(hyg:untag-list body al tmps2))))) (define hyg:untag-named-let (lambda (lname varvals body al tmps) (let ((tmps2 (cons lname (nconc (map car varvals) tmps)))) `(let ,lname - ,(map - (lambda (varval) - `(,(car varval) - ,(hyg:untag (cadr varval) al tmps))) - varvals) - ,@(hyg:untag-list body al tmps2))))) + ,(map + (lambda (varval) + `(,(car varval) + ,(hyg:untag (cadr varval) al tmps))) + varvals) + ,@(hyg:untag-list body al tmps2))))) (define hyg:untag-let* (lambda (varvals body al tmps) (let ((tmps2 (nconc (nreverse (map car varvals)) tmps))) `(let* - ,(let loop ((varvals varvals) - (i (length varvals))) - (if (null? varvals) '() - (let ((varval (car varvals))) - (cons `(,(car varval) - ,(hyg:untag (cadr varval) - al (list-tail tmps2 i))) - (loop (cdr varvals) (- i 1)))))) - ,@(hyg:untag-list body al tmps2))))) + ,(let loop ((varvals varvals) + (i (length varvals))) + (if (null? varvals) '() + (let ((varval (car varvals))) + (cons `(,(car varval) + ,(hyg:untag (cadr varval) + al (list-tail tmps2 i))) + (loop (cdr varvals) (- i 1)))))) + ,@(hyg:untag-list body al tmps2))))) (define hyg:untag-do (lambda (varinistps exit-test body al tmps) (let ((tmps2 (nconc (map car varinistps) tmps))) `(do - ,(map - (lambda (varinistp) - (let ((var (car varinistp))) - `(,var ,@(hyg:untag-list (cdr varinistp) al - (cons var tmps))))) - varinistps) - ,(hyg:untag-list exit-test al tmps2) - ,@(hyg:untag-list body al tmps2))))) + ,(map + (lambda (varinistp) + (let ((var (car varinistp))) + `(,var ,@(hyg:untag-list (cdr varinistp) al + (cons var tmps))))) + varinistps) + ,(hyg:untag-list exit-test al tmps2) + ,@(hyg:untag-list body al tmps2))))) (define hyg:untag-vanilla (lambda (e al tmps) (cond ((pair? e) - (cons (hyg:untag-vanilla (car e) al tmps) - (hyg:untag-vanilla (cdr e) al tmps))) + (cons (hyg:untag-vanilla (car e) al tmps) + (hyg:untag-vanilla (cdr e) al tmps))) ((vector? e) - (list->vector - (hyg:untag-vanilla (vector->list e) al tmps))) + (list->vector + (hyg:untag-vanilla (vector->list e) al tmps))) ((not (symbol? e)) e) ((memq e tmps) e) ((assq e al) => cdr) @@ -214,6 +259,7 @@ ;;;; End of hygiene filter. + ;;; finds the leftmost index of list l where something equal to x ;;; occurs (define mbe:position @@ -223,6 +269,14 @@ ((equal? (car l) x) i) (else (loop (cdr l) (+ i 1))))))) +;;; (mbe:append-map f l) == (apply append (map f l)) + +(define mbe:append-map + (lambda (f l) + (let loop ((l l)) + (if (null? l) '() + (append (f (car l)) (loop (cdr l))))))) + ;;; tests if expression e matches pattern p where k is the list of ;;; keywords (define mbe:matches-pattern? @@ -301,11 +355,26 @@ ;;; finds the subenvironments in r corresponding to the ellipsed ;;; variables in nestings + (define mbe:ellipsis-sub-envs (lambda (nestings r) - (some (lambda (c) - (if (mbe:contained-in? nestings (car c)) (cdr c) #f)) - r))) + (let ((sub-envs-list + (let loop ((r r) (sub-envs-list '())) + (if (null? r) (nreverse sub-envs-list) + (let ((c (car r))) + (loop (cdr r) + (if (mbe:contained-in? nestings (car c)) + (cons (cdr c) sub-envs-list) + sub-envs-list))))))) + (case (length sub-envs-list) + ((0) #f) + ((1) (car sub-envs-list)) + (else + (let loop ((sub-envs-list sub-envs-list) (final-sub-envs '())) + (if (some null? sub-envs-list) (nreverse final-sub-envs) + (loop (map cdr sub-envs-list) + (cons (mbe:append-map car sub-envs-list) + final-sub-envs))))))))) ;;; checks if nestings v and y have an intersection (define mbe:contained-in? @@ -337,36 +406,36 @@ (defmacro define-syntax (macro-name syn-rules) (if (or (not (pair? syn-rules)) - (not (eq? (car syn-rules) 'syntax-rules))) + (not (eq? (car syn-rules) 'syntax-rules))) (slib:error 'define-syntax 'not-an-r4rs-high-level-macro macro-name syn-rules) (let ((keywords (cons macro-name (cadr syn-rules))) - (clauses (cddr syn-rules))) + (clauses (cddr syn-rules))) `(defmacro ,macro-name macro-arg - (let ((macro-arg (cons ',macro-name macro-arg)) - (keywords ',keywords)) - (cond ,@(map - (lambda (clause) - (let ((in-pattern (car clause)) + (let ((macro-arg (cons ',macro-name macro-arg)) + (keywords ',keywords)) + (cond ,@(map + (lambda (clause) + (let ((in-pattern (car clause)) (out-pattern (cadr clause))) - `((mbe:matches-pattern? ',in-pattern macro-arg - keywords) - (let ((tagged-out-pattern+alist - (hyg:tag - ',out-pattern - (nconc (hyg:flatten ',in-pattern) - keywords) '()))) - (hyg:untag - (mbe:expand-pattern - (car tagged-out-pattern+alist) - (mbe:get-bindings ',in-pattern macro-arg - keywords) - keywords) - (cdr tagged-out-pattern+alist) - '()))))) - clauses) - (else (slib:error ',macro-name 'no-matching-clause - ',clauses)))))))) + `((mbe:matches-pattern? ',in-pattern macro-arg + keywords) + (let ((tagged-out-pattern+alist + (hyg:tag + ',out-pattern + (nconc (hyg:flatten ',in-pattern) + keywords) '()))) + (hyg:untag + (mbe:expand-pattern + (car tagged-out-pattern+alist) + (mbe:get-bindings ',in-pattern macro-arg + keywords) + keywords) + (cdr tagged-out-pattern+alist) + '()))))) + clauses) + (else (slib:error ',macro-name 'no-matching-clause + ',clauses)))))))) (define macro:eval slib:eval) (define macro:load slib:load) diff --git a/mitscheme.init b/mitscheme.init index bd612b0..ab1e1b7 100644 --- a/mitscheme.init +++ b/mitscheme.init @@ -1,21 +1,7 @@ ;;;"mitscheme.init" Initialization for SLIB for MITScheme -*-scheme-*- -;;; Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer. -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; Make this part of your ~/.scheme.init file. @@ -29,6 +15,13 @@ (define (scheme-implementation-type) 'MITScheme) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://swissnet.ai.mit.edu/scheme-home.html") + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. @@ -161,9 +154,12 @@ (lambda () (proc port)))))))) (define object->string write-to-string) +(define object->limited-string write-to-string) ;;; CHAR-CODE-LIMIT is one greater than the largest integer which can -;;; be returned by CHAR->INTEGER. It is defined by MITScheme. +;;; be returned by CHAR->INTEGER. It is defined incorrectly (65536) +;;; by MITScheme version 8.0. +(define char-code-limit 256) ;;; MOST-POSITIVE-FIXNUM is used in modular.scm (define most-positive-fixnum #x03FFFFFF) diff --git a/mklibcat.scm b/mklibcat.scm index dbc26d9..d6bd380 100644 --- a/mklibcat.scm +++ b/mklibcat.scm @@ -42,7 +42,7 @@ (cons (car p) (if (pair? (cdr p)) - (cons + (cons (cadr p) (in-vicinity (library-vicinity) (cddr p))) (in-vicinity (library-vicinity) (cdr p)))))) @@ -56,7 +56,7 @@ (with-file . "withfile") (dynamic-wind . "dynwind") (dynamic . "dynamic") - (fluid-let macro . "fluidlet") + (fluid-let defmacro . "fluidlet") (alist . "alist") (hash . "hash") (sierpinski . "sierpinski") @@ -66,8 +66,8 @@ (random . "random") (random-inexact . "randinex") (modular . "modular") - (primes . "primes") (factor . "factor") + (primes . factor) (charplot . "charplot") (sort . "sort") (tsort . topological-sort) @@ -100,7 +100,8 @@ (syntactic-closures . "scmacro") (macros-that-work . "macwork") (macro . macro-by-example) - (yasos macro . "yasos") + (object . "object") + (yasos macro . "yasyn") (oop . yasos) (collect macro . "collect") (struct defmacro . "struct") @@ -128,6 +129,7 @@ (glob . "glob") (filename . glob) (make-crc . "makcrc") + (fft . "fft") (wt-tree . "wttree") (string-search . "strsrch") (root . "root") @@ -139,6 +141,7 @@ (byte . "byte") (tzfile . "tzfile") (schmooz . "schmooz") + (net-clients . "nclients") (new-catalog . "mklibcat") )))) (display " " op) diff --git a/mwexpand.scm b/mwexpand.scm index a53f0da..9dea34b 100644 --- a/mwexpand.scm +++ b/mwexpand.scm @@ -38,8 +38,8 @@ (mw:desugar-definitions def-or-exp mw:global-syntax-environment)))) (define (mw:desugar-definitions exp env) - (letrec - ((define-loop + (letrec + ((define-loop (lambda (exp rest first) (cond ((and (pair? exp) (eq? (mw:syntax-lookup env (car exp)) @@ -70,10 +70,10 @@ (append (reverse first) (map (lambda (exp) (mw:expand exp env)) (cons exp rest)))))))) - + (desugar-define (lambda (exp env) - (cond + (cond ((null? (cdr exp)) (mw:error "Malformed definition" exp)) ; (define foo) syntax is transformed into (define foo (undefined)). ((null? (cddr exp)) @@ -93,8 +93,8 @@ (redefinition id) (mw:syntax-bind-globally! id (mw:make-identifier-denotation id)) `(,mw:define1 ,id ,(mw:expand (caddr exp) env))))))) - - (define-syntax-loop + + (define-syntax-loop (lambda (exp rest) (cond ((and (pair? exp) (eq? (mw:syntax-lookup env (car exp)) @@ -115,7 +115,7 @@ (else (cons mw:begin1 (map (lambda (exp) (mw:expand exp env)) (cons exp rest))))))) - + (redefinition (lambda (id) (if (symbol? id) @@ -123,9 +123,9 @@ (mw:syntax-lookup mw:global-syntax-environment id))) (mw:warn "Redefining keyword" id)) (mw:error "Malformed variable or keyword" id))))) - + ; body of letrec - + (define-loop exp '() '()))) ; Given an expression and a syntactic environment, @@ -157,7 +157,7 @@ ((or (eq? keyword mw:denote-of-define) (eq? keyword mw:denote-of-define-syntax)) ;; slight hack to allow expansion into defines -KenD - (if mw:in-define? + (if mw:in-define? (mw:error "Definition out of context" exp) (begin (set! mw:in-define? #t) @@ -378,10 +378,10 @@ ; Clean up alist hacking et cetera. ;;----------------------------------------------------------------- -;; The following was added to allow expansion without flattening -;; LETs to LAMBDAs so that the origianl structure of the program -;; is preserved by macro expansion. I.e. so that usual.scm is not -;; required. -- added KenD +;; The following was added to allow expansion without flattening +;; LETs to LAMBDAs so that the origianl structure of the program +;; is preserved by macro expansion. I.e. so that usual.scm is not +;; required. -- added KenD (define (mw:process-let-bindings alist binding-list env) ;; helper proc (map (lambda (bind) @@ -414,7 +414,7 @@ ; LET (define (mw:let exp env) (let* ( (name (if (or (pair? (cadr exp)) (null? (cadr exp))) - #f + #f (cadr exp))) ; named let? (binds (if name (caddr exp) (cadr exp))) (body (if name (cdddr exp) (cddr exp))) @@ -460,12 +460,12 @@ (if (null? bindings) `(let* ,(reverse newbinds) ,(mw:body body newenv)) (let* ( (bind (car bindings)) - (var (car bind)) + (var (car bind)) (valexp (cdr bind)) (rename (mw:rename-vars (list var))) (next-newenv (mw:syntax-rename newenv rename)) ) - (bind-loop (cdr bindings) + (bind-loop (cdr bindings) (cons (list (cdr (assq var rename)) (mw:body valexp newenv)) newbinds) @@ -500,13 +500,13 @@ ) ) ; -; Quasiquotation (backquote) +; Quasiquotation (backquote) ; ; At level 0, unquoted forms are left painted (not mw:strip'ed). ; At higher levels, forms which are unquoted to level 0 are painted. ; This includes forms within quotes. E.g.: -; (lambda (a) -; (quasiquote +; (lambda (a) +; (quasiquote ; (a (unquote a) b (quasiquote (a (unquote (unquote a)) b))))) ;or equivalently: ; (lambda (a) `(a ,a b `(a ,,a b))) @@ -551,12 +551,12 @@ ((eq? keyword mw:denote-of-quasiquote) (cons 'quasiquote (quasi (cdr subexp) (+ level 1))) ) - (else - (cons (quasi (car subexp) level) (quasi (cdr subexp) level)) + (else + (cons (quasi (car subexp) level) (quasi (cdr subexp) level)) ) ) ) ) ; end else, let - ) ; end cond + ) ; end cond ) (quasi exp 0) ; need to unquote to level 0 to paint diff --git a/mwsynrul.scm b/mwsynrul.scm index 1784441..bc5d7de 100644 --- a/mwsynrul.scm +++ b/mwsynrul.scm @@ -136,7 +136,7 @@ (loop P '() 0 k)) (define (mw:compile-template T vars env) - + (define (loop T inserted referenced rank escaped? k) (cond ((symbol? T) (let ((x (mw:pattern-variable T vars))) @@ -185,7 +185,7 @@ (lambda (T inserted referenced) (k (vector T) inserted referenced)))) (else (k T inserted referenced)))) - + (define (loop1 T inserted referenced rank escaped? k) (loop (car T) inserted @@ -208,7 +208,7 @@ T2) inserted referenced)))))) - + (loop T '() '() @@ -227,7 +227,7 @@ (list (mw:make-patternvar (string->symbol "") 0))) (define (mw:match F P env-def env-use) - + (define (match F P answer rank) (cond ((null? P) (and (null? F) answer)) @@ -248,7 +248,7 @@ (and (vector? F) (match (vector->list F) (vector-ref P 0) answer rank))) (else (and (equal? F P) answer)))) - + (define (match1 F P answer rank) (cond ((not (list? F)) #f) ((null? F) @@ -268,11 +268,11 @@ (mw:ellipsis-pattern-vars P)) answer) #f))))) - + (match F P mw:empty-pattern-variable-environment 0)) (define (mw:rewrite T alist) - + (define (rewrite T alist rank) (cond ((null? T) '()) ((pair? T) @@ -288,7 +288,7 @@ ((vector? T) (list->vector (rewrite (vector-ref T 0) alist rank))) (else T))) - + (define (rewrite1 T alist rank) (let* ((T1 (mw:ellipsis-template T)) (vars (mw:ellipsis-template-vars T)) @@ -296,7 +296,7 @@ vars))) (map (lambda (alist) (rewrite T1 alist rank)) (make-columns vars rows alist)))) - + (define (make-columns vars rows alist) (define (loop rows) (if (null? (car rows)) @@ -313,7 +313,7 @@ (mw:error "Use of macro is not consistent with definition" vars rows))) - + (rewrite T alist 0)) ; Given a use of a macro, the syntactic environment of the use, diff --git a/nclients.scm b/nclients.scm new file mode 100644 index 0000000..96c36c9 --- /dev/null +++ b/nclients.scm @@ -0,0 +1,385 @@ +;;; "nclients.scm" Interface to net-client programs. +; Copyright 1997, 1998 Aubrey Jaffer +; +;Permission to copy this software, to redistribute it, and to use it +;for any purpose is granted, subject to the following restrictions and +;understandings. +; +;1. Any copy made of this software must include this copyright notice +;in full. +; +;2. I have made no warrantee or representation that the operation of +;this software will be error-free, and I am under no obligation to +;provide any services, by way of maintenance, update, or otherwise. +; +;3. In conjunction with products arising from the use of this +;material, there shall be no use of my name in any advertising, +;promotional, or sales literature without prior written consent in +;each case. + +(require 'string-search) +(require 'line-i/o) +(require 'system) +(require 'printf) +(require 'scanf) + +;;@args proc +;;@args proc k +;;Calls @1 with @var{k} arguments, strings returned by successive +;;calls to @code{tmpnam}. If @1 returns, then any files named by the +;;arguments to @1 are deleted automatically and the value(s) yielded +;;by the @1 is(are) returned. @var{k} may be ommited, in which case +;;it defaults to @code{1}. +(define (call-with-tmpnam proc . k) + (do ((cnt (if (null? k) 0 (+ -1 (car k))) (+ -1 cnt)) + (paths '() (cons (tmpnam) paths))) + ((negative? cnt) + (let ((ans (apply proc paths))) + (for-each (lambda (path) (if (file-exists? path) (delete-file path))) + paths) + ans)))) + +;;@args +;;@0 returns a string of the form @samp{username@r{@@}hostname}. If +;;this e-mail address cannot be obtained, #f is returned. +(define user-email-address + (let ((user (or (getenv "USER") (getenv "USERNAME"))) + (hostname (getenv "HOSTNAME"))) ;with domain + (lambda () + (if (not (and user hostname)) + (call-with-tmpnam + (lambda (tmp) + (define command->string + (lambda (command) + (and (zero? (system (string-append command " >" tmp))) + (file-exists? tmp) + (let ((res #f)) + (call-with-input-file tmp + (lambda (port) + (and (eqv? 1 (fscanf port "%s" res)) res))))))) + (case (software-type) + ;;((AMIGA) ) + ;;((MACOS THINKC) ) + ((MS-DOS WINDOWS OS/2 ATARIST) + (let ((compname (getenv "COMPUTERNAME")) ;without domain + (workgroup #f) + (netdir (or (getenv "windir") + (getenv "winbootdir") + (and (getenv "SYSTEMROOT") + (string-append (getenv "SYSTEMROOT") + "\\system32")) + "C:\\windows"))) + (define (net . cmd) + (zero? (system (apply string-append + (or netdir "") + (if netdir "\\" "") + "NET " cmd)))) + (and (not (and user hostname)) + (zero? (system (string-append + (or netdir "") + (if netdir "\\" "") + "IPCONFIG /ALL > " tmp " "))) + (file-exists? tmp) + ;;(print tmp '=) (display-file tmp) + (call-with-input-file tmp + (lambda (port) + (find-string-from-port? "Host Name" port) + (fscanf port " %*[. ]: %s" hostname) + (delete-file tmp)))) + (and (not (and user hostname)) + (net "START /LIST >" tmp) + (file-exists? tmp) + (not (eof-object? (call-with-input-file tmp read-char))) + (cond + ((call-with-input-file tmp + (lambda (port) + (find-string-from-port? "o network servic" port))) + (and (net "CONFIG /YES >" tmp) + (net "STOP /YES"))) + (else (net "CONFIG /YES >" tmp))) + (call-with-input-file tmp + (lambda (port) + (do ((line (read-line port) (read-line port))) + ((eof-object? line)) + (sscanf line " Workstation root directory %s" + netdir) + (sscanf line " Computer name \\\\%s" compname) + (sscanf line " Workstation Domain %s" workgroup) + (sscanf line " Workgroup %s" workgroup) + (sscanf line " User name %s" user))))) + (and netdir (not (and user hostname)) + (set! netdir (string-append netdir "\\system.ini")) + (file-exists? netdir) + (call-with-input-file netdir + (lambda (port) + (and (find-string-from-port? "[DNS]" port) + (read-line port) ;past newline + (do ((line (read-line port) (read-line port))) + ((not (and (string? line) + (strsrch:string-index line #\=)))) + (sscanf line "HostName=%s" compname) + (sscanf line "DomainName=%s" workgroup))))) + (not user) + (call-with-input-file netdir + (lambda (port) + (and (find-string-from-port? "[Network]" port) + (read-line port) ;past newline + (do ((line (read-line port) (read-line port))) + ((not (and (string? line) + (strsrch:string-index line #\=)))) + (sscanf line "UserName=%s" user)))))) + (if (and compname (not hostname)) + (set! hostname + (string-append + compname "." (or workgroup "localnet")))))) + ;;((NOSVE) ) + ;;((VMS) ) + ((UNIX COHERENT) + (if (not user) + (set! user (command->string "whoami"))) + (if (not hostname) + (set! hostname (command->string "hostname"))))) + (if (not user) (set! user "John_Doe")) + (if (not hostname) (set! hostname "localhost"))))) + (string-append user "@" hostname)))) + +;;@args +;;@0 returns a string containing the absolute file name representing +;;the current working directory. If this string cannot be obtained, +;;#f is returned. +;; +;;If @0 cannot be supported by the platform, the value of @0 is +;;#f. +(define current-directory + (case (software-type) + ;;((AMIGA) ) + ;;((MACOS THINKC) ) + ((MS-DOS WINDOWS ATARIST OS/2) + (lambda () + (call-with-tmpnam + (lambda (tmp) + (and (zero? (system (string-append "cd >" tmp))) + (file-exists? tmp) + (call-with-input-file tmp + (lambda (port) + (let ((lst (scanf-read-list "%[^:]%[:] %s" port))) + (and (pair? lst) + (eqv? 3 (length lst)) + (apply string-append lst)))))))))) + ;;((NOSVE) ) + ((UNIX COHERENT) + (lambda () + (call-with-tmpnam + (lambda (tmp) + (and (zero? (system (string-append "pwd >" tmp))) + (file-exists? tmp) + (let ((path (call-with-input-file tmp read-line))) + (and (string? path) path))))))) + ;;((VMS) ) + (else #f))) + +;;@body +;;Creates a sub-directory @1 of the current-directory. If successful, +;;@0 returns #t; otherwise #f. +(define (make-directory name) + (zero? (system (string-append "mkdir " name)))) + +;;@body +;;Returns #t if changing directory to @1 makes the current working +;;directory the same as it is before changing directory; otherwise +;;returns #f. +(define (null-directory? file-name) + (member file-name '("" "." "./" ".\\"))) + +;;@body +;;Returns #t if @1 is a fully specified pathname (does not depend on +;;the current working directory); otherwise returns #f. +(define (absolute-path? file-name) + (and (string? file-name) + (positive? (string-length file-name)) + (memv (string-ref file-name 0) '(#\\ #\/)))) + + +;;@body Returns #t if the string @1 contains characters used for +;;specifying glob patterns, namely @samp{*}, @samp{?}, or @samp{[}. +(define (glob-pattern? str) + (let loop ((idx (+ -1 (string-length str)))) + (if (negative? idx) + #f + (case (string-ref str idx) + ((#\* #\[ #\?) #t) + (else (loop (+ -1 idx))))))) + +;;@body +;;Returns a list of the decoded FTP @1; or #f if indecipherable. FTP +;;@dfn{Uniform Resource Locator}, @dfn{ange-ftp}, and @dfn{getit} +;;formats are handled. The returned list has four elements which are +;;strings or #f: +;; +;;@enumerate 0 +;;@item +;;username +;;@item +;;password +;;@item +;;remote-site +;;@item +;;remote-directory +;;@end enumerate +(define (parse-ftp-address url) + (define length? (lambda (len lst) (and (eqv? len (length lst)) lst))) + (cond + ((not url) #f) + ((length? 1 (scanf-read-list " ftp://%s %s" url)) + => (lambda (host) + (let ((login #f) (path #f) (dross #f)) + (sscanf (car host) "%[^/]/%[^@]%s" login path dross) + (and login + (append (cond + ((length? 2 (scanf-read-list "%[^@]@%[^@]%s" login)) + => (lambda (userpass@hostport) + (append + (cond ((length? 2 (scanf-read-list + "%[^:]:%[^@/]%s" + (car userpass@hostport)))) + (else (list (car userpass@hostport) #f))) + (cdr userpass@hostport)))) + (else (list "anonymous" #f login))) + (list path)))))) + (else + (let ((user@site #f) (colon #f) (path #f) (dross #f)) + (case (sscanf url " %[^:]%[:]%[^@] %s" user@site colon path dross) + ((2 3) + (let ((user #f) (site #f)) + (cond ((or (eqv? 2 (sscanf user@site "/%[^@/]@%[^@]%s" + user site dross)) + (eqv? 2 (sscanf user@site "%[^@/]@%[^@]%s" + user site dross))) + (list user #f site path)) + ((eqv? 1 (sscanf user@site "@%[^@]%s" site dross)) + (list #f #f site path)) + (else (list #f #f user@site path))))) + (else + (let ((site (scanf-read-list " %[^@/] %s" url))) + (and (length? 1 site) (list #f #f (car site) #f))))))))) + +;;@body +;;@3 must be a non-empty string or #f. @1 must be a non-empty list +;;of pathnames or Glob patterns (@pxref{Filenames}) matching files to +;;transfer. +;; +;;@0 puts the files specified by @1 into the @5 directory of FTP @4 +;;using name @2 with (optional) @3. +;; +;;If @3 is #f and @2 is not @samp{ftp} or @samp{anonymous}, then @2 is +;;ignored; FTP takes the username and password from the @file{.netrc} +;;or equivalent file. +(define (ftp-upload paths user password remote-site remote-dir) + (call-with-tmpnam + (lambda (script logfile) + (define local-path (current-directory)) + (define passwd (or password (user-email-address))) + (dynamic-wind + (lambda () #f) + (lambda () + (call-with-current-continuation + (lambda (exit) + (define (run-ftp-script paths) + (call-with-output-file script + (lambda (port) + (define lcd "") + (cond ((or (member user '(ftp anonymous "ftp" "anonymous")) + password) + (fprintf port "user %s %s\n" user passwd))) + (fprintf port "binary\n") ; Turn binary ON for all transfers + ;;(fprintf port "prompt\n") ; Turn prompt OFF for possible mget + (if (not (null-directory? remote-dir)) + (fprintf port "cd %s\n" remote-dir)) + (for-each + (lambda (path-name) + (let* ((r/i (string-reverse-index path-name #\/)) + (dir (if r/i (substring path-name 0 (+ 1 r/i)) "")) + (file-name (if r/i + (substring path-name (+ 1 r/i) + (string-length path-name)) + path-name))) + (cond ((and r/i (glob-pattern? dir)) + (slib:warn + "Wildcard not allowed in directory component " + path-name) + (exit #f)) + ((and (not (glob-pattern? file-name)) + (not (file-exists? path-name))) + (slib:warn " file doesn't exist:" path-name) + (exit #f)) + ((equal? lcd dir)) + ((absolute-path? dir) + (fprintf port "lcd %s\n" dir)) + ((eqv? 0 (substring? lcd dir)) + (fprintf port "lcd %s\n" + (substring dir (string-length lcd) + (string-length dir)))) + (else + (fprintf port "lcd %s\n" local-path) + (if (not (null-directory? dir)) + (fprintf port "lcd %s\n" dir)))) + (set! lcd dir) + (cond ((glob-pattern? file-name) + (fprintf port "mput %s\n" file-name)) + (else + (fprintf port "put %s\n" file-name))))) + paths))) + ;;(display-file script) + (cond + ((zero? (system + (string-append + "ftp " + (if (or (member user '(ftp anonymous "ftp" "anonymous")) + password) + "-inv" "-iv") + " " remote-site + " <" script + " >" logfile))) + (file-exists? logfile) + (call-with-input-file logfile + (lambda (port) + (do ((line (read-line port) (read-line port))) + ((or (eof-object? line) + (substring-ci? "Unknown host" line) + (substring-ci? "Not connected" line) + (and (memv (string-ref line 0) '(#\4 #\5)) + (not (substring-ci? "bytes" line)))) + (cond ((eof-object? line) #t) + (else (slib:warn line) #f))) + ;;(write-line line) + )))) + (else (slib:warn 'ftp 'failed) #f))) + (cond ((or local-path (every? absolute-file? paths)) + (run-ftp-script paths)) + (else (for-each (lambda (path) (run-ftp-script (list path))) + paths)))))) + (lambda () + (if (file-exists? script) (delete-file script)) + (if (file-exists? logfile) (delete-file logfile))))) + 2)) + +;;@body +;;Returns a URL-string for @1 on the local host. +(define (path->url path) + (if (absolute-path? path) + (sprintf #f "file:%s" path) + (sprintf #f "file:%s/%s" (current-directory) path))) + +;;@body +;;If a @samp{netscape} browser is running, @0 causes the browser to +;;display the page specified by string @1 and returns #t. +;; +;;If the browser is not running, @0 runs @samp{netscape} with the +;;argument @1. If the browser starts as a background job, @0 returns +;;#t immediately; if the browser starts as a foreground job, then @0 +;;returns #t when the browser exits; otherwise it returns #f. +(define (browse-url-netscape url) + (or (eqv? 0 (system (sprintf #f "netscape-remote -remote 'openURL(%s)'" url))) + (eqv? 0 (system (sprintf #f "netscape -remote 'openURL(%s)'" url))) + (eqv? 0 (system (sprintf #f "netscape '%s'&" url))) + (eqv? 0 (system (sprintf #f "netscape '%s'" url))))) diff --git a/nclients.txi b/nclients.txi new file mode 100644 index 0000000..fcb77f8 --- /dev/null +++ b/nclients.txi @@ -0,0 +1,115 @@ + + + +@defun call-with-tmpnam proc + + +@defunx call-with-tmpnam proc k +Calls @var{proc} with @var{k} arguments, strings returned by successive +calls to @code{tmpnam}. If @var{proc} returns, then any files named by the +arguments to @var{proc} are deleted automatically and the value(s) yielded +by the @var{proc} is(are) returned. @var{k} may be ommited, in which case +it defaults to @code{1}. +@end defun + + +@defun user-email-address + +@code{user-email-address} returns a string of the form @samp{username@r{@@}hostname}. If +this e-mail address cannot be obtained, #f is returned. +@end defun + + +@defun current-directory + +@code{current-directory} returns a string containing the absolute file name representing +the current working directory. If this string cannot be obtained, +#f is returned. + +If @code{current-directory} cannot be supported by the platform, the value of @code{current-directory} is +#f. +@end defun + + +@defun make-directory name + +Creates a sub-directory @var{name} of the current-directory. If successful, +@code{make-directory} returns #t; otherwise #f. +@end defun + + +@defun null-directory? file-name + +Returns #t if changing directory to @var{file-name} makes the current working +directory the same as it is before changing directory; otherwise +returns #f. +@end defun + + +@defun absolute-path? file-name + +Returns #t if @var{file-name} is a fully specified pathname (does not depend on +the current working directory); otherwise returns #f. +@end defun + + + +@defun glob-pattern? str +Returns #t if the string @var{str} contains characters used for +specifying glob patterns, namely @samp{*}, @samp{?}, or @samp{[}. +@end defun + + +@defun parse-ftp-address url + +Returns a list of the decoded FTP @var{url}; or #f if indecipherable. FTP +@dfn{Uniform Resource Locator}, @dfn{ange-ftp}, and @dfn{getit} +@cindex Uniform Resource Locator +@cindex ange-ftp +@cindex getit +formats are handled. The returned list has four elements which are +strings or #f: + +@enumerate 0 +@item +username +@item +password +@item +remote-site +@item +remote-directory +@end enumerate +@end defun + + +@defun ftp-upload paths user password remote-site remote-dir + +@var{password} must be a non-empty string or #f. @var{paths} must be a non-empty list +of pathnames or Glob patterns (@pxref{Filenames}) matching files to +transfer. + +@code{ftp-upload} puts the files specified by @var{paths} into the @var{remote-dir} directory of FTP @var{remote-site} +using name @var{user} with (optional) @var{password}. + +If @var{password} is #f and @var{user} is not @samp{ftp} or @samp{anonymous}, then @var{user} is +ignored; FTP takes the username and password from the @file{.netrc} +or equivalent file. +@end defun + + +@defun path->url path + +Returns a URL-string for @var{path} on the local host. +@end defun + + +@defun browse-url-netscape url + +If a @samp{netscape} browser is running, @code{browse-url-netscape} causes the browser to +display the page specified by string @var{url} and returns #t. + +If the browser is not running, @code{browse-url-netscape} runs @samp{netscape} with the +argument @var{url}. If the browser starts, @code{browse-url-netscape} returns #t when the browser +exits; otherwise it returns #f. +@end defun diff --git a/objdoc.txi b/objdoc.txi new file mode 100644 index 0000000..123417b --- /dev/null +++ b/objdoc.txi @@ -0,0 +1,238 @@ + +@code{(require 'object)} +@ftindex object + +This is the Macroless Object System written by Wade Humeniuk +(whumeniu@@datap.ca). Conceptual Tributes: @ref{Yasos}, MacScheme's +%object, CLOS, Lack of R4RS macros. + +@subsection Concepts +@table @asis + +@item OBJECT +An object is an ordered association-list (by @code{eq?}) of methods +(procedures). Methods can be added (@code{make-method!}), deleted +(@code{unmake-method!}) and retrieved (@code{get-method}). Objects may +inherit methods from other objects. The object binds to the environment +it was created in, allowing closures to be used to hide private +procedures and data. + +@item GENERIC-METHOD +A generic-method associates (in terms of @code{eq?}) object's method. +This allows scheme function style to be used for objects. The calling +scheme for using a generic method is @code{(generic-method object param1 +param2 ...)}. + +@item METHOD +A method is a procedure that exists in the object. To use a method +get-method must be called to look-up the method. Generic methods +implement the get-method functionality. Methods may be added to an +object associated with any scheme obj in terms of eq? + +@item GENERIC-PREDICATE +A generic method that returns a boolean value for any scheme obj. + +@item PREDICATE +A object's method asscociated with a generic-predicate. Returns +@code{#t}. +@end table + +@subsection Procedures + +@defun make-object ancestor @dots{} +Returns an object. Current object implementation is a tagged vector. +@var{ancestor}s are optional and must be objects in terms of object?. +@var{ancestor}s methods are included in the object. Multiple +@var{ancestor}s might associate the same generic-method with a method. +In this case the method of the @var{ancestor} first appearing in the +list is the one returned by @code{get-method}. +@end defun + +@defun object? obj +Returns boolean value whether @var{obj} was created by make-object. +@end defun + +@defun make-generic-method exception-procedure +Returns a procedure which be associated with an object's methods. If +@var{exception-procedure} is specified then it is used to process +non-objects. +@end defun + +@defun make-generic-predicate +Returns a boolean procedure for any scheme object. +@end defun + +@defun make-method! object generic-method method +Associates @var{method} to the @var{generic-method} in the object. The +@var{method} overrides any previous association with the +@var{generic-method} within the object. Using @code{unmake-method!} +will restore the object's previous association with the +@var{generic-method}. @var{method} must be a procedure. +@end defun + +@defun make-predicate! object generic-preciate +Makes a predicate method associated with the @var{generic-predicate}. +@end defun + +@defun unmake-method! object generic-method +Removes an object's association with a @var{generic-method} . +@end defun + +@defun get-method object generic-method +Returns the object's method associated (if any) with the +@var{generic-method}. If no associated method exists an error is +flagged. +@end defun + +@subsection Examples + +@example +(require 'object) +@ftindex object + +(define instantiate (make-generic-method)) + +(define (make-instance-object . ancestors) + (define self (apply make-object + (map (lambda (obj) (instantiate obj)) ancestors))) + (make-method! self instantiate (lambda (self) self)) + self) + +(define who (make-generic-method)) +(define imigrate! (make-generic-method)) +(define emigrate! (make-generic-method)) +(define describe (make-generic-method)) +(define name (make-generic-method)) +(define address (make-generic-method)) +(define members (make-generic-method)) + +(define society + (let () + (define self (make-instance-object)) + (define population '()) + (make-method! self imigrate! + (lambda (new-person) + (if (not (eq? new-person self)) + (set! population (cons new-person population))))) + (make-method! self emigrate! + (lambda (person) + (if (not (eq? person self)) + (set! population + (comlist:remove-if (lambda (member) + (eq? member person)) + population))))) + (make-method! self describe + (lambda (self) + (map (lambda (person) (describe person)) population))) + (make-method! self who + (lambda (self) (map (lambda (person) (name person)) + population))) + (make-method! self members (lambda (self) population)) + self)) + +(define (make-person %name %address) + (define self (make-instance-object society)) + (make-method! self name (lambda (self) %name)) + (make-method! self address (lambda (self) %address)) + (make-method! self who (lambda (self) (name self))) + (make-method! self instantiate + (lambda (self) + (make-person (string-append (name self) "-son-of") + %address))) + (make-method! self describe + (lambda (self) (list (name self) (address self)))) + (imigrate! self) + self) +@end example + +@subsubsection Inverter Documentation +Inheritance: +@lisp + <inverter>::(<number> <description>) +@end lisp +Generic-methods +@lisp + <inverter>::value @result{} <number>::value + <inverter>::set-value! @result{} <number>::set-value! + <inverter>::describe @result{} <description>::describe + <inverter>::help + <inverter>::invert + <inverter>::inverter? +@end lisp + +@subsubsection Number Documention +Inheritance +@lisp + <number>::() +@end lisp +Slots +@lisp + <number>::<x> +@end lisp +Generic Methods +@lisp + <number>::value + <number>::set-value! +@end lisp + +@subsubsection Inverter code +@example +(require 'object) +@ftindex object + +(define value (make-generic-method (lambda (val) val))) +(define set-value! (make-generic-method)) +(define invert (make-generic-method + (lambda (val) + (if (number? val) + (/ 1 val) + (error "Method not supported:" val))))) +(define noop (make-generic-method)) +(define inverter? (make-generic-predicate)) +(define describe (make-generic-method)) +(define help (make-generic-method)) + +(define (make-number x) + (define self (make-object)) + (make-method! self value (lambda (this) x)) + (make-method! self set-value! + (lambda (this new-value) (set! x new-value))) + self) + +(define (make-description str) + (define self (make-object)) + (make-method! self describe (lambda (this) str)) + (make-method! self help (lambda (this) "Help not available")) + self) + +(define (make-inverter) + (let* ((self (make-object + (make-number 1) + (make-description "A number which can be inverted"))) + (<value> (get-method self value))) + (make-method! self invert (lambda (self) (/ 1 (<value> self)))) + (make-predicate! self inverter?) + (unmake-method! self help) + (make-method! self help + (lambda (self) + (display "Inverter Methods:") (newline) + (display " (value inverter) ==> n") (newline))) + self)) + +;;;; Try it out + +(define invert! (make-generic-method)) + +(define x (make-inverter)) + +(make-method! x invert! (lambda (x) (set-value! x (/ 1 (value x))))) + +(value x) @result{} 1 +(set-value! x 33) @result{} undefined +(invert! x) @result{} undefined +(value x) @result{} 1/33 + +(unmake-method! x invert!) @result{} undefined + +(invert! x) @error{} ERROR: Method not supported: x +@end example diff --git a/object.scm b/object.scm new file mode 100644 index 0000000..c272ef9 --- /dev/null +++ b/object.scm @@ -0,0 +1,97 @@ +;;; "object.scm" Macroless Object System +;;;From: whumeniu@datap.ca (Wade Humeniuk) + +;;;Date: February 15, 1994 + +;; Object Construction: +;; 0 1 2 3 4 +;; #(object-tag get-method make-method! unmake-method! get-all-methods) + +(define object:tag "object") + +;;; This might be better done using COMLIST:DELETE-IF. +(define (object:removeq obj alist) + (if (null? alist) + alist + (if (eq? (caar alist) obj) + (cdr alist) + (cons (car alist) (object:removeq obj (cdr alist)))))) + +(define (get-all-methods obj) + (if (object? obj) + ((vector-ref obj 4)) + (slib:error "Cannot get methods on non-object: " obj))) + +(define (object? obj) + (and (vector? obj) + (eq? object:tag (vector-ref obj 0)))) + +(define (make-method! obj generic-method method) + (if (object? obj) + (if (procedure? method) + (begin + ((vector-ref obj 2) generic-method method) + method) + (slib:error "Method must be a procedure: " method)) + (slib:error "Cannot make method on non-object: " obj))) + +(define (get-method obj generic-method) + (if (object? obj) + ((vector-ref obj 1) generic-method) + (slib:error "Cannot get method on non-object: " obj))) + +(define (unmake-method! obj generic-method) + (if (object? obj) + ((vector-ref obj 3) generic-method) + (slib:error "Cannot unmake method on non-object: " obj))) + +(define (make-predicate! obj generic-predicate) + (if (object? obj) + ((vector-ref obj 2) generic-predicate (lambda (self) #t)) + (slib:error "Cannot make predicate on non-object: " obj))) + +(define (make-generic-method . exception-procedure) + (define generic-method + (lambda (obj . operands) + (if (object? obj) + (let ((object-method ((vector-ref obj 1) generic-method))) + (if object-method + (apply object-method (cons obj operands)) + (slib:error "Method not supported: " obj))) + (apply exception-procedure (cons obj operands))))) + + (if (not (null? exception-procedure)) + (if (procedure? (car exception-procedure)) + (set! exception-procedure (car exception-procedure)) + (slib:error "Exception Handler Not Procedure:")) + (set! exception-procedure + (lambda (obj . params) + (slib:error "Operation not supported: " obj)))) + generic-method) + +(define (make-generic-predicate) + (define generic-predicate + (lambda (obj) + (if (object? obj) + (if ((vector-ref obj 1) generic-predicate) + #t + #f) + #f))) + generic-predicate) + +(define (make-object . ancestors) + (define method-list + (apply append (map (lambda (obj) (get-all-methods obj)) ancestors))) + (define (make-method! generic-method method) + (set! method-list (cons (cons generic-method method) method-list)) + method) + (define (unmake-method! generic-method) + (set! method-list (object:removeq generic-method method-list)) + #t) + (define (all-methods) method-list) + (define (get-method generic-method) + (let ((method-def (assq generic-method method-list))) + (if method-def (cdr method-def) #f))) + (vector object:tag get-method make-method! unmake-method! all-methods)) + + diff --git a/paramlst.scm b/paramlst.scm index b4af55a..32fb158 100644 --- a/paramlst.scm +++ b/paramlst.scm @@ -55,8 +55,11 @@ (and (every (lambda (check parameter) (every (lambda (p) - (not (and check (not (check p))))) - ;;(slib:error (car parameter) "parameter is wrong type: " p) + (let ((good? (not (and check (not (check p)))))) + (if (not good?) + (slib:warn + (car parameter) 'parameter? p)) + good?)) (cdr parameter))) checks parameter-list) parameter-list)) diff --git a/primes.scm b/primes.scm deleted file mode 100644 index 672e899..0000000 --- a/primes.scm +++ /dev/null @@ -1,187 +0,0 @@ -;; "primes.scm", test and generate prime numbers. -; Written by Michael H Coffin (mhc@edsdrd.eds.com) -; -; This code is in the public domain. - -;Date: Thu, 23 Feb 1995 07:47:49 +0500 -;From: mhc@edsdrd.eds.com (Michael H Coffin) -;; -;; Test numbers for primality using Rabin-Miller Monte-Carlo -;; primality test. -;; -;; Public functions: -;; -;; (primes start count . iter) -;; -;; (probably-prime? p . iter) -;; -;; -;; Please contact the author if you have problems or suggestions: -;; -;; Mike Coffin -;; 1196 Whispering Knoll -;; Rochester Hills, Mi. 48306 -;; -;; mhc@edsdrd.eds.com -;; - -(require 'random) - -;; The default number of times to perform the Rabin-Miller test. The -;; probability of a composite number passing the Rabin-Miller test for -;; primality with this many random numbers is at most -;; 1/(4^primes:iterations). The default yields about 1e-9. -;; -(define primes:iter 15) - -;; Is n probably prime? -;; -(define (primes:probably-prime? n . iter) - (let ((iter (if (null? iter) primes:iter (car iter)))) - (primes:prob-pr? n iter))) - - -;; Return a list of the first `number' odd probable primes less -;; than `start'. - -(define (primes:primes< start number . iter) - (let ((iter (if (null? iter) primes:iter (car iter)))) - (do ((candidate (if (odd? start) start (- start 1)) - (- candidate 2)) - (count 0) - (result '()) - ) - ((or (< candidate 3) (>= count number)) result) - (if (primes:prob-pr? candidate iter) - (begin - (set! count (1+ count)) - (set! result (cons candidate result))) - )))) - -(define (primes:primes> start number . iter) - (let ((iter (if (null? iter) primes:iter (car iter)))) - (do ((candidate (if (odd? start) start (+ 1 start)) - (+ 2 candidate)) - (count 0) - (result '()) - ) - ((= count number) (reverse result)) - (if (primes:prob-pr? candidate iter) - (begin - (set! count (1+ count)) - (set! result (cons candidate result))) - )))) - - -;; Is n probably prime? First we check for divisibility by small -;; primes; if it passes that, and it's less than the maximum small -;; prime squared, we try Rabin-Miller. -;; -(define (primes:prob-pr? n count) - (and (not (primes:dbsp? n)) - (or (< n (* primes:max-small-prime primes:max-small-prime)) - (primes:rm-prime? n count)))) - - -;; Is `n' Divisible By a Small Prime? -;; -(define primes:dbsp? - (let ((sqrt (cond ((provided? 'inexact) sqrt) - (else (require 'root) integer-sqrt)))) - (lambda (n) - (let ((limit (min (sqrt n) primes:max-small-prime)) - (divisible #f) - ) - (do ((i 0 (1+ i))) - ((let* ((divisor (vector-ref primes:small-primes i))) - (set! divisible (= (modulo n divisor) 0)) - (or divisible (> divisor limit))) - divisible) - ))))) - - -;; Does `n' pass the R.-M. primality test for `m' random numbers? -;; -(define (primes:rm-prime? n m) - (do ((i 0 (1+ i)) - (x (+ 2 (random (- n 2) primes:prngs)))) - ((or (= i m) (primes:rm-composite? n x)) - (= i m)))) - - -;; Does `x' prove `n' composite using Rabin-Miller? -;; -(define (primes:rm-composite? n x) - (let ((f (primes:extract2s (- n 1)))) - (primes:rm-comp? n (cdr f) (car f) x))) - - -;; Is `n' (where n-1 = 2^k * q) proven composite by `x'? -;; -(define (primes:rm-comp? n q k x) - (let ((y (primes:expt-mod x q n))) - (if (= y 1) - #f - (let loop ((j 0) (y y)) - (cond ((= j k) #t) - ((= y (- n 1)) #f) - ((= y 1) #t) - (else (loop (1+ j) (primes:expt-mod y 2 n))) - ))))) - - -;; Extract factors of 2; that is, factor x as 2^k * q -;; and return (k . q) -;; -(define (primes:extract2s x) - (do ((k 0 (1+ k)) - (q x (quotient q 2))) - ((odd? q) (cons k q)) - )) - - -;; Raise `base' to the power `exp' modulo `modulus' Could use the -;; modulo package, but we only need this function (and besides, this -;; implementation is quite a bit faster). -;; -(define (primes:expt-mod base exp modulus) - (do ((y 1) - (k exp (quotient k 2)) - (z base (modulo (* z z) modulus))) - ((= k 0) y) - (if (odd? k) - (set! y (modulo (* y z) modulus))) - )) - -(define primes:prngs - (make-random-state "repeatable seed for primes")) - -;; This table seems big enough so that making it larger really -;; doesn't have much effect. -;; -(define primes:max-small-prime 997) - -(define primes:small-primes - '#( 2 3 5 7 11 13 17 19 23 29 - 31 37 41 43 47 53 59 61 67 71 - 73 79 83 89 97 101 103 107 109 113 - 127 131 137 139 149 151 157 163 167 173 - 179 181 191 193 197 199 211 223 227 229 - 233 239 241 251 257 263 269 271 277 281 - 283 293 307 311 313 317 331 337 347 349 - 353 359 367 373 379 383 389 397 401 409 - 419 421 431 433 439 443 449 457 461 463 - 467 479 487 491 499 503 509 521 523 541 - 547 557 563 569 571 577 587 593 599 601 - 607 613 617 619 631 641 643 647 653 659 - 661 673 677 683 691 701 709 719 727 733 - 739 743 751 757 761 769 773 787 797 809 - 811 821 823 827 829 839 853 857 859 863 - 877 881 883 887 907 911 919 929 937 941 - 947 953 967 971 977 983 991 997 )) - -(define primes< primes:primes<) -(define primes> primes:primes>) -(define probably-prime? primes:probably-prime?) - -(provide 'primes) @@ -21,10 +21,13 @@ ;; Parse the output of NUMBER->STRING. ;; Returns a list: (sign-character digit-string exponent-integer) -;; sign-char will be either #\+ or #\-, digit-string will always begin +;; SIGN-CHAR will be either #\+ or #\-, DIGIT-STRING will always begin ;; with a "0", after which a decimal point should be understood. +;; If STR denotes a non-real number, 3 additional elements for the +;; complex part are appended. (define (stdio:parse-float str) - (let ((n (string-length str))) + (let ((n (string-length str)) + (iend 0)) (letrec ((prefix (lambda (i rest) (if (and (< i (- n 1)) @@ -41,7 +44,7 @@ (case c ((#\- #\+) (cons c (rest (+ i 1)))) (else (cons #\+ (rest i)))))))) - (digits + (digits (lambda (i rest) (do ((j i (+ j 1))) ((or (>= j n) @@ -56,45 +59,77 @@ (char=? #\. (string-ref str i))) (rest (+ i 1)) (rest i)))) - (exp + (exp (lambda (i) (if (< i n) (case (string-ref str i) ((#\e #\s #\f #\d #\l #\E #\S #\F #\D #\L) - (let ((s (sign (+ i 1) (lambda (i) (digits i end))))) + (let ((s (sign (+ i 1) (lambda (i) (digits i end!))))) (list (if (char=? #\- (car s)) (- (string->number (cadr s))) (string->number (cadr s)))))) - (else (parse-error))) - '(0)))) - (end + (else (end! i) + '(0))) + (begin (end! i) + '(0))))) + (end! + (lambda (i) + (set! iend i) + '())) + (real (lambda (i) - (if (< i n) (parse-error) '()))) + (let ((parsed + (prefix + i + (lambda (i) + (sign + i + (lambda (i) + (digits + i + (lambda (i) + (point + i + (lambda (i) + (digits i exp))))))))))) + (and (list? parsed) + (apply + (lambda (sgn idigs fdigs exp) + (let* ((digs (string-append "0" idigs fdigs)) + (n (string-length digs))) + (let loop ((i 1) + (exp (+ exp (string-length idigs)))) + (if (and (< i n) + (char=? #\0 (string-ref digs i))) + (loop (+ i 1) (- exp 1)) + (list sgn (substring digs (- i 1) n) exp))))) + parsed))))) (parse-error (lambda () #f))) - (let ((parsed - (prefix 0 - (lambda (i) - (sign i - (lambda (i) - (digits i - (lambda (i) - (point i - (lambda (i) - (digits i exp))))))))))) - (and (list? parsed) - (apply - (lambda (sgn idigs fdigs exp) - (let* ((digs (string-append "0" idigs fdigs)) - (n (string-length digs))) - (let loop ((i 1) - (exp (+ exp (string-length idigs)))) - (if (and (< i n) - (char=? #\0 (string-ref digs i))) - (loop (+ i 1) (- exp 1)) - (list sgn (substring digs (- i 1) n) exp))))) - parsed)))))) + (let ((realpart (real 0))) + (cond ((= iend n) realpart) + ((memv (string-ref str iend) '(#\+ #\-)) + (let ((complexpart (real iend))) + (and (= iend (- n 1)) + (char-ci=? #\i (string-ref str iend)) + (append realpart complexpart)))) + ((eqv? (string-ref str iend) #\@) + ;; Polar form: No point in parsing the angle ourselves, + ;; since some transcendental approximation is unavoidable. + (let ((num (string->number str))) + (and num + (let ((realpart + (stdio:parse-float + (number->string (real-part num)))) + (imagpart + (if (real? num) + '() + (stdio:parse-float + (number->string (imag-part num)))))) + (and realpart imagpart + (append realpart imagpart)))))) + (else #f)))))) ;; STR is a digit string representing a floating point mantissa, STR must ;; begin with "0", after which a decimal point is understood. @@ -109,11 +144,13 @@ (cond ((< ndigs 0) "") ((= n ndigs) str) ((< n ndigs) - (if strip-0s str - (string-append - str (make-string (- ndigs n) - (if (char-numeric? (string-ref str n)) - #\0 #\#))))) + (let ((zeropad (make-string + (max 0 (- (or strip-0s ndigs) n)) + (if (char-numeric? (string-ref str n)) + #\0 #\#)))) + (if (zero? (string-length zeropad)) + str + (string-append str zeropad)))) (else (let ((res (substring str 0 (+ ndigs 1))) (dig (lambda (i) @@ -132,7 +169,7 @@ (let inc! ((i ndigs)) (let ((d (dig i))) (if (< d 9) - (string-set! res i + (string-set! res i (string-ref (number->string (+ d 1)) 0)) (begin @@ -147,7 +184,6 @@ (loop (- i 1)))) res))) - (define (stdio:iprintf out format-string . args) (cond ((not (equal? "" format-string)) @@ -168,11 +204,17 @@ (define (incomplete) (slib:error 'printf "conversion specification incomplete" format-string)) + (define (wna) + (slib:error 'printf "wrong number of arguments" + (length args) + format-string)) (let loop ((args args)) (advance) (cond - ((end-of-format?)) + ((end-of-format?) + ;;(or (null? args) (wna)) ;Extra arguments are *not* a bug. + ) ((eqv? #\\ fc);;Emulating C strings may not be a good idea. (must-advance) (and (case fc @@ -216,7 +258,7 @@ (apply string-append pre (append strs - (list (make-string + (list (make-string (- width len) #\space))))) (leading-0s (apply string-append @@ -278,16 +320,16 @@ (list "." fdigs))))) ((zero? precision) (list (if alternate-form "0." "0"))) - ((string=? digs "") (list "0")) + ((and strip-0s (string=? digs "") (list "0"))) (else (list "0." (make-string (min precision (- -1 exp)) #\0) digs))))) (define (e digs exp strip-0s) - (let* ((digs (stdio:round-string + (let* ((digs (stdio:round-string digs (+ 1 precision) (and strip-0s 0))) (istrt (if (char=? #\0 (string-ref digs 0)) 1 0)) - (fdigs (substring + (fdigs (substring digs (+ 1 istrt) (string-length digs))) (exp (if (zero? istrt) exp (- exp 1)))) (list @@ -299,38 +341,65 @@ (if (negative? exp) "-" "+") (if (< -10 exp 10) "0" "") (number->string (abs exp))))) + (define (g digs exp) + (let ((strip-0s (not alternate-form))) + (set! alternate-form #f) + (cond ((<= (- 1 precision) exp precision) + (set! precision (- precision exp)) + (f digs exp strip-0s)) + (else + (set! precision (- precision 1)) + (e digs exp strip-0s))))) + (define (k digs exp sep) + (let* ((units '#("y" "z" "a" "f" "p" "n" "u" "m" "" + "k" "M" "G" "T" "P" "E" "Z" "Y")) + (base 8) ;index of "" + (uind (let ((i (if (negative? exp) + (quotient (- exp 3) 3) + (quotient (- exp 1) 3)))) + (and + (< -1 (+ i base) (vector-length units)) + i)))) + (cond (uind + (set! exp (- exp (* 3 uind))) + (set! precision (max 0 (- precision exp))) + (append + (f digs exp #f) + (list sep + (vector-ref units (+ uind base))))) + (else + (g digs exp))))) + (cond ((negative? precision) (set! precision 6)) ((and (zero? precision) (char-ci=? fc #\g)) (set! precision 1))) - (let* ((str + (let* ((str (cond ((number? num) (number->string (exact->inexact num))) ((string? num) num) ((symbol? num) (symbol->string num)) (else "???"))) (parsed (stdio:parse-float str))) - (cond (parsed - (apply - (lambda (sgn digs exp) - (apply pad + (letrec ((format-real + (lambda (signed? sgn digs exp . rest) + (if (null? rest) + (cons (if (char=? #\- sgn) "-" - (if signed "+" (if blank " " ""))) + (if signed? "+" (if blank " " ""))) (case fc ((#\e #\E) (e digs exp #f)) ((#\f #\F) (f digs exp #f)) - ((#\g #\G) - (let ((strip-0s (not alternate-form))) - (set! alternate-form #f) - (cond ((< -4 exp (+ 1 precision)) - (set! precision (- precision exp)) - (f digs exp strip-0s)) - (else - (set! precision (- precision 1)) - (e digs exp strip-0s)))))))) - parsed)) - (else str)))) + ((#\g #\G) (g digs exp)) + ((#\k) (k digs exp "")) + ((#\K) (k digs exp " ")))) + (append (format-real signed? sgn digs exp) + (apply format-real #t rest) + '("i")))))) + (if parsed + (apply pad (apply format-real signed parsed)) + (pad "???"))))) (do () ((case fc ((#\-) (set! left-adjust #t) #f) @@ -355,6 +424,13 @@ (set! type-modifier fc) (must-advance))) + ;;At this point fc completely determines the format to use. + (if (null? args) + (if (memv (char-downcase fc) + '(#\c #\s #\a #\d #\i #\u #\o #\x #\b + #\f #\e #\g #\k)) + (wna))) + (case fc ;; only - is allowed between % and c ((#\c #\C) ; C is enhancement @@ -443,7 +519,7 @@ ((#\b #\B) (and (out (integer-convert (car args) 2)) (loop (cdr args)))) ((#\%) (and (out #\%) (loop args))) - ((#\f #\F #\e #\E #\g #\G) + ((#\f #\F #\e #\E #\g #\G #\k #\K) (and (out (float-convert (car args) fc)) (loop (cdr args)))) (else (cond ((end-of-format?) (incomplete)) diff --git a/pscheme.init b/pscheme.init new file mode 100644 index 0000000..dfa05a8 --- /dev/null +++ b/pscheme.init @@ -0,0 +1,202 @@ +;;; "pscheme.init" -*-scheme-*-
+;;; SLIB init file for Pocket Scheme
+;;; SLIB orig Author: Aubrey Jaffer (jaffer@ai.mit.edu)
+;;; Author: Ben Goetter <goetter@angrygraycat.com>
+;;; Initial work for 0.2.3 by Robert Goldman (goldman@htc.honeywell.com)
+;;;
+;;; This code is in the public domain.
+
+; best fit for Windows CE?
+(define (software-type) 'MS-DOS)
+
+(define (scheme-implementation-type) 'PocketScheme)
+(define (scheme-implementation-version) "0.3.6")
+
+(define in-vicinity string-append)
+
+(define (implementation-vicinity)
+ "\\Program Files\\Pocket Scheme\\")
+
+(define (library-vicinity)
+ (in-vicinity (implementation-vicinity) "slib\\"))
+
+(define (home-vicinity)
+ "\\My Documents\\")
+
+(define *features*
+ '(source
+ rev4-report
+ ieee-p1178
+ rev4-optional-procedures
+ multiarg/and-
+ multiarg-apply
+ with-file
+ char-ready?
+ defmacro
+ delay
+ eval
+ dynamic-wind
+ full-continuation
+ ;;trace ; Comment out for SLIB TRACE macros
+ system
+ string-port
+ ))
+
+;;; (OUTPUT-PORT-WIDTH <port>)
+(define (output-port-width . arg) 79)
+
+;;; (OUTPUT-PORT-HEIGHT <port>)
+(define (output-port-height . arg) 12)
+
+;;; (TMPNAM) makes a temporary file name.
+(define tmpnam (let ((cntr 100))
+ (lambda () (set! cntr (+ 1 cntr))
+ (string-append "slib_" (number->string cntr)))))
+
+;;; (FILE-EXISTS? <string>)
+(define (file-exists? f)
+ (let ((file #f))
+ (with-handlers (((lambda (x) #t) (lambda (x) #f)))
+ (set! file (open-input-file f))
+ (close-input-port file)
+ #t)))
+
+;; pscheme: current-error-port, delete-file, force-output already defined
+
+;;; CHAR-CODE-LIMIT is one greater than the largest integer which can
+;;; be returned by CHAR->INTEGER.
+;(define char-code-limit
+; (with-handlers (
+; ((lambda (x) #t) (lambda (x) 256))
+; )
+; (integer->char 65535)
+; 65536))
+;;; Currently there are only three clients of this symbol.
+;;; Following observations relate to PScheme 0.3.5, JACAL 1a9, SLIB 2c5.
+;;; JACAL: crashes when set to 65536.
+;;; make-crc: extremely inefficient when set to 65536, spending forever in init
+;;; precedence-parse: ignores any setting in excess of 256
+;;; So we patch it to 256.
+(define char-code-limit 256)
+
+;;; MOST-POSITIVE-FIXNUM is used in modular.scm
+;;; This is the most positive immediate-value fixnum in PScheme.
+;;; The secondary representation extends fixnum values to 0xffffffff.
+(define most-positive-fixnum #x07FFFFFF)
+
+;;; Return argument
+(define (identity x) x)
+
+;;; SLIB:EVAL is single argument eval using the top-level (user) environment.
+(define slib:eval eval)
+
+;;; If your implementation provides R4RS macros:
+;(define macro:eval slib:eval)
+;(define macro:load load)
+
+(define gentemp
+ (let ((*gensym-counter* -1))
+ (lambda ()
+ (set! *gensym-counter* (+ *gensym-counter* 1))
+ (string->symbol
+ (string-append "slib:G" (number->string *gensym-counter*))))))
+
+(define base:eval slib:eval)
+(define defmacro:eval slib:eval)
+
+(define (slib:eval-load <pathname> evl)
+ (if (not (file-exists? <pathname>))
+ (set! <pathname> (string-append <pathname> (scheme-file-suffix))))
+ (call-with-input-file <pathname>
+ (lambda (port)
+ (let ((old-load-pathname *load-pathname*))
+ (set! *load-pathname* <pathname>)
+ (do ((o (read port) (read port)))
+ ((eof-object? o))
+ (evl o))
+ (set! *load-pathname* old-load-pathname)))))
+
+(define (defmacro:load <pathname>)
+ (slib:eval-load <pathname> defmacro:eval))
+
+(define slib:warn
+ (lambda args
+ (let ((port (current-error-port)))
+ (display "Warn: " port)
+ (for-each (lambda (x) (display x port)) args))))
+
+;;; Define an error procedure for the library
+(define (slib:error . k)
+ (error
+ (cond
+ ((= (length k) 0) '())
+ ((= (length k) 1) (car k))
+ ((provided? 'string-port)
+ (call-with-output-string
+ (lambda (out)
+ (let ((add-space #f))
+ (map
+ (lambda (arg)
+ (if add-space (write-char #\space out) (set! add-space #t))
+ (display arg out))
+ k)))))
+ (else (car k)))))
+
+;;; For the benefit of slib:error above, as announced by feature string-port
+(define (call-with-output-string t)
+ (let* ((p (open-output-string))
+ (r (t p))
+ (s (get-output-string p)))
+ (close-output-port p)
+ s))
+
+(define (call-with-input-string s t)
+ (let* ((p (open-input-string s))
+ (r (t p)))
+ (close-input-port p)
+ r))
+
+;;; define these as appropriate for your system.
+(define slib:tab (integer->char 9))
+(define slib:form-feed (integer->char 12))
+
+;;; Support for older versions of Scheme. Not enough code for its own file.
+(define (last-pair l) (if (pair? (cdr l)) (last-pair (cdr l)) l))
+(define t #t)
+(define nil #f)
+
+;;; Define these if your implementation's syntax can support it and if
+;;; they are not already defined.
+
+(define (1+ n) (+ n 1))
+(define (-1+ n) (+ n -1))
+(define 1- -1+)
+
+;;; Define SLIB:EXIT to be the implementation procedure to exit or
+;;; return if exitting not supported.
+(define slib:exit exit)
+
+;;; Here for backward compatability
+(define (scheme-file-suffix) ".scm")
+
+;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever
+;;; suffix all the module files in SLIB have. See feature 'SOURCE.
+
+(define (slib:load-source f)
+ (if (not (file-exists? f))
+ (set! f (string-append f (scheme-file-suffix))))
+ (load f))
+
+;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced
+;;; by compiling "foo.scm" if this implementation can compile files.
+;;; See feature 'COMPILED.
+
+(define slib:load-compiled load)
+
+;;; At this point SLIB:LOAD must be able to load SLIB files.
+
+(define slib:load slib:load-source)
+
+;;; Hold onto pscheme native version
+(define pscheme:require require)
+(slib:load (in-vicinity (library-vicinity) "require"))
@@ -49,7 +49,7 @@ (if (null? old-first-pair) (queue:set-last-pair! q new-first-pair))) q) - + (define (enqueue! q datum) (let ((new-pair (cons datum '()))) (cond ((null? (queue:first-pair q)) diff --git a/randinex.scm b/randinex.scm index e6dc48b..8a0afd1 100644 --- a/randinex.scm +++ b/randinex.scm @@ -1,5 +1,5 @@ ;;;"randinex.scm" Pseudo-Random inexact real numbers for scheme. -;;; Copyright (C) 1991, 1993 Aubrey Jaffer. +;;; Copyright (C) 1991, 1993, 1999 Aubrey Jaffer. ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -20,28 +20,49 @@ ;This file is loaded by random.scm if inexact numbers are supported by ;the implementation. -;;; Fixed sphere and normal functions from: Harald Hanche-Olsen +;;; Sphere and normal functions corrections from: Harald Hanche-Olsen ;;; Generate an inexact real between 0 and 1. -(define random:uniform - (letrec ((random:chunks/float ; how many chunks fill an inexact? - (letrec ((random:size-float - (lambda (l x) - (cond ((= 1.0 (+ 1 x)) l) - ((= 4 l) l) - (else (random:size-float (+ l 1) (/ x 256.0))))))) - (random:size-float 0 1.0))) - - (random:uniform-chunk - (lambda (n state) - (if (= 1 n) - (/ (exact->inexact (random:chunk state)) - 256.0) - (/ (+ (random:uniform-chunk (- n 1) state) - (exact->inexact (random:chunk state))) - 256.0))))) - (lambda (state) - (random:uniform-chunk random:chunks/float state)))) +(define random:uniform1 + ; how many chunks fill an inexact? + (do ((random:chunks/float 0 (+ 1 random:chunks/float)) + (smidgen 1.0 (/ smidgen 256.0))) + ((or (= 1.0 (+ 1 smidgen)) (= 4 random:chunks/float)) + (lambda (state) + (do ((cnt random:chunks/float (+ -1 cnt)) + (uni (/ (random:chunk state) 256.0) + (/ (+ uni (random:chunk state)) 256.0))) + ((= 1 cnt) uni)))))) + + +;;@args +;;@args state +;;Returns an uniformly distributed inexact real random number in the +;;range between 0 and 1. +(define (random:uniform . args) + (random:uniform1 (if (null? args) *random-state* (car args)))) + + +;;@args +;;@args state +;;Returns an inexact real in an exponential distribution with mean 1. For +;;an exponential distribution with mean @var{u} use +;;@w{@code{(* @var{u} (random:exp))}}. +(define (random:exp . args) + (- (log (random:uniform1 (if (null? args) *random-state* (car args)))))) + + +;;@args +;;@args state +;;Returns an inexact real in a normal distribution with mean 0 and +;;standard deviation 1. For a normal distribution with mean @var{m} and +;;standard deviation @var{d} use +;;@w{@code{(+ @var{m} (* @var{d} (random:normal)))}}. +(define (random:normal . args) + (let ((vect (make-vector 1))) + (apply random:normal-vector! vect args) + (vector-ref vect 0))) + ;;; If x and y are independent standard normal variables, then with ;;; x=r*cos(t), y=r*sin(t), we find that t is uniformly distributed @@ -49,6 +70,10 @@ ;;; 1-exp(-r^2/2). This latter means that u=exp(-r^2/2) is uniformly ;;; distributed on [0,1], so r=sqrt(-2 log u) can be used to generate r. +;;@args vect +;;@args vect state +;;Fills @1 with inexact real random numbers which are independent +;;and standard normally distributed (i.e., with mean 0 and variance 1). (define (random:normal-vector! vect . args) (let ((state (if (null? args) *random-state* (car args))) (sum2 0)) @@ -57,39 +82,44 @@ (set! sum2 (+ sum2 (* x x)))))) (do ((n (- (vector-length vect) 1) (- n 2))) ((negative? n) sum2) - (let ((t (* 6.28318530717958 (random:uniform state))) - (r (sqrt (* -2 (log (random:uniform state)))))) + (let ((t (* 6.28318530717958 (random:uniform1 state))) + (r (sqrt (* -2 (log (random:uniform1 state)))))) (do! n (* r (cos t))) (if (positive? n) (do! (- n 1) (* r (sin t))))))))) -(define random:normal - (let ((vect (make-vector 1))) - (lambda args - (apply random:normal-vector! vect args) - (vector-ref vect 0)))) ;;; For the uniform distibution on the hollow sphere, pick a normal ;;; family and scale. +;;@args vect +;;@args vect state +;;Fills @1 with inexact real random numbers the sum of whose +;;squares is less than 1.0. Thinking of @1 as coordinates in +;;space of dimension @var{n} = @code{(vector-length @1)}, the +;;coordinates are uniformly distributed within the unit @var{n}-shere. +;;The sum of the squares of the numbers is returned. (define (random:hollow-sphere! vect . args) (let ((ms (sqrt (apply random:normal-vector! vect args)))) (do ((n (- (vector-length vect) 1) (- n 1))) ((negative? n)) (vector-set! vect n (/ (vector-ref vect n) ms))))) + ;;; For the uniform distribution on the solid sphere, note that in ;;; this distribution the length r of the vector has cumulative ;;; distribution r^n; i.e., u=r^n is uniform [0,1], so r can be ;;; generated as r=u^(1/n). +;;@args vect +;;@args vect state +;;Fills @1 with inexact real random numbers the sum of whose +;;squares is equal to 1.0. Thinking of @1 as coordinates in space +;;of dimension n = @code{(vector-length @1)}, the coordinates are +;;uniformly distributed over the surface of the unit n-shere. (define (random:solid-sphere! vect . args) (apply random:hollow-sphere! vect args) - (let ((r (expt (random:uniform (if (null? args) *random-state* (car args))) + (let ((r (expt (random:uniform1 (if (null? args) *random-state* (car args))) (/ (vector-length vect))))) (do ((n (- (vector-length vect) 1) (- n 1))) ((negative? n)) (vector-set! vect n (* r (vector-ref vect n)))))) - -(define (random:exp . args) - (let ((state (if (null? args) *random-state* (car args)))) - (- (log (random:uniform state))))) diff --git a/randinex.txi b/randinex.txi new file mode 100644 index 0000000..1d0a639 --- /dev/null +++ b/randinex.txi @@ -0,0 +1,74 @@ + + + + + + +@defun random:uniform + + +@defunx random:uniform state +Returns an uniformly distributed inexact real random number in the +range between 0 and 1. +@end defun + + + +@defun random:exp + + +@defunx random:exp state +Returns an inexact real in an exponential distribution with mean 1. For +an exponential distribution with mean @var{u} use +@w{@code{(* @var{u} (random:exp))}}. +@end defun + + + +@defun random:normal + + +@defunx random:normal state +Returns an inexact real in a normal distribution with mean 0 and +standard deviation 1. For a normal distribution with mean @var{m} and +standard deviation @var{d} use +@w{@code{(+ @var{m} (* @var{d} (random:normal)))}}. +@end defun + + + + +@defun random:normal-vector! vect + + +@defunx random:normal-vector! vect state +Fills @var{vect} with inexact real random numbers which are independent +and standard normally distributed (i.e., with mean 0 and variance 1). +@end defun + + + + +@defun random:hollow-sphere! vect + + +@defunx random:hollow-sphere! vect state +Fills @var{vect} with inexact real random numbers the sum of whose +squares is less than 1.0. Thinking of @var{vect} as coordinates in +space of dimension @var{n} = @code{(vector-length @var{vect})}, the +coordinates are uniformly distributed within the unit @var{n}-shere. +The sum of the squares of the numbers is returned. +@end defun + + + + +@defun random:solid-sphere! vect + + +@defunx random:solid-sphere! vect state +Fills @var{vect} with inexact real random numbers the sum of whose +squares is equal to 1.0. Thinking of @var{vect} as coordinates in space +of dimension n = @code{(vector-length @var{vect})}, the coordinates are +uniformly distributed over the surface of the unit n-shere. +@end defun @@ -1,5 +1,5 @@ ;;;; "random.scm" Pseudo-Random number generator for scheme. -;;; Copyright (C) 1991, 1993 Aubrey Jaffer. +;;; Copyright (C) 1991, 1993, 1998, 1999 Aubrey Jaffer. ; ;Permission to copy this software, to redistribute it, and to use it ;for any purpose is granted, subject to the following restrictions and @@ -20,77 +20,120 @@ (require 'byte) (require 'logical) -(define (make-rng seed) - (define mutex #f) - (define idx 0) - (define idy 0) - (define sta (make-bytes 256)) - ; initialize state - (do ((idx #xff (+ -1 idx))) - ((negative? idx)) - (byte-set! sta idx idx)) - - (if (number? seed) - (set! seed (number->string seed))) - - ; merge seed into state - (do ((idx 0 (+ 1 idx)) - (kdx 0 (modulo (+ 1 kdx) seed-len)) - (seed-len (bytes-length seed))) - ((>= idx 256) (set! idy 0)) - (let ((swp (byte-ref sta idx))) - (set! idy (logand #xff (+ idy (byte-ref seed kdx) swp))) - (byte-set! sta idx (byte-ref sta idy)) - (byte-set! sta idy swp))) - ; spew - (lambda () - (if mutex (slib:error "random state called reentrantly")) - (set! mutex #t) - (set! idx (logand #xff (+ 1 idx))) - (let ((xtm (byte-ref sta idx))) - (set! idy (logand #xff (+ idy xtm))) - (let ((ytm (byte-ref sta idy))) - (byte-set! sta idy xtm) - (byte-set! sta idx ytm) - (let ((ans (byte-ref sta (logand #xff (+ ytm xtm))))) - (set! mutex #f) - ans))))) - -(define *random-state* - (make-rng "http://swissnet.ai.mit.edu/~jaffer/SLIB.html")) - ;;; random:chunk returns an integer in the range of 0 to 255. -(define (random:chunk v) (v)) +(define (random:chunk sta) + (cond ((positive? (byte-ref sta 258)) + (byte-set! sta 258 0) + (slib:error "random state called reentrantly"))) + (byte-set! sta 258 1) + (let* ((idx (logand #xff (+ 1 (byte-ref sta 256)))) + (xtm (byte-ref sta idx)) + (idy (logand #xff (+ (byte-ref sta 257) xtm)))) + (byte-set! sta 256 idx) + (byte-set! sta 257 idy) + (let ((ytm (byte-ref sta idy))) + (byte-set! sta idy xtm) + (byte-set! sta idx ytm) + (let ((ans (byte-ref sta (logand #xff (+ ytm xtm))))) + (byte-set! sta 258 0) + ans)))) + -(define (random:random modu . args) +;;@args n +;;@args n state +;;Accepts a positive integer or real @1 and returns a number of the +;;same type between zero (inclusive) and @1 (exclusive). The values +;;returned by @0 are uniformly distributed from 0 to @1. +;; +;;The optional argument @var{state} must be of the type returned by +;;@code{(seed->random-state)} or @code{(make-random-state)}. It defaults +;;to the value of the variable @code{*random-state*}. This object is used +;;to maintain the state of the pseudo-random-number generator and is +;;altered as a side effect of calls to @code{random}. +(define (random modu . args) (let ((state (if (null? args) *random-state* (car args)))) (if (exact? modu) - (let ((bitlen (integer-length (+ -1 modu)))) - (do ((bln bitlen (+ -8 bln)) - (rbs 0 (+ (ash rbs 8) (random:chunk state)))) - ((<= bln 7) - (modulo - (if (zero? bln) rbs - (+ (ash rbs bln) - (logand (bit-field (random:chunk state) 0 bln)))) - modu)))) + (letrec ((bitlen (integer-length (+ -1 modu))) + (rnd (lambda () + (do ((bln bitlen (+ -8 bln)) + (rbs 0 (+ (ash rbs 8) (random:chunk state)))) + ((<= bln 7) + (set! rbs (+ (ash rbs bln) + (bit-field (random:chunk state) 0 bln))) + (and (< rbs modu) rbs)))))) + (do ((ans (rnd) (rnd))) (ans ans))) + (* (random:uniform1 state) modu)))) - (* (random:uniform state) modu)))) +(define random:random random) ;;;random:uniform is in randinex.scm. It is needed only if inexact is ;;;supported. + +;;@defvar *random-state* +;;Holds a data structure that encodes the internal state of the +;;random-number generator that @code{random} uses by default. The nature +;;of this data structure is implementation-dependent. It may be printed +;;out and successfully read back in, but may or may not function correctly +;;as a random-number state object in another implementation. +;;@end defvar + + +;;@args state +;;Returns a new copy of argument @1. +;; +;;@args +;;Returns a new copy of @code{*random-state*}. +(define (copy-random-state . sta) + (copy-string (if (null? sta) *random-state* (car sta)))) + + +;;@body +;;Returns a new object of type suitable for use as the value of the +;;variable @code{*random-state*} or as a second argument to @code{random}. +;;The number or string @1 is used to initialize the state. If +;;@0 is called twice with arguments which are +;;@code{equal?}, then the returned data structures will be @code{equal?}. +;;Calling @0 with unequal arguments will nearly +;;always return unequal states. +(define (seed->random-state seed) + (define sta (make-bytes (+ 3 256) 0)) + (if (number? seed) (set! seed (number->string seed))) + ; initialize state + (do ((idx #xff (+ -1 idx))) + ((negative? idx)) + (byte-set! sta idx idx)) + ; merge seed into state + (do ((i 0 (+ 1 i)) + (j 0 (modulo (+ 1 j) seed-len)) + (seed-len (bytes-length seed)) + (k 0)) + ((>= i 256)) + (let ((swp (byte-ref sta i))) + (set! k (logand #xff (+ k (byte-ref seed j) swp))) + (byte-set! sta i (byte-ref sta k)) + (byte-set! sta k swp))) + sta) + + +;;@args +;;@args obj +;;Returns a new object of type suitable for use as the value of the +;;variable @code{*random-state*} or as a second argument to @code{random}. +;;If the optional argument @var{obj} is given, it should be a printable +;;Scheme object; the first 50 characters of its printed representation +;;will be used as the seed. Otherwise the value of @code{*random-state*} +;;is used as the seed. (define (make-random-state . args) - (let ((seed (if (null? args) - (do ((bts (make-bytes 10)) - (idx 0 (+ 1 idx))) - ((>= idx 10) bts) - (byte-set! bts idx (random:random 256))) - (let () - (require 'object->string) - (object->limited-string (car args) 20))))) - (make-rng seed))) + (let ((seed (if (null? args) *random-state* (car args)))) + (cond ((string? seed)) + ((number? seed) (set! seed (number->string seed))) + (else (let () + (require 'object->string) + (set! seed (object->limited-string seed 50))))) + (seed->random-state seed))) -(define random random:random) +(define *random-state* + (make-random-state "http://swissnet.ai.mit.edu/~jaffer/SLIB.html")) (provide 'random) ;to prevent loops (if (provided? 'inexact) (require 'random-inexact)) diff --git a/random.txi b/random.txi new file mode 100644 index 0000000..f144837 --- /dev/null +++ b/random.txi @@ -0,0 +1,69 @@ + + + + + +@defun random n + + +@defunx random n state +Accepts a positive integer or real @var{n} and returns a number of the +same type between zero (inclusive) and @var{n} (exclusive). The values +returned by @code{random} are uniformly distributed from 0 to @var{n}. + +The optional argument @var{state} must be of the type returned by +@code{(seed->random-state)} or @code{(make-random-state)}. It defaults +to the value of the variable @code{*random-state*}. This object is used +to maintain the state of the pseudo-random-number generator and is +altered as a side effect of calls to @code{random}. +@end defun + + + + +@defvar *random-state* +Holds a data structure that encodes the internal state of the +random-number generator that @code{random} uses by default. The nature +of this data structure is implementation-dependent. It may be printed +out and successfully read back in, but may or may not function correctly +as a random-number state object in another implementation. +@end defvar + + +@defun copy-random-state state + +Returns a new copy of argument @var{state}. + + +@defunx copy-random-state +Returns a new copy of @code{*random-state*}. +@end defun + + + +@defun seed->random-state seed + +Returns a new object of type suitable for use as the value of the +variable @code{*random-state*} or as a second argument to @code{random}. +The number or string @var{seed} is used to initialize the state. If +@code{seed->random-state} is called twice with arguments which are +@code{equal?}, then the returned data structures will be @code{equal?}. +Calling @code{seed->random-state} with unequal arguments will nearly +always return unequal states. +@end defun + + + +@defun make-random-state + + +@defunx make-random-state obj +Returns a new object of type suitable for use as the value of the +variable @code{*random-state*} or as a second argument to @code{random}. +If the optional argument @var{obj} is given, it should be a printable +Scheme object; the first 50 characters of its printed representation +will be used as the seed. Otherwise the value of @code{*random-state*} +is used as the seed. +@end defun + + @@ -79,6 +79,7 @@ (not (negative? x)))) integer #f) + (number #f number? number #f) (expression #f #f expression #f) (boolean #f boolean? boolean #f) (symbol #f symbol? symbol #f) @@ -252,6 +253,7 @@ (primary-limit 1) (column-name-alist '()) (column-foreign-list '()) + (column-foreign-check-list '()) (column-domain-list '()) (column-type-list '()) (export-alist '()) @@ -283,24 +285,26 @@ (set! column-domain-list (cons column-domain column-domain-list)) (set! column-foreign-list - (cons - (let ((foreign-name - (row-ref dom:row domains:foreign-pos))) - (cond - ((or (not foreign-name) - (eq? foreign-name table-name)) #f) - (else - (let* ((tab (open-table foreign-name #f)) - (p? (and tab (tab 'get 1)))) - (cond - ((not tab) - (rdms:error "foreign key table missing for:" - foreign-name)) - ((not (= (tab 'primary-limit) 1)) - (rdms:error "foreign key table wrong type:" - foreign-name)) - (else p?)))))) - column-foreign-list)))) + (cons (let ((foreign-name + (row-ref dom:row domains:foreign-pos))) + (and (not (eq? foreign-name table-name)) + foreign-name)) + column-foreign-list)) + (set! column-foreign-check-list + (cons + (let ((foreign-name (car column-foreign-list))) + (and foreign-name + (let* ((tab (open-table foreign-name #f)) + (p? (and tab (tab 'get 1)))) + (cond + ((not tab) + (rdms:error "foreign key table missing for:" + foreign-name)) + ((not (= (tab 'primary-limit) 1)) + (rdms:error "foreign key table wrong type:" + foreign-name)) + (else p?))))) + column-foreign-check-list)))) (else (rdms:error "missing domain for column:" ci column-name))) (cond @@ -409,7 +413,7 @@ (rdms:error "foreign key missing:" table-name column-name value)))) cirs dirs row column-name-alist column-domain-list - column-foreign-list) + column-foreign-check-list) (cond ((and uir (not (uir row))) (rdms:error "violated user integrity rule:" row))))) diff --git a/recobj.scm b/recobj.scm new file mode 100644 index 0000000..36ab6d2 --- /dev/null +++ b/recobj.scm @@ -0,0 +1,55 @@ +;;; "recobj.scm" Records implemented as objects. +;;;From: whumeniu@datap.ca (Wade Humeniuk) + +(require 'object) +(require 'common-list-functions) + +(define record-type-name (make-generic-method)) +(define record-accessor (make-generic-method)) +(define record-modifier (make-generic-method)) +(define record? (make-generic-predicate)) +(define record-constructor (make-generic-method)) + +(define (make-record-type type-name field-names) + (define self (make-object)) + + (make-method! self record-type-name + (lambda (self) + type-name)) + (make-method! self record-accessor + (lambda (self field-name) + (let ((index (comlist:position field-name field-names))) + (if (not index) + (slib:error "record-accessor: invalid field-name argument." + field-name)) + (lambda (obj) + (record-accessor obj index))))) + + (make-method! self record-modifier + (lambda (self field-name) + (let ((index (comlist:position field-name field-names))) + (if (not index) + (slib:error "record-accessor: invalid field-name argument." + field-name)) + (lambda (obj newval) + (record-modifier obj index newval))))) + + (make-method! self record? (lambda (self) #t)) + + (make-method! self record-constructor + (lambda (class . field-values) + (let ((values (apply vector field-values))) + (define self (make-object)) + (make-method! self record-accessor + (lambda (self index) + (vector-ref values index))) + (make-method! self record-modifier + (lambda (self index newval) + (vector-set! values index newval))) + (make-method! self record-type-name + (lambda (self) (record-type-name class))) + self))) + self) + +(provide 'record-object) +(provide 'record)
\ No newline at end of file diff --git a/require.scm b/require.scm index ebaf49f..a578349 100644 --- a/require.scm +++ b/require.scm @@ -17,7 +17,7 @@ ;promotional, or sales literature without prior written consent in ;each case. -(define *SLIB-VERSION* "2c3") +(define *SLIB-VERSION* "2c7") ;;; Standardize msdos -> ms-dos. (define software-type @@ -31,44 +31,43 @@ (else ""))) (define *load-pathname* #f) -(define program-vicinity - (let ((*vicinity-suffix* +(define vicinity:suffix? + (let ((suffi (case (software-type) - ((AMIGA) '(#\: #\/)) + ((AMIGA) '(#\: #\/)) + ((MACOS THINKC) '(#\:)) ((MS-DOS WINDOWS ATARIST OS/2) '(#\\ #\/)) - ((MACOS THINKC) '(#\:)) - ((NOSVE) '(#\: #\.)) - ((UNIX COHERENT) '(#\/)) - ((VMS) '(#\: #\]))))) - (lambda () - (if *load-pathname* - (let loop ((i (- (string-length *load-pathname*) 1))) - (cond ((negative? i) "") - ((memv (string-ref *load-pathname* i) *vicinity-suffix*) - (substring *load-pathname* 0 (+ i 1))) - (else (loop (- i 1))))) - (slib:error "Not loading but called" 'program-vicinity))))) + ((NOSVE) '(#\: #\.)) + ((UNIX COHERENT) '(#\/)) + ((VMS) '(#\: #\]))))) + (lambda (chr) (memv chr suffi)))) +(define (program-vicinity) + (if *load-pathname* + (let loop ((i (- (string-length *load-pathname*) 1))) + (cond ((negative? i) "") + ((vicinity:suffix? (string-ref *load-pathname* i)) + (substring *load-pathname* 0 (+ i 1))) + (else (loop (- i 1))))) + (slib:error "Not loading but called" 'program-vicinity))) (define sub-vicinity (case (software-type) - ((VMS) - (lambda - (vic name) - (let ((l (string-length vic))) - (if (or (zero? (string-length vic)) - (not (char=? #\] (string-ref vic (- l 1))))) - (string-append vic "[" name "]") - (string-append (substring vic 0 (- l 1)) - "." name "]"))))) - (else - (let ((*vicinity-suffix* - (case (software-type) - ((NOSVE) ".") - ((UNIX COHERENT AMIGA) "/") - ((MACOS THINKC) ":") - ((MS-DOS WINDOWS ATARIST OS/2) "\\")))) - (lambda (vic name) - (string-append vic name *vicinity-suffix*)))))) + ((VMS) (lambda + (vic name) + (let ((l (string-length vic))) + (if (or (zero? (string-length vic)) + (not (char=? #\] (string-ref vic (- l 1))))) + (string-append vic "[" name "]") + (string-append (substring vic 0 (- l 1)) + "." name "]"))))) + (else (let ((*vicinity-suffix* + (case (software-type) + ((NOSVE) ".") + ((MACOS THINKC) ":") + ((MS-DOS WINDOWS ATARIST OS/2) "\\") + ((UNIX COHERENT AMIGA) "/")))) + (lambda (vic name) + (string-append vic name *vicinity-suffix*)))))) (define (make-vicinity <pathname>) <pathname>) @@ -149,3 +149,69 @@ df+sqrt-H df-sqrt-H))))) (loop next-z (f next-z)))))))) + +(define (secant:find-root-1 f x0 x1 prec must-bracket?) + (letrec ((stop? + (cond ((procedure? prec) prec) + ((and (integer? prec) (negative? prec)) + (lambda (x0 x1 fmax count) + (>= count (- prec)))) + (else + (lambda (x0 f0 x1 f1 count) + (and (< (abs f0) prec) + (< (abs f1) prec)))))) + (bracket-iter + (lambda (xlo flo glo xhi fhi ghi count) + (define (step xnew fnew) + (cond ((or (= xnew xlo) + (= xnew xhi)) + (let ((xmid (+ xlo (* 1/2 (- xhi xlo))))) + (if (= xnew xmid) + xmid + (step xmid (f xmid))))) + ((positive? fnew) + (bracket-iter xlo flo (if glo (* 0.5 glo) 1) + xnew fnew #f + (+ count 1))) + (else + (bracket-iter xnew fnew #f + xhi fhi (if ghi (* 0.5 ghi) 1) + (+ count 1))))) + (if (stop? xlo flo xhi fhi count) + (if (> (abs flo) (abs fhi)) xhi xlo) + (let* ((fflo (if glo (* glo flo) flo)) + (ffhi (if ghi (* ghi fhi) fhi)) + (del (- (/ fflo (- ffhi fflo)))) + (xnew (+ xlo (* del (- xhi xlo)))) + (fnew (f xnew))) + (step xnew fnew)))))) + (let ((f0 (f x0)) + (f1 (f x1))) + (cond ((<= f0 0 f1) + (bracket-iter x0 f0 #f x1 f1 #f 0)) + ((<= f1 0 f0) + (bracket-iter x1 f1 #f x0 f0 #f 0)) + (must-bracket? #f) + (else + (let secant-iter ((x0 x0) + (f0 f0) + (x1 x1) + (f1 f1) + (count 0)) + (cond ((stop? x0 f0 x1 f1 count) + (if (> (abs f0) (abs f1)) x1 x0)) + ((<= f0 0 f1) + (bracket-iter x0 f0 #f x1 f1 #f count)) + ((>= f0 0 f1) + (bracket-iter x1 f1 #f x0 f0 #f count)) + ((= f0 f1) #f) + (else + (let* ((xnew (+ x0 (* (- (/ f0 (- f1 f0))) (- x1 x0)))) + (fnew (f xnew)) + (fmax (max (abs f1) (abs fnew)))) + (secant-iter x1 f1 xnew fnew (+ count 1))))))))))) + +(define (secant:find-root f x0 x1 prec) + (secant:find-root-1 f x0 x1 prec #f)) +(define (secant:find-bracketed-root f x0 x1 prec) + (secant:find-root-1 f x0 x1 prec #t)) @@ -28,7 +28,7 @@ (and (pair? fast) (let ((fast (cdr fast))) (or (null? fast) - (and (pair? fast) + (and (pair? fast) (let ((fast (cdr fast)) (slow (cdr slow))) (and (not (eq? fast slow)) @@ -160,7 +160,7 @@ (let* ((dot? #f) (mantissa (read-word width - (lambda (c) + (lambda (c) (not (or (char-numeric? c) (cond (dot? #f) ((eqv? #\. c) diff --git a/scheme2c.init b/scheme2c.init index 0743113..233285a 100644 --- a/scheme2c.init +++ b/scheme2c.init @@ -1,22 +1,7 @@ -;"scheme2c.init" Initialisation for SLIB for Scheme->C on Sun -*-scheme-*- -;Copyright 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer -;Copyright 1991 David Love -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; "scheme2c.init" Initialisation for SLIB for Scheme->C on Sun -*-scheme-*- +;;; Authors: David Love and Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;Modified by David Love (d.love@daresbury.ac.uk) 10/12/91 ;; NB this is for the 01nov91 (and, presumably, later ones, @@ -36,6 +21,12 @@ (define (scheme-implementation-type) 'Scheme->C) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) #f) + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. diff --git a/scheme48.init b/scheme48.init index 6df37b8..8258d97 100644 --- a/scheme48.init +++ b/scheme48.init @@ -1,21 +1,7 @@ ;;;"scheme48.init" Initialisation for SLIB for Scheme48 -*-scheme-*- -;;; Copyright (C) 1992, 1993, 1994, 1995, 1997 Aubrey Jaffer. -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; If you know the magic incantation to make a "," command available ;;; as a scheme procedure, you can make a nifty slib function to do @@ -32,6 +18,13 @@ (define (scheme-implementation-type) 'Scheme48) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://www.neci.nj.nec.com/homepages/kelsey.html") + ;;; (scheme-implementation-version) should return a string describing ;;; the version of the scheme implementation loading this file. @@ -39,9 +32,7 @@ (cond ((= -86400 (modulo -2177452800 -86400)) (display "scheme48-0.36 has been superseded by") (newline) - (display "ftp@ftp-swiss.ai.mit.edu:pub/s48/scheme48-0.46.tgz") - (newline) - (display "ftp://ftp-swiss.ai.mit.edu/pub/s48/scheme48-0.46.tgz") + (display "http://swissnet.ai.mit.edu/ftpdir/s48/scheme48-0.46.tgz") (newline) (lambda () "0.36")) (else (lambda () "0.46")))) diff --git a/schmooz.scm b/schmooz.scm index 9664ac3..a09f3df 100644 --- a/schmooz.scm +++ b/schmooz.scm @@ -1,4 +1,4 @@ -;;; schmooz.scm: Program for extracting texinfo comments from Scheme. +;;; "schmooz.scm" Program for extracting texinfo comments from Scheme. ;;; Copyright (C) 1998 Radey Shouman and Aubrey Jaffer. ; ;Permission to copy this software, to redistribute it, and to use it @@ -17,7 +17,7 @@ ;promotional, or sales literature without prior written consent in ;each case. -;;$Header: /usr/local/cvsroot/slib/schmooz.scm,v 1.7 1998/09/10 20:34:26 radey Exp $ +;;$Header: /usr/local/cvsroot/slib/schmooz.scm,v 1.12 1999/10/11 03:36:29 jaffer Exp $ ;;$Name: $ ;;; REPORT an error or warning @@ -75,10 +75,10 @@ (display a *derived-txi*)) ((string? a) (display a *derived-txi*) - #+f - (cond ((string-index a #\nl) - (set! *output-line* (+ 1 *output-line*)) - (report "newline in string" a)))) +; (cond ((string-index a #\newline) +; (set! *output-line* (+ 1 *output-line*)) +; (report "newline in string" a))) + ) (else (display a *derived-txi*)))) args)) @@ -97,7 +97,7 @@ (if close (slib:error close "not found in" line) (cons iend - (reverse + (reverse (if (> iend istrt) (cons (substring line istrt iend) args) args))))) @@ -127,7 +127,7 @@ (tok1 (+ 1 istrt) #\} (lambda (c) (eqv? c #\,)) #f)) ((eqv? #\( (string-ref line istrt)) (tok1 (+ 1 istrt) #\) char-whitespace? ".")) - (else + (else (tok1 istrt #f char-whitespace? #f))))) @@ -150,15 +150,15 @@ (res '())) (cond ((>= i (string-length line)) (list - (apply string-append - (reverse + (apply string-append + (reverse (cons (substring line istrt (string-length line)) res))))) ((char=? #\@ (string-ref line i)) (let* ((w (get-word i)) (symw (string->symbol w))) (cond ((eq? '@cname symw) - (let ((args (parse-args + (let ((args (parse-args line (+ i (string-length w))))) (cond ((and args (= 2 (length args))) (loop (car args) (car args) @@ -234,7 +234,7 @@ (else (slib:error 'schmooz "doesn't look like definition" sexp)))) ;; Generate alist of argument macro definitions. -;; If ARGS is a symbol or string, then the definitions will be used in a +;; If ARGS is a symbol or string, then the definitions will be used in a ;; `defvar', if ARGS is a (possibly improper) list, they will be used in ;; a `defun'. (define (scheme-args->macros args) @@ -250,7 +250,7 @@ (args (if fun? (cdr args) '()))) (let ((m0 (string-append (if fun? "@code{" "@var{") (arg->string arg0) "}"))) - (append + (append (list (cons '@arg0 m0) (cons '@0 m0)) (let recur ((i 1) (args args)) @@ -262,7 +262,7 @@ (append (arg->macros (car args) i) (recur (+ i 1) (cdr args)))))))))) -;; Extra processing to be done for @dfn +;; Extra processing to be done for @dfn (define (out-cindex arg) (out 0 "@cindex " arg)) @@ -285,7 +285,7 @@ args)) " @dots{}")) ((pair? args) - (out CONTLINE " " + (out CONTLINE " " (if (or (eq? '... (car args)) (equal? "..." (car args))) "@dots{}" @@ -309,7 +309,7 @@ ((@dfn) (out-cindex (cadr l))) ((@args) - (out-header + (out-header (cons (car args) (cdr l)) (cdr ops))))) (cdr subl))) @@ -348,7 +348,9 @@ (texi? (filename:match-ci?? "*??texi"))) (lambda (filename) (or (txi-file? filename) (tex? filename) - (texi? filename)))))) + (texi? filename))))) + (txi->scm (filename:substitute?? "*txi" "*scm")) + (scm->txi (filename:substitute?? "*scm" "*txi"))) (define (schmooz-texi-file file) (call-with-input-file file (lambda (port) @@ -358,10 +360,8 @@ (let ((fname #f)) (cond ((not (eqv? 1 (fscanf port " %s" fname)))) ((not (txi-file? fname))) - ((not (file-exists? - (replace-suffix fname "txi" "scm")))) - (else (schmooz - (replace-suffix fname "txi" "scm"))))))))) + ((not (file-exists? (txi->scm fname)))) + (else (schmooz (txi->scm fname))))))))) (define (schmooz-scm-file file txi-name) (display "Schmoozing ") (write file) (display " -> ") (write txi-name) (newline) @@ -378,7 +378,7 @@ (define sl (string-length file)) (cond ((scheme-file? file) (schmooz-scm-file - file (replace-suffix file "scm" "txi"))) + file (scm->txi file))) ((texi-file? file) (schmooz-texi-file file)))) files)))) @@ -407,19 +407,13 @@ (read-cmt-line)) (else (read-line *scheme-source*)))) - (define (read-newline) - (if (char=? #\cr (read-char *scheme-source*)) - (if (char=? #\nl (peek-char *scheme-source*)) - (read-char *scheme-source*) - (report "stranded #\\cr")))) - (define (lp c) (cond ((eof-object? c) (cond ((pair? doc-lines) (report "No definition found for @body doc lines" (reverse doc-lines))))) - ((memv c '(#\cr #\nl)) - (read-newline) + ((eqv? c #\newline) + (read-char *scheme-source*) (set! *output-line* (+ 1 *output-line*)) (newline *derived-txi*) (lp (peek-char *scheme-source*))) @@ -428,20 +422,25 @@ (lp (peek-char *scheme-source*))) ((char=? c #\;) (c-cmt c)) - (else + (else (sx)))) (define (sx) (let* ((s1 (read *scheme-source*)) - (ss ;Read all forms separated only by single newlines. - (let recur () - (case (peek-char *scheme-source*) - ((#\cr) (read-char *scheme-source*) (recur)) - ((#\nl) (read-char *scheme-source*) - (if (eqv? #\( (peek-char *scheme-source*)) - (cons (read *scheme-source*) (recur)) - '())) - (else '()))))) + ;;Read all forms separated only by single newlines + ;;and trailing whitespace. + (ss (let recur () + (let ((c (peek-char *scheme-source*))) + (cond ((eqv? c #\newline) + (read-char *scheme-source*) + (if (eqv? #\( (peek-char *scheme-source*)) + (let ((s (read *scheme-source*))) + (cons s (recur))) + '())) + ((char-whitespace? c) + (read-char *scheme-source*) + (recur)) + (else '())))))) (cond ((eof-object? s1)) (else (schmooz-top s1 ss (reverse doc-lines) doc-args) @@ -453,12 +452,12 @@ (let ((subl (substitute-macs line '()))) (newline *derived-txi*) (display (car subl) *derived-txi*) - (for-each + (for-each (lambda (l) (case (car l) ((@dfn) (out-cindex (cadr l))) - (else + (else (report "bad macro" line)))) (cdr subl)))) @@ -474,8 +473,8 @@ (tok (tok1 line))) (cond ((or (string=? tok "@body") (string=? tok "@text")) - (set! doc-lines - (cons (skip-ws line (string-length tok)) + (set! doc-lines + (cons (skip-ws line (string-length tok)) doc-lines)) (body-cmt (peek-char *scheme-source*))) ((string=? tok "@args") @@ -504,14 +503,14 @@ ((eqv? #\; c) (set! doc-lines (cons (read-cmt-line) doc-lines)) (body-cmt (peek-char *scheme-source*))) - ((memv c '(#\nl #\cr)) - (read-newline) + ((eqv? c #\newline) + (read-char *scheme-source*) (lp (peek-char *scheme-source*))) ;; Allow whitespace before ; in doc comments. ((char-whitespace? c) (read-char *scheme-source*) (body-cmt (peek-char *scheme-source*))) - (else + (else (lp (peek-char *scheme-source*))))) ;;Comments incorporated in generated Texinfo files. @@ -523,15 +522,15 @@ (out-cmt (read-cmt-line)) ;;(out-c-cmt (car ls)) (doc-cmt (peek-char *scheme-source*))) - ((memv c '(#\nl #\cr)) - (read-newline) + ((eqv? c #\newline) + (read-char *scheme-source*) (newline *derived-txi*) (lp (peek-char *scheme-source*))) ;; Allow whitespace before ; in doc comments. ((char-whitespace? c) (read-char *scheme-source*) (doc-cmt (peek-char *scheme-source*))) - (else + (else (newline *derived-txi*) (lp (peek-char *scheme-source*))))) (lp (peek-char *scheme-source*)))) @@ -559,10 +558,10 @@ (let ((a (def->args (car ss)))) (loop (cdr ss) (if args - (if a + (if a (cons a smatch) smatch) - (if a + (if a smatch (cons (def->var-name (car ss)) smatch))))))))))))) @@ -571,7 +570,8 @@ (define (schmooz-top sexp1 sexps doc proc-args) (cond ((not (pair? sexp1))) ((pair? sexps) - (schmooz-top-doc-begin sexp1 sexps doc proc-args) + (if (pair? doc) + (schmooz-top-doc-begin sexp1 sexps doc proc-args)) (set! doc '())) (else (case (car sexp1) @@ -599,7 +599,7 @@ (schmooz-var (car sexp1) (cadr sexp1) doc '()) (set! doc '())))))))))) (or (null? doc) - (report + (report "SCHMOOZ: no definition found for Texinfo documentation" doc sexp)) (set! *procedure* #f)) @@ -1,4 +1,7 @@ -;"scsh.init" Initialisation for SLIB for Scsh 0.5.1 -*-scheme-*- +;;; "scsh.init" Initialisation for SLIB for Scsh 0.5.1 -*-scheme-*- +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; (software-type) should be set to the generic operating system type. ;;; UNIX, VMS, MACOS, AMIGA and MS-DOS are supported. @@ -10,6 +13,13 @@ (define (scheme-implementation-type) 'Scsh) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://swissnet.ai.mit.edu/scsh/") + ;;; (scheme-implementation-version) should return a string describing ;;; the version the scheme implementation loading this file. diff --git a/sierpinski.scm b/sierpinski.scm index a4de2d6..6300e8a 100644 --- a/sierpinski.scm +++ b/sierpinski.scm @@ -10,7 +10,7 @@ (lambda (x y) (if (not (and (<= 0 x max-coordinate) (<= 0 y max-coordinate))) - (slib:error 'sierpinski-index + (slib:error 'sierpinski-index "Coordinate exceeds specified maximum.") ; ; The following two mutually recursive procedures diff --git a/slib.info b/slib.info new file mode 100644 index 0000000..8e62273 --- /dev/null +++ b/slib.info @@ -0,0 +1,11240 @@ +This is Info file slib.info, produced by Makeinfo version 1.68 from the +input file slib.texi. + +INFO-DIR-SECTION The Algorithmic Language Scheme +START-INFO-DIR-ENTRY +* SLIB: (slib). Scheme Library +END-INFO-DIR-ENTRY + + This file documents SLIB, the portable Scheme library. + + Copyright (C) 1993 Todd R. Eigenschink +Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999 Aubrey Jaffer | + + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of this +manual under the conditions for verbatim copying, provided that the +entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the author. + + +File: slib.info, Node: Top, Next: The Library System, Prev: (dir), Up: (dir) + +"SLIB" is a portable library for the programming language "Scheme". It | +provides a platform independent framework for using "packages" of | +Scheme procedures and syntax. As distributed, SLIB contains useful +packages for all Scheme implementations. Its catalog can be | +transparently extended to accomodate packages specific to a site, | +implementation, user, or directory. | + +* Menu: + +* The Library System:: How to use and customize. +* Scheme Syntax Extension Packages:: +* Textual Conversion Packages:: +* Mathematical Packages:: +* Database Packages:: +* Other Packages:: +* About SLIB:: Install, etc. +* Index:: + + +File: slib.info, Node: The Library System, Next: Scheme Syntax Extension Packages, Prev: Top, Up: Top + +The Library System +****************** + +* Menu: + +* Feature:: SLIB names. +* Requesting Features:: +* Library Catalogs:: +* Catalog Compilation:: +* Built-in Support:: +* About this manual:: + + +File: slib.info, Node: Feature, Next: Requesting Features, Prev: The Library System, Up: The Library System + +Feature +======= + +SLIB denotes "features" by symbols. SLIB maintains a list of features +supported by the Scheme "session". The set of features provided by a +session may change over time. Some features are properties of the +Scheme implementation being used. The following features detail what +sort of numbers are available from an implementation. + + * 'inexact + + * 'rational + + * 'real + + * 'complex + + * 'bignum + +Other features correspond to the presence of sets of Scheme procedures +or syntax (macros). + + - Function: provided? FEATURE + Returns `#t' if FEATURE is supported by the current Scheme session. + + - Procedure: provide FEATURE + Informs SLIB that FEATURE is supported. Henceforth `(provided? + FEATURE)' will return `#t'. + + (provided? 'foo) => #f + (provide 'foo) + (provided? 'foo) => #t + + +File: slib.info, Node: Requesting Features, Next: Library Catalogs, Prev: Feature, Up: The Library System + +Requesting Features +=================== + +SLIB creates and maintains a "catalog" mapping features to locations of +files introducing procedures and syntax denoted by those features. + +At the beginning of each section of this manual, there is a line like +`(require 'FEATURE)'. The Scheme files comprising SLIB are cataloged +so that these feature names map to the corresponding files. + +SLIB provides a form, `require', which loads the files providing the +requested feature. + + - Procedure: require FEATURE + * If `(provided? FEATURE)' is true, then `require' just returns + an unspecified value. + + * Otherwise, if FEATURE is found in the catalog, then the + corresponding files will be loaded and an unspecified value + returned. + + Subsequently `(provided? FEATURE)' will return `#t'. + + * Otherwise (FEATURE not found in the catalog), an error is + signaled. + +The catalog can also be queried using `require:feature->path'. + + - Function: require:feature->path FEATURE + * If FEATURE is already provided, then returns `#t'. + + * Otherwise, if FEATURE is in the catalog, the path or list of + paths associated with FEATURE is returned. + + * Otherwise, returns `#f'. + + +File: slib.info, Node: Library Catalogs, Next: Catalog Compilation, Prev: Requesting Features, Up: The Library System + +Library Catalogs +================ + +At the start of a session no catalog is present, but is created with the +first catalog inquiry (such as `(require 'random)'). Several sources +of catalog information are combined to produce the catalog: + + * standard SLIB packages. + + * additional packages of interest to this site. + + * packages specifically for the variety of Scheme which this session + is running. + + * packages this user wants to always have available. This catalog + is the file `homecat' in the user's "HOME" directory. + + * packages germane to working in this (current working) directory. + This catalog is the file `usercat' in the directory to which it + applies. One would typically `cd' to this directory before + starting the Scheme session. + +Catalog files consist of one or more "association list"s. In the +circumstance where a feature symbol appears in more than one list, the +latter list's association is retrieved. Here are the supported formats +for elements of catalog lists: + +`(FEATURE . <symbol>)' + Redirects to the feature named <symbol>. + +`(FEATURE . "<path>")' + Loads file <path>. + +`(FEATURE source "<path>")' + `slib:load's the Scheme source file <path>. + +`(FEATURE compiled "<path>" ...)' + `slib:load-compiled's the files <path> .... + +The various macro styles first `require' the named macro package, then +just load <path> or load-and-macro-expand <path> as appropriate for the +implementation. + +`(FEATURE defmacro "<path>")' + `defmacro:load's the Scheme source file <path>. + +`(FEATURE macro-by-example "<path>")' + `defmacro:load's the Scheme source file <path>. + +`(FEATURE macro "<path>")' + `macro:load's the Scheme source file <path>. + +`(FEATURE macros-that-work "<path>")' + `macro:load's the Scheme source file <path>. + +`(FEATURE syntax-case "<path>")' + `macro:load's the Scheme source file <path>. + +`(FEATURE syntactic-closures "<path>")' + `macro:load's the Scheme source file <path>. + +Here is an example of a `usercat' catalog. A Program in this directory +can invoke the `run' feature with `(require 'run)'. + + ;;; "usercat": SLIB catalog additions for SIMSYNCH. -*-scheme-*- + + ( + (simsynch . "../synch/simsynch.scm") + (run . "../synch/run.scm") + (schlep . "schlep.scm") + ) + + +File: slib.info, Node: Catalog Compilation, Next: Built-in Support, Prev: Library Catalogs, Up: The Library System + +Catalog Compilation +=================== + +SLIB combines the catalog information which doesn't vary per user into +the file `slibcat' in the implementation-vicinity. Therefore `slibcat' +needs change only when new software is installed or compiled. Because +the actual pathnames of files can differ from installation to +installation, SLIB builds a separate catalog for each implementation it +is used with. + +The definition of `*SLIB-VERSION*' in SLIB file `require.scm' is +checked against the catalog association of `*SLIB-VERSION*' to +ascertain when versions have changed. I recommend that the definition +of `*SLIB-VERSION*' be changed whenever the library is changed. If +multiple implementations of Scheme use SLIB, remember that recompiling +one `slibcat' will fix only that implementation's catalog. + +The compilation scripts of Scheme implementations which work with SLIB +can automatically trigger catalog compilation by deleting `slibcat' or +by invoking a special form of `require': + + - Procedure: require 'new-catalog + This will load `mklibcat', which compiles and writes a new + `slibcat'. + +Another special form of `require' erases SLIB's catalog, forcing it to +be reloaded the next time the catalog is queried. + + - Procedure: require #f + Removes SLIB's catalog information. This should be done before + saving an executable image so that, when restored, its catalog + will be loaded afresh. + +Each file in the table below is descibed in terms of its file-system +independent "vicinity" (*note Vicinity::.). The entries of a catalog +in the table override those of catalogs above it in the table. + +`implementation-vicinity' `slibcat' + This file contains the associations for the packages comprising + SLIB, the `implcat' and the `sitecat's. The associations in the + other catalogs override those of the standard catalog. + +`library-vicinity' `mklibcat.scm' + creates `slibcat'. + +`library-vicinity' `sitecat' + This file contains the associations specific to an SLIB + installation. + +`implementation-vicinity' `implcat' + This file contains the associations specific to an implementation + of Scheme. Different implementations of Scheme should have + different `implementation-vicinity'. + +`implementation-vicinity' `mkimpcat.scm' + if present, creates `implcat'. + +`implementation-vicinity' `sitecat' + This file contains the associations specific to a Scheme + implementation installation. + +`home-vicinity' `homecat' + This file contains the associations specific to an SLIB user. + +`user-vicinity' `usercat' + This file contains associations effecting only those sessions whose + "working directory" is `user-vicinity'. + + +File: slib.info, Node: Built-in Support, Next: About this manual, Prev: Catalog Compilation, Up: The Library System + +Built-in Support +================ + +The procedures described in these sections are supported by all +implementations as part of the `*.init' files or by `require.scm'. + +* Menu: + +* Require:: Module Management +* Vicinity:: Pathname Management +* Configuration:: Characteristics of Scheme Implementation +* Input/Output:: Things not provided by the Scheme specs. +* Legacy:: +* System:: LOADing, EVALing, ERRORing, and EXITing + + +File: slib.info, Node: Require, Next: Vicinity, Prev: Built-in Support, Up: Built-in Support + +Require +------- + + - Variable: *features* + Is a list of symbols denoting features supported in this + implementation. *FEATURES* can grow as modules are `require'd. + *FEATURES* must be defined by all implementations (*note + Porting::.). + + Here are features which SLIB (`require.scm') adds to *FEATURES* + when appropriate. + + * 'inexact + + * 'rational + + * 'real + + * 'complex + + * 'bignum + + For each item, `(provided? 'FEATURE)' will return `#t' if that + feature is available, and `#f' if not. + + - Variable: *modules* + Is a list of pathnames denoting files which have been loaded. + + - Variable: *catalog* + Is an association list of features (symbols) and pathnames which + will supply those features. The pathname can be either a string + or a pair. If pathname is a pair then the first element should be + a macro feature symbol, `source', or `compiled'. The cdr of the + pathname should be either a string or a list. + +In the following functions if the argument FEATURE is not a symbol it +is assumed to be a pathname. + + - Function: provided? FEATURE + Returns `#t' if FEATURE is a member of `*features*' or `*modules*' + or if FEATURE is supported by a file already loaded and `#f' + otherwise. + + - Procedure: require FEATURE + FEATURE is a symbol. If `(provided? FEATURE)' is true `require' + returns. Otherwise, if `(assq FEATURE *catalog*)' is not `#f', + the associated files will be loaded and `(provided? FEATURE)' will + henceforth return `#t'. An unspecified value is returned. If + FEATURE is not found in `*catalog*', then an error is signaled. + + - Procedure: require PATHNAME + PATHNAME is a string. If PATHNAME has not already been given as + an argument to `require', PATHNAME is loaded. An unspecified + value is returned. + + - Procedure: provide FEATURE + Assures that FEATURE is contained in `*features*' if FEATURE is a + symbol and `*modules*' otherwise. + + - Function: require:feature->path FEATURE + Returns `#t' if FEATURE is a member of `*features*' or `*modules*' + or if FEATURE is supported by a file already loaded. Returns a + path if one was found in `*catalog*' under the feature name, and + `#f' otherwise. The path can either be a string suitable as an + argument to load or a pair as described above for *catalog*. + + +File: slib.info, Node: Vicinity, Next: Configuration, Prev: Require, Up: Built-in Support + +Vicinity +-------- + +A vicinity is a descriptor for a place in the file system. Vicinities +hide from the programmer the concepts of host, volume, directory, and +version. Vicinities express only the concept of a file environment +where a file name can be resolved to a file in a system independent +manner. Vicinities can even be used on "flat" file systems (which have +no directory structure) by having the vicinity express constraints on +the file name. On most systems a vicinity would be a string. All of +these procedures are file system dependent. + +These procedures are provided by all implementations. + + - Function: make-vicinity PATH + Returns the vicinity of PATH for use by `in-vicinity'. + + - Function: program-vicinity + Returns the vicinity of the currently loading Scheme code. For an + interpreter this would be the directory containing source code. + For a compiled system (with multiple files) this would be the + directory where the object or executable files are. If no file is + currently loading it the result is undefined. *Warning:* + `program-vicinity' can return incorrect values if your program + escapes back into a `load'. + + - Function: library-vicinity + Returns the vicinity of the shared Scheme library. + + - Function: implementation-vicinity + Returns the vicinity of the underlying Scheme implementation. This + vicinity will likely contain startup code and messages and a + compiler. + + - Function: user-vicinity + Returns the vicinity of the current directory of the user. On most + systems this is `""' (the empty string). + + - Function: home-vicinity + Returns the vicinity of the user's "HOME" directory, the directory + which typically contains files which customize a computer + environment for a user. If scheme is running without a user (eg. + a daemon) or if this concept is meaningless for the platform, then + `home-vicinity' returns `#f'. + + - Function: in-vicinity VICINITY FILENAME + Returns a filename suitable for use by `slib:load', + `slib:load-source', `slib:load-compiled', `open-input-file', + `open-output-file', etc. The returned filename is FILENAME in + VICINITY. `in-vicinity' should allow FILENAME to override + VICINITY when FILENAME is an absolute pathname and VICINITY is + equal to the value of `(user-vicinity)'. The behavior of + `in-vicinity' when FILENAME is absolute and VICINITY is not equal + to the value of `(user-vicinity)' is unspecified. For most systems + `in-vicinity' can be `string-append'. + + - Function: sub-vicinity VICINITY NAME + Returns the vicinity of VICINITY restricted to NAME. This is used + for large systems where names of files in subsystems could + conflict. On systems with directory structure `sub-vicinity' will + return a pathname of the subdirectory NAME of VICINITY. + + +File: slib.info, Node: Configuration, Next: Input/Output, Prev: Vicinity, Up: Built-in Support + +Configuration +------------- + +These constants and procedures describe characteristics of the Scheme +and underlying operating system. They are provided by all +implementations. + + - Constant: char-code-limit + An integer 1 larger that the largest value which can be returned by + `char->integer'. + + - Constant: most-positive-fixnum + In implementations which support integers of practically unlimited + size, MOST-POSITIVE-FIXNUM is a large exact integer within the + range of exact integers that may result from computing the length + of a list, vector, or string. + + In implementations which do not support integers of practically + unlimited size, MOST-POSITIVE-FIXNUM is the largest exact integer + that may result from computing the length of a list, vector, or + string. + + - Constant: slib:tab + The tab character. + + - Constant: slib:form-feed + The form-feed character. + + - Function: software-type + Returns a symbol denoting the generic operating system type. For + instance, `unix', `vms', `macos', `amiga', or `ms-dos'. + + - Function: slib:report-version + Displays the versions of SLIB and the underlying Scheme + implementation and the name of the operating system. An + unspecified value is returned. + + (slib:report-version) => slib "2c7" on scm "5b1" on unix | + + - Function: slib:report + Displays the information of `(slib:report-version)' followed by + almost all the information neccessary for submitting a problem + report. An unspecified value is returned. + + - Function: slib:report #T + provides a more verbose listing. + + - Function: slib:report FILENAME + Writes the report to file `filename'. + + (slib:report) + => + slib "2c7" on scm "5b1" on unix | + (implementation-vicinity) is "/home/jaffer/scm/" + (library-vicinity) is "/home/jaffer/slib/" + (scheme-file-suffix) is ".scm" + loaded *features* : + trace alist qp sort + common-list-functions macro values getopt + compiled + implementation *features* : + bignum complex real rational + inexact vicinity ed getenv + tmpnam abort transcript with-file + ieee-p1178 rev4-report rev4-optional-procedures hash + object-hash delay eval dynamic-wind + multiarg-apply multiarg/and- logical defmacro + string-port source current-time record + rev3-procedures rev2-procedures sun-dl string-case + array dump char-ready? full-continuation + system + implementation *catalog* : + (i/o-extensions compiled "/home/jaffer/scm/ioext.so") + ... + + +File: slib.info, Node: Input/Output, Next: Legacy, Prev: Configuration, Up: Built-in Support + +Input/Output +------------ + +These procedures are provided by all implementations. + + - Procedure: file-exists? FILENAME + Returns `#t' if the specified file exists. Otherwise, returns + `#f'. If the underlying implementation does not support this + feature then `#f' is always returned. + + - Procedure: delete-file FILENAME + Deletes the file specified by FILENAME. If FILENAME can not be + deleted, `#f' is returned. Otherwise, `#t' is returned. + + - Procedure: tmpnam + Returns a pathname for a file which will likely not be used by any + other process. Successive calls to `(tmpnam)' will return + different pathnames. + + - Procedure: current-error-port + Returns the current port to which diagnostic and error output is + directed. + + - Procedure: force-output + - Procedure: force-output PORT + Forces any pending output on PORT to be delivered to the output + device and returns an unspecified value. The PORT argument may be + omitted, in which case it defaults to the value returned by + `(current-output-port)'. + + - Procedure: output-port-width + - Procedure: output-port-width PORT + Returns the width of PORT, which defaults to + `(current-output-port)' if absent. If the width cannot be + determined 79 is returned. + + - Procedure: output-port-height + - Procedure: output-port-height PORT + Returns the height of PORT, which defaults to + `(current-output-port)' if absent. If the height cannot be + determined 24 is returned. + + +File: slib.info, Node: Legacy, Next: System, Prev: Input/Output, Up: Built-in Support + +Legacy +------ + + These procedures are provided by all implementations. + + - Function: identity X + IDENTITY returns its argument. + + Example: + (identity 3) + => 3 + (identity '(foo bar)) + => (foo bar) + (map identity LST) + == (copy-list LST) + +The following procedures were present in Scheme until R4RS (*note +Language changes: (r4rs)Notes.). They are provided by all SLIB +implementations. + + - Constant: t + Derfined as `#t'. + + - Constant: nil + Defined as `#f'. + + - Function: last-pair L + Returns the last pair in the list L. Example: + (last-pair (cons 1 2)) + => (1 . 2) + (last-pair '(1 2)) + => (2) + == (cons 2 '()) + + +File: slib.info, Node: System, Prev: Legacy, Up: Built-in Support + +System +------ + +These procedures are provided by all implementations. + + - Procedure: slib:load-source NAME + Loads a file of Scheme source code from NAME with the default + filename extension used in SLIB. For instance if the filename + extension used in SLIB is `.scm' then `(slib:load-source "foo")' + will load from file `foo.scm'. + + - Procedure: slib:load-compiled NAME + On implementations which support separtely loadable compiled + modules, loads a file of compiled code from NAME with the + implementation's filename extension for compiled code appended. + + - Procedure: slib:load NAME + Loads a file of Scheme source or compiled code from NAME with the + appropriate suffixes appended. If both source and compiled code + are present with the appropriate names then the implementation + will load just one. It is up to the implementation to choose + which one will be loaded. + + If an implementation does not support compiled code then + `slib:load' will be identical to `slib:load-source'. + + - Procedure: slib:eval OBJ + `eval' returns the value of OBJ evaluated in the current top level + environment. *Note Eval:: provides a more general evaluation + facility. + + - Procedure: slib:eval-load FILENAME EVAL + FILENAME should be a string. If filename names an existing file, + the Scheme source code expressions and definitions are read from + the file and EVAL called with them sequentially. The + `slib:eval-load' procedure does not affect the values returned by + `current-input-port' and `current-output-port'. + + - Procedure: slib:warn ARG1 ARG2 ... + Outputs a warning message containing the arguments. + + - Procedure: slib:error ARG1 ARG2 ... + Outputs an error message containing the arguments, aborts + evaluation of the current form and responds in a system dependent + way to the error. Typical responses are to abort the program or + to enter a read-eval-print loop. + + - Procedure: slib:exit N + - Procedure: slib:exit + Exits from the Scheme session returning status N to the system. + If N is omitted or `#t', a success status is returned to the + system (if possible). If N is `#f' a failure is returned to the + system (if possible). If N is an integer, then N is returned to + the system (if possible). If the Scheme session cannot exit an + unspecified value is returned from `slib:exit'. + + +File: slib.info, Node: About this manual, Prev: Built-in Support, Up: The Library System + +About this manual +================= + + * Entries that are labeled as Functions are called for their return + values. Entries that are labeled as Procedures are called + primarily for their side effects. + + * Examples in this text were produced using the `scm' Scheme + implementation. + + * At the beginning of each section, there is a line that looks like + `(require 'feature)'. Include this line in your code prior to + using the package. + + +File: slib.info, Node: Scheme Syntax Extension Packages, Next: Textual Conversion Packages, Prev: The Library System, Up: Top + +Scheme Syntax Extension Packages +******************************** + +* Menu: + +* Defmacro:: Supported by all implementations + +* R4RS Macros:: 'macro +* Macro by Example:: 'macro-by-example +* Macros That Work:: 'macros-that-work +* Syntactic Closures:: 'syntactic-closures +* Syntax-Case Macros:: 'syntax-case + +Syntax extensions (macros) included with SLIB. Also *Note Structures::. + +* Fluid-Let:: 'fluid-let +* Yasos:: 'yasos, 'oop, 'collect + + +File: slib.info, Node: Defmacro, Next: R4RS Macros, Prev: Scheme Syntax Extension Packages, Up: Scheme Syntax Extension Packages + +Defmacro +======== + + Defmacros are supported by all implementations. + + - Function: gentemp + Returns a new (interned) symbol each time it is called. The symbol + names are implementation-dependent + (gentemp) => scm:G0 + (gentemp) => scm:G1 + + - Function: defmacro:eval E + Returns the `slib:eval' of expanding all defmacros in scheme + expression E. + + - Function: defmacro:load FILENAME + FILENAME should be a string. If filename names an existing file, + the `defmacro:load' procedure reads Scheme source code expressions + and definitions from the file and evaluates them sequentially. + These source code expressions and definitions may contain defmacro + definitions. The `macro:load' procedure does not affect the values + returned by `current-input-port' and `current-output-port'. + + - Function: defmacro? SYM + Returns `#t' if SYM has been defined by `defmacro', `#f' otherwise. + + - Function: macroexpand-1 FORM + - Function: macroexpand FORM + If FORM is a macro call, `macroexpand-1' will expand the macro + call once and return it. A FORM is considered to be a macro call + only if it is a cons whose `car' is a symbol for which a `defmacr' + has been defined. + + `macroexpand' is similar to `macroexpand-1', but repeatedly + expands FORM until it is no longer a macro call. + + - Macro: defmacro NAME LAMBDA-LIST FORM ... + When encountered by `defmacro:eval', `defmacro:macroexpand*', or + `defmacro:load' defines a new macro which will henceforth be + expanded when encountered by `defmacro:eval', + `defmacro:macroexpand*', or `defmacro:load'. + +Defmacroexpand +-------------- + + `(require 'defmacroexpand)' + + - Function: defmacro:expand* E + Returns the result of expanding all defmacros in scheme expression + E. + + +File: slib.info, Node: R4RS Macros, Next: Macro by Example, Prev: Defmacro, Up: Scheme Syntax Extension Packages + +R4RS Macros +=========== + + `(require 'macro)' is the appropriate call if you want R4RS +high-level macros but don't care about the low level implementation. If +an SLIB R4RS macro implementation is already loaded it will be used. +Otherwise, one of the R4RS macros implemetations is loaded. + + The SLIB R4RS macro implementations support the following uniform +interface: + + - Function: macro:expand SEXPRESSION + Takes an R4RS expression, macro-expands it, and returns the result + of the macro expansion. + + - Function: macro:eval SEXPRESSION + Takes an R4RS expression, macro-expands it, evals the result of the + macro expansion, and returns the result of the evaluation. + + - Procedure: macro:load FILENAME + FILENAME should be a string. If filename names an existing file, + the `macro:load' procedure reads Scheme source code expressions and + definitions from the file and evaluates them sequentially. These + source code expressions and definitions may contain macro + definitions. The `macro:load' procedure does not affect the + values returned by `current-input-port' and `current-output-port'. + + +File: slib.info, Node: Macro by Example, Next: Macros That Work, Prev: R4RS Macros, Up: Scheme Syntax Extension Packages + +Macro by Example +================ + + `(require 'macro-by-example)' + + A vanilla implementation of `Macro by Example' (Eugene Kohlbecker, +R4RS) by Dorai Sitaram, (dorai@cs.rice.edu) using `defmacro'. + + * generating hygienic global `define-syntax' Macro-by-Example macros + *cheaply*. + + * can define macros which use `...'. + + * needn't worry about a lexical variable in a macro definition + clashing with a variable from the macro use context + + * don't suffer the overhead of redefining the repl if `defmacro' + natively supported (most implementations) + +Caveat +------ + + These macros are not referentially transparent (*note Macros: +(r4rs)Macros.). Lexically scoped macros (i.e., `let-syntax' and +`letrec-syntax') are not supported. In any case, the problem of +referential transparency gains poignancy only when `let-syntax' and +`letrec-syntax' are used. So you will not be courting large-scale +disaster unless you're using system-function names as local variables +with unintuitive bindings that the macro can't use. However, if you +must have the full `r4rs' macro functionality, look to the more +featureful (but also more expensive) versions of syntax-rules available +in slib *Note Macros That Work::, *Note Syntactic Closures::, and *Note +Syntax-Case Macros::. + + - Macro: define-syntax KEYWORD TRANSFORMER-SPEC + The KEYWORD is an identifier, and the TRANSFORMER-SPEC should be + an instance of `syntax-rules'. + + The top-level syntactic environment is extended by binding the + KEYWORD to the specified transformer. + + (define-syntax let* + (syntax-rules () + ((let* () body1 body2 ...) + (let () body1 body2 ...)) + ((let* ((name1 val1) (name2 val2) ...) + body1 body2 ...) + (let ((name1 val1)) + (let* (( name2 val2) ...) + body1 body2 ...))))) + + - Macro: syntax-rules LITERALS SYNTAX-RULE ... + LITERALS is a list of identifiers, and each SYNTAX-RULE should be + of the form + + `(PATTERN TEMPLATE)' + + where the PATTERN and TEMPLATE are as in the grammar above. + + An instance of `syntax-rules' produces a new macro transformer by + specifying a sequence of hygienic rewrite rules. A use of a macro + whose keyword is associated with a transformer specified by + `syntax-rules' is matched against the patterns contained in the + SYNTAX-RULEs, beginning with the leftmost SYNTAX-RULE. When a + match is found, the macro use is trancribed hygienically according + to the template. + + Each pattern begins with the keyword for the macro. This keyword + is not involved in the matching and is not considered a pattern + variable or literal identifier. + + +File: slib.info, Node: Macros That Work, Next: Syntactic Closures, Prev: Macro by Example, Up: Scheme Syntax Extension Packages + +Macros That Work +================ + + `(require 'macros-that-work)' + + `Macros That Work' differs from the other R4RS macro implementations +in that it does not expand derived expression types to primitive +expression types. + + - Function: macro:expand EXPRESSION + - Function: macwork:expand EXPRESSION + Takes an R4RS expression, macro-expands it, and returns the result + of the macro expansion. + + - Function: macro:eval EXPRESSION + - Function: macwork:eval EXPRESSION + `macro:eval' returns the value of EXPRESSION in the current top + level environment. EXPRESSION can contain macro definitions. + Side effects of EXPRESSION will affect the top level environment. + + - Procedure: macro:load FILENAME + - Procedure: macwork:load FILENAME + FILENAME should be a string. If filename names an existing file, + the `macro:load' procedure reads Scheme source code expressions and + definitions from the file and evaluates them sequentially. These + source code expressions and definitions may contain macro + definitions. The `macro:load' procedure does not affect the + values returned by `current-input-port' and `current-output-port'. + + References: + + The `Revised^4 Report on the Algorithmic Language Scheme' Clinger and +Rees [editors]. To appear in LISP Pointers. Also available as a +technical report from the University of Oregon, MIT AI Lab, and Cornell. + + Macros That Work. Clinger and Rees. POPL '91. + + The supported syntax differs from the R4RS in that vectors are allowed +as patterns and as templates and are not allowed as pattern or template +data. + + transformer spec ==> (syntax-rules literals rules) + + rules ==> () + | (rule . rules) + + rule ==> (pattern template) + + pattern ==> pattern_var ; a symbol not in literals + | symbol ; a symbol in literals + | () + | (pattern . pattern) + | (ellipsis_pattern) + | #(pattern*) ; extends R4RS + | #(pattern* ellipsis_pattern) ; extends R4RS + | pattern_datum + + template ==> pattern_var + | symbol + | () + | (template2 . template2) + | #(template*) ; extends R4RS + | pattern_datum + + template2 ==> template + | ellipsis_template + + pattern_datum ==> string ; no vector + | character + | boolean + | number + + ellipsis_pattern ==> pattern ... + + ellipsis_template ==> template ... + + pattern_var ==> symbol ; not in literals + + literals ==> () + | (symbol . literals) + +Definitions +----------- + +Scope of an ellipsis + Within a pattern or template, the scope of an ellipsis (`...') is + the pattern or template that appears to its left. + +Rank of a pattern variable + The rank of a pattern variable is the number of ellipses within + whose scope it appears in the pattern. + +Rank of a subtemplate + The rank of a subtemplate is the number of ellipses within whose + scope it appears in the template. + +Template rank of an occurrence of a pattern variable + The template rank of an occurrence of a pattern variable within a + template is the rank of that occurrence, viewed as a subtemplate. + +Variables bound by a pattern + The variables bound by a pattern are the pattern variables that + appear within it. + +Referenced variables of a subtemplate + The referenced variables of a subtemplate are the pattern + variables that appear within it. + +Variables opened by an ellipsis template + The variables opened by an ellipsis template are the referenced + pattern variables whose rank is greater than the rank of the + ellipsis template. + +Restrictions +------------ + + No pattern variable appears more than once within a pattern. + + For every occurrence of a pattern variable within a template, the +template rank of the occurrence must be greater than or equal to the +pattern variable's rank. + + Every ellipsis template must open at least one variable. + + For every ellipsis template, the variables opened by an ellipsis +template must all be bound to sequences of the same length. + + The compiled form of a RULE is + + rule ==> (pattern template inserted) + + pattern ==> pattern_var + | symbol + | () + | (pattern . pattern) + | ellipsis_pattern + | #(pattern) + | pattern_datum + + template ==> pattern_var + | symbol + | () + | (template2 . template2) + | #(pattern) + | pattern_datum + + template2 ==> template + | ellipsis_template + + pattern_datum ==> string + | character + | boolean + | number + + pattern_var ==> #(V symbol rank) + + ellipsis_pattern ==> #(E pattern pattern_vars) + + ellipsis_template ==> #(E template pattern_vars) + + inserted ==> () + | (symbol . inserted) + + pattern_vars ==> () + | (pattern_var . pattern_vars) + + rank ==> exact non-negative integer + + where V and E are unforgeable values. + + The pattern variables associated with an ellipsis pattern are the +variables bound by the pattern, and the pattern variables associated +with an ellipsis template are the variables opened by the ellipsis +template. + + If the template contains a big chunk that contains no pattern +variables or inserted identifiers, then the big chunk will be copied +unnecessarily. That shouldn't matter very often. + + +File: slib.info, Node: Syntactic Closures, Next: Syntax-Case Macros, Prev: Macros That Work, Up: Scheme Syntax Extension Packages + +Syntactic Closures +================== + + `(require 'syntactic-closures)' + + - Function: macro:expand EXPRESSION + - Function: synclo:expand EXPRESSION + Returns scheme code with the macros and derived expression types of + EXPRESSION expanded to primitive expression types. + + - Function: macro:eval EXPRESSION + - Function: synclo:eval EXPRESSION + `macro:eval' returns the value of EXPRESSION in the current top + level environment. EXPRESSION can contain macro definitions. + Side effects of EXPRESSION will affect the top level environment. + + - Procedure: macro:load FILENAME + - Procedure: synclo:load FILENAME + FILENAME should be a string. If filename names an existing file, + the `macro:load' procedure reads Scheme source code expressions and + definitions from the file and evaluates them sequentially. These + source code expressions and definitions may contain macro + definitions. The `macro:load' procedure does not affect the + values returned by `current-input-port' and `current-output-port'. + +Syntactic Closure Macro Facility +-------------------------------- + + A Syntactic Closures Macro Facility + + by Chris Hanson + + 9 November 1991 + + This document describes "syntactic closures", a low-level macro +facility for the Scheme programming language. The facility is an +alternative to the low-level macro facility described in the `Revised^4 +Report on Scheme.' This document is an addendum to that report. + + The syntactic closures facility extends the BNF rule for TRANSFORMER +SPEC to allow a new keyword that introduces a low-level macro +transformer: + TRANSFORMER SPEC := (transformer EXPRESSION) + + Additionally, the following procedures are added: + make-syntactic-closure + capture-syntactic-environment + identifier? + identifier=? + + The description of the facility is divided into three parts. The +first part defines basic terminology. The second part describes how +macro transformers are defined. The third part describes the use of +"identifiers", which extend the syntactic closure mechanism to be +compatible with `syntax-rules'. + +Terminology +........... + + This section defines the concepts and data types used by the syntactic +closures facility. + + * "Forms" are the syntactic entities out of which programs are + recursively constructed. A form is any expression, any + definition, any syntactic keyword, or any syntactic closure. The + variable name that appears in a `set!' special form is also a + form. Examples of forms: + 17 + #t + car + (+ x 4) + (lambda (x) x) + (define pi 3.14159) + if + define + + * An "alias" is an alternate name for a given symbol. It can appear + anywhere in a form that the symbol could be used, and when quoted + it is replaced by the symbol; however, it does not satisfy the + predicate `symbol?'. Macro transformers rarely distinguish + symbols from aliases, referring to both as identifiers. + + * A "syntactic" environment maps identifiers to their meanings. + More precisely, it determines whether an identifier is a syntactic + keyword or a variable. If it is a keyword, the meaning is an + interpretation for the form in which that keyword appears. If it + is a variable, the meaning identifies which binding of that + variable is referenced. In short, syntactic environments contain + all of the contextual information necessary for interpreting the + meaning of a particular form. + + * A "syntactic closure" consists of a form, a syntactic environment, + and a list of identifiers. All identifiers in the form take their + meaning from the syntactic environment, except those in the given + list. The identifiers in the list are to have their meanings + determined later. A syntactic closure may be used in any context + in which its form could have been used. Since a syntactic closure + is also a form, it may not be used in contexts where a form would + be illegal. For example, a form may not appear as a clause in the + cond special form. A syntactic closure appearing in a quoted + structure is replaced by its form. + +Transformer Definition +...................... + + This section describes the `transformer' special form and the +procedures `make-syntactic-closure' and `capture-syntactic-environment'. + + - Syntax: transformer EXPRESSION + Syntax: It is an error if this syntax occurs except as a + TRANSFORMER SPEC. + + Semantics: The EXPRESSION is evaluated in the standard transformer + environment to yield a macro transformer as described below. This + macro transformer is bound to a macro keyword by the special form + in which the `transformer' expression appears (for example, + `let-syntax'). + + A "macro transformer" is a procedure that takes two arguments, a + form and a syntactic environment, and returns a new form. The + first argument, the "input form", is the form in which the macro + keyword occurred. The second argument, the "usage environment", + is the syntactic environment in which the input form occurred. + The result of the transformer, the "output form", is automatically + closed in the "transformer environment", which is the syntactic + environment in which the `transformer' expression occurred. + + For example, here is a definition of a push macro using + `syntax-rules': + (define-syntax push + (syntax-rules () + ((push item list) + (set! list (cons item list))))) + + Here is an equivalent definition using `transformer': + (define-syntax push + (transformer + (lambda (exp env) + (let ((item + (make-syntactic-closure env '() (cadr exp))) + (list + (make-syntactic-closure env '() (caddr exp)))) + `(set! ,list (cons ,item ,list)))))) + + In this example, the identifiers `set!' and `cons' are closed in + the transformer environment, and thus will not be affected by the + meanings of those identifiers in the usage environment `env'. + + Some macros may be non-hygienic by design. For example, the + following defines a loop macro that implicitly binds `exit' to an + escape procedure. The binding of `exit' is intended to capture + free references to `exit' in the body of the loop, so `exit' must + be left free when the body is closed: + (define-syntax loop + (transformer + (lambda (exp env) + (let ((body (cdr exp))) + `(call-with-current-continuation + (lambda (exit) + (let f () + ,@(map (lambda (exp) + (make-syntactic-closure env '(exit) + exp)) + body) + (f)))))))) + + To assign meanings to the identifiers in a form, use + `make-syntactic-closure' to close the form in a syntactic + environment. + + - Function: make-syntactic-closure ENVIRONMENT FREE-NAMES FORM + ENVIRONMENT must be a syntactic environment, FREE-NAMES must be a + list of identifiers, and FORM must be a form. + `make-syntactic-closure' constructs and returns a syntactic closure + of FORM in ENVIRONMENT, which can be used anywhere that FORM could + have been used. All the identifiers used in FORM, except those + explicitly excepted by FREE-NAMES, obtain their meanings from + ENVIRONMENT. + + Here is an example where FREE-NAMES is something other than the + empty list. It is instructive to compare the use of FREE-NAMES in + this example with its use in the `loop' example above: the examples + are similar except for the source of the identifier being left + free. + (define-syntax let1 + (transformer + (lambda (exp env) + (let ((id (cadr exp)) + (init (caddr exp)) + (exp (cadddr exp))) + `((lambda (,id) + ,(make-syntactic-closure env (list id) exp)) + ,(make-syntactic-closure env '() init)))))) + + `let1' is a simplified version of `let' that only binds a single + identifier, and whose body consists of a single expression. When + the body expression is syntactically closed in its original + syntactic environment, the identifier that is to be bound by + `let1' must be left free, so that it can be properly captured by + the `lambda' in the output form. + + To obtain a syntactic environment other than the usage + environment, use `capture-syntactic-environment'. + + - Function: capture-syntactic-environment PROCEDURE + `capture-syntactic-environment' returns a form that will, when + transformed, call PROCEDURE on the current syntactic environment. + PROCEDURE should compute and return a new form to be transformed, + in that same syntactic environment, in place of the form. + + An example will make this clear. Suppose we wanted to define a + simple `loop-until' keyword equivalent to + (define-syntax loop-until + (syntax-rules () + ((loop-until id init test return step) + (letrec ((loop + (lambda (id) + (if test return (loop step))))) + (loop init))))) + + The following attempt at defining `loop-until' has a subtle bug: + (define-syntax loop-until + (transformer + (lambda (exp env) + (let ((id (cadr exp)) + (init (caddr exp)) + (test (cadddr exp)) + (return (cadddr (cdr exp))) + (step (cadddr (cddr exp))) + (close + (lambda (exp free) + (make-syntactic-closure env free exp)))) + `(letrec ((loop + (lambda (,id) + (if ,(close test (list id)) + ,(close return (list id)) + (loop ,(close step (list id))))))) + (loop ,(close init '()))))))) + + This definition appears to take all of the proper precautions to + prevent unintended captures. It carefully closes the + subexpressions in their original syntactic environment and it + leaves the `id' identifier free in the `test', `return', and + `step' expressions, so that it will be captured by the binding + introduced by the `lambda' expression. Unfortunately it uses the + identifiers `if' and `loop' within that `lambda' expression, so if + the user of `loop-until' just happens to use, say, `if' for the + identifier, it will be inadvertently captured. + + The syntactic environment that `if' and `loop' want to be exposed + to is the one just outside the `lambda' expression: before the + user's identifier is added to the syntactic environment, but after + the identifier loop has been added. + `capture-syntactic-environment' captures exactly that environment + as follows: + (define-syntax loop-until + (transformer + (lambda (exp env) + (let ((id (cadr exp)) + (init (caddr exp)) + (test (cadddr exp)) + (return (cadddr (cdr exp))) + (step (cadddr (cddr exp))) + (close + (lambda (exp free) + (make-syntactic-closure env free exp)))) + `(letrec ((loop + ,(capture-syntactic-environment + (lambda (env) + `(lambda (,id) + (,(make-syntactic-closure env '() `if) + ,(close test (list id)) + ,(close return (list id)) + (,(make-syntactic-closure env '() + `loop) + ,(close step (list id))))))))) + (loop ,(close init '()))))))) + + In this case, having captured the desired syntactic environment, + it is convenient to construct syntactic closures of the + identifiers `if' and the `loop' and use them in the body of the + `lambda'. + + A common use of `capture-syntactic-environment' is to get the + transformer environment of a macro transformer: + (transformer + (lambda (exp env) + (capture-syntactic-environment + (lambda (transformer-env) + ...)))) + +Identifiers +........... + + This section describes the procedures that create and manipulate +identifiers. Previous syntactic closure proposals did not have an +identifier data type - they just used symbols. The identifier data +type extends the syntactic closures facility to be compatible with the +high-level `syntax-rules' facility. + + As discussed earlier, an identifier is either a symbol or an "alias". +An alias is implemented as a syntactic closure whose "form" is an +identifier: + (make-syntactic-closure env '() 'a) + => an "alias" + + Aliases are implemented as syntactic closures because they behave just +like syntactic closures most of the time. The difference is that an +alias may be bound to a new value (for example by `lambda' or +`let-syntax'); other syntactic closures may not be used this way. If +an alias is bound, then within the scope of that binding it is looked +up in the syntactic environment just like any other identifier. + + Aliases are used in the implementation of the high-level facility +`syntax-rules'. A macro transformer created by `syntax-rules' uses a +template to generate its output form, substituting subforms of the +input form into the template. In a syntactic closures implementation, +all of the symbols in the template are replaced by aliases closed in +the transformer environment, while the output form itself is closed in +the usage environment. This guarantees that the macro transformation +is hygienic, without requiring the transformer to know the syntactic +roles of the substituted input subforms. + + - Function: identifier? OBJECT + Returns `#t' if OBJECT is an identifier, otherwise returns `#f'. + Examples: + (identifier? 'a) + => #t + (identifier? (make-syntactic-closure env '() 'a)) + => #t + (identifier? "a") + => #f + (identifier? #\a) + => #f + (identifier? 97) + => #f + (identifier? #f) + => #f + (identifier? '(a)) + => #f + (identifier? '#(a)) + => #f + + The predicate `eq?' is used to determine if two identifers are + "the same". Thus `eq?' can be used to compare identifiers exactly + as it would be used to compare symbols. Often, though, it is + useful to know whether two identifiers "mean the same thing". For + example, the `cond' macro uses the symbol `else' to identify the + final clause in the conditional. A macro transformer for `cond' + cannot just look for the symbol `else', because the `cond' form + might be the output of another macro transformer that replaced the + symbol `else' with an alias. Instead the transformer must look + for an identifier that "means the same thing" in the usage + environment as the symbol `else' means in the transformer + environment. + + - Function: identifier=? ENVIRONMENT1 IDENTIFIER1 ENVIRONMENT2 + IDENTIFIER2 + ENVIRONMENT1 and ENVIRONMENT2 must be syntactic environments, and + IDENTIFIER1 and IDENTIFIER2 must be identifiers. `identifier=?' + returns `#t' if the meaning of IDENTIFIER1 in ENVIRONMENT1 is the + same as that of IDENTIFIER2 in ENVIRONMENT2, otherwise it returns + `#f'. Examples: + + (let-syntax + ((foo + (transformer + (lambda (form env) + (capture-syntactic-environment + (lambda (transformer-env) + (identifier=? transformer-env 'x env 'x))))))) + (list (foo) + (let ((x 3)) + (foo)))) + => (#t #f) + + (let-syntax ((bar foo)) + (let-syntax + ((foo + (transformer + (lambda (form env) + (capture-syntactic-environment + (lambda (transformer-env) + (identifier=? transformer-env 'foo + env (cadr form)))))))) + (list (foo foo) + (foobar)))) + => (#f #t) + +Acknowledgements +................ + + The syntactic closures facility was invented by Alan Bawden and +Jonathan Rees. The use of aliases to implement `syntax-rules' was +invented by Alan Bawden (who prefers to call them "synthetic names"). +Much of this proposal is derived from an earlier proposal by Alan +Bawden. + + +File: slib.info, Node: Syntax-Case Macros, Next: Fluid-Let, Prev: Syntactic Closures, Up: Scheme Syntax Extension Packages + +Syntax-Case Macros +================== + + `(require 'syntax-case)' + + - Function: macro:expand EXPRESSION + - Function: syncase:expand EXPRESSION + Returns scheme code with the macros and derived expression types of + EXPRESSION expanded to primitive expression types. + + - Function: macro:eval EXPRESSION + - Function: syncase:eval EXPRESSION + `macro:eval' returns the value of EXPRESSION in the current top + level environment. EXPRESSION can contain macro definitions. + Side effects of EXPRESSION will affect the top level environment. + + - Procedure: macro:load FILENAME + - Procedure: syncase:load FILENAME + FILENAME should be a string. If filename names an existing file, + the `macro:load' procedure reads Scheme source code expressions and + definitions from the file and evaluates them sequentially. These + source code expressions and definitions may contain macro + definitions. The `macro:load' procedure does not affect the + values returned by `current-input-port' and `current-output-port'. + + This is version 2.1 of `syntax-case', the low-level macro facility +proposed and implemented by Robert Hieb and R. Kent Dybvig. + + This version is further adapted by Harald Hanche-Olsen +<hanche@imf.unit.no> to make it compatible with, and easily usable +with, SLIB. Mainly, these adaptations consisted of: + + * Removing white space from `expand.pp' to save space in the + distribution. This file is not meant for human readers anyway... + + * Removed a couple of Chez scheme dependencies. + + * Renamed global variables used to minimize the possibility of name + conflicts. + + * Adding an SLIB-specific initialization file. + + * Removing a couple extra files, most notably the documentation (but + see below). + + If you wish, you can see exactly what changes were done by reading the +shell script in the file `syncase.sh'. + + The two PostScript files were omitted in order to not burden the SLIB +distribution with them. If you do intend to use `syntax-case', +however, you should get these files and print them out on a PostScript +printer. They are available with the original `syntax-case' +distribution by anonymous FTP in +`cs.indiana.edu:/pub/scheme/syntax-case'. + + In order to use syntax-case from an interactive top level, execute: + (require 'syntax-case) + (require 'repl) + (repl:top-level macro:eval) + See the section Repl (*note Repl::.) for more information. + + To check operation of syntax-case get +`cs.indiana.edu:/pub/scheme/syntax-case', and type + (require 'syntax-case) + (syncase:sanity-check) + + Beware that `syntax-case' takes a long time to load - about 20s on a +SPARCstation SLC (with SCM) and about 90s on a Macintosh SE/30 (with +Gambit). + +Notes +----- + + All R4RS syntactic forms are defined, including `delay'. Along with +`delay' are simple definitions for `make-promise' (into which `delay' +expressions expand) and `force'. + + `syntax-rules' and `with-syntax' (described in `TR356') are defined. + + `syntax-case' is actually defined as a macro that expands into calls +to the procedure `syntax-dispatch' and the core form `syntax-lambda'; +do not redefine these names. + + Several other top-level bindings not documented in TR356 are created: + * the "hooks" in `hooks.ss' + + * the `build-' procedures in `output.ss' + + * `expand-syntax' (the expander) + + The syntax of define has been extended to allow `(define ID)', which +assigns ID to some unspecified value. + + We have attempted to maintain R4RS compatibility where possible. The +incompatibilities should be confined to `hooks.ss'. Please let us know +if there is some incompatibility that is not flagged as such. + + Send bug reports, comments, suggestions, and questions to Kent Dybvig +(dyb@iuvax.cs.indiana.edu). + +Note from maintainer +-------------------- + + Included with the `syntax-case' files was `structure.scm' which +defines a macro `define-structure'. There is no documentation for this +macro and it is not used by any code in SLIB. + + +File: slib.info, Node: Fluid-Let, Next: Yasos, Prev: Syntax-Case Macros, Up: Scheme Syntax Extension Packages + +Fluid-Let +========= + + `(require 'fluid-let)' + + - Syntax: fluid-let `(BINDINGS ...)' FORMS... + + (fluid-let ((VARIABLE INIT) ...) + EXPRESSION EXPRESSION ...) + + The INITs are evaluated in the current environment (in some +unspecified order), the current values of the VARIABLEs are saved, the +results are assigned to the VARIABLEs, the EXPRESSIONs are evaluated +sequentially in the current environment, the VARIABLEs are restored to +their original values, and the value of the last EXPRESSION is returned. + + The syntax of this special form is similar to that of `let', but +`fluid-let' temporarily rebinds existing VARIABLEs. Unlike `let', +`fluid-let' creates no new bindings; instead it *assigns* the values of +each INIT to the binding (determined by the rules of lexical scoping) +of its corresponding VARIABLE. + + +File: slib.info, Node: Yasos, Prev: Fluid-Let, Up: Scheme Syntax Extension Packages + +Yasos +===== + + `(require 'oop)' or `(require 'yasos)' + + `Yet Another Scheme Object System' is a simple object system for +Scheme based on the paper by Norman Adams and Jonathan Rees: `Object +Oriented Programming in Scheme', Proceedings of the 1988 ACM Conference +on LISP and Functional Programming, July 1988 [ACM #552880]. + + Another reference is: + + Ken Dickey. Scheming with Objects `AI Expert' Volume 7, Number 10 +(October 1992), pp. 24-33. + +* Menu: + +* Yasos terms:: Definitions and disclaimer. +* Yasos interface:: The Yasos macros and procedures. +* Setters:: Dylan-like setters in Yasos. +* Yasos examples:: Usage of Yasos and setters. + + +File: slib.info, Node: Yasos terms, Next: Yasos interface, Prev: Yasos, Up: Yasos + +Terms +----- + +"Object" + Any Scheme data object. + +"Instance" + An instance of the OO system; an "object". + +"Operation" + A METHOD. + +*Notes:* + The object system supports multiple inheritance. An instance can + inherit from 0 or more ancestors. In the case of multiple + inherited operations with the same identity, the operation used is + that from the first ancestor which contains it (in the ancestor + `let'). An operation may be applied to any Scheme data + object--not just instances. As code which creates instances is + just code, there are no "classes" and no meta-ANYTHING. Method + dispatch is by a procedure call a la CLOS rather than by `send' + syntax a la Smalltalk. + +*Disclaimer:* + There are a number of optimizations which can be made. This + implementation is expository (although performance should be quite + reasonable). See the L&FP paper for some suggestions. + + +File: slib.info, Node: Yasos interface, Next: Setters, Prev: Yasos terms, Up: Yasos + +Interface +--------- + + - Syntax: define-operation `('OPNAME SELF ARG ...`)' DEFAULT-BODY + Defines a default behavior for data objects which don't handle the + operation OPNAME. The default behavior (for an empty + DEFAULT-BODY) is to generate an error. + + - Syntax: define-predicate OPNAME? + Defines a predicate OPNAME?, usually used for determining the + "type" of an object, such that `(OPNAME? OBJECT)' returns `#t' if + OBJECT has an operation OPNAME? and `#f' otherwise. + + - Syntax: object `((NAME SELF ARG ...) BODY)' ... + Returns an object (an instance of the object system) with + operations. Invoking `(NAME OBJECT ARG ...' executes the BODY of + the OBJECT with SELF bound to OBJECT and with argument(s) ARG.... + + - Syntax: object-with-ancestors `(('ANCESTOR1 INIT1`)' ...`)' + OPERATION ... + A `let'-like form of `object' for multiple inheritance. It + returns an object inheriting the behaviour of ANCESTOR1 etc. An + operation will be invoked in an ancestor if the object itself does + not provide such a method. In the case of multiple inherited + operations with the same identity, the operation used is the one + found in the first ancestor in the ancestor list. + + - Syntax: operate-as COMPONENT OPERATION SELF ARG ... + Used in an operation definition (of SELF) to invoke the OPERATION + in an ancestor COMPONENT but maintain the object's identity. Also + known as "send-to-super". + + - Procedure: print OBJ PORT + A default `print' operation is provided which is just `(format + PORT OBJ)' (*note Format::.) for non-instances and prints OBJ + preceded by `#<INSTANCE>' for instances. + + - Function: size OBJ + The default method returns the number of elements in OBJ if it is + a vector, string or list, `2' for a pair, `1' for a character and + by default id an error otherwise. Objects such as collections + (*note Collections::.) may override the default in an obvious way. + + +File: slib.info, Node: Setters, Next: Yasos examples, Prev: Yasos interface, Up: Yasos + +Setters +------- + + "Setters" implement "generalized locations" for objects associated +with some sort of mutable state. A "getter" operation retrieves a +value from a generalized location and the corresponding setter +operation stores a value into the location. Only the getter is named - +the setter is specified by a procedure call as below. (Dylan uses +special syntax.) Typically, but not necessarily, getters are access +operations to extract values from Yasos objects (*note Yasos::.). +Several setters are predefined, corresponding to getters `car', `cdr', +`string-ref' and `vector-ref' e.g., `(setter car)' is equivalent to +`set-car!'. + + This implementation of setters is similar to that in Dylan(TM) +(`Dylan: An object-oriented dynamic language', Apple Computer Eastern +Research and Technology). Common LISP provides similar facilities +through `setf'. + + - Function: setter GETTER + Returns the setter for the procedure GETTER. E.g., since + `string-ref' is the getter corresponding to a setter which is + actually `string-set!': + (define foo "foo") + ((setter string-ref) foo 0 #\F) ; set element 0 of foo + foo => "Foo" + + - Syntax: set PLACE NEW-VALUE + If PLACE is a variable name, `set' is equivalent to `set!'. + Otherwise, PLACE must have the form of a procedure call, where the + procedure name refers to a getter and the call indicates an + accessible generalized location, i.e., the call would return a + value. The return value of `set' is usually unspecified unless + used with a setter whose definition guarantees to return a useful + value. + (set (string-ref foo 2) #\O) ; generalized location with getter + foo => "FoO" + (set foo "foo") ; like set! + foo => "foo" + + - Procedure: add-setter GETTER SETTER + Add procedures GETTER and SETTER to the (inaccessible) list of + valid setter/getter pairs. SETTER implements the store operation + corresponding to the GETTER access operation for the relevant + state. The return value is unspecified. + + - Procedure: remove-setter-for GETTER + Removes the setter corresponding to the specified GETTER from the + list of valid setters. The return value is unspecified. + + - Syntax: define-access-operation GETTER-NAME + Shorthand for a Yasos `define-operation' defining an operation + GETTER-NAME that objects may support to return the value of some + mutable state. The default operation is to signal an error. The + return value is unspecified. + + +File: slib.info, Node: Yasos examples, Prev: Setters, Up: Yasos + +Examples +-------- + + ;;; These definitions for PRINT and SIZE are + ;;; already supplied by + (require 'yasos) + + (define-operation (print obj port) + (format port + (if (instance? obj) "#<instance>" "~s") + obj)) + + (define-operation (size obj) + (cond + ((vector? obj) (vector-length obj)) + ((list? obj) (length obj)) + ((pair? obj) 2) + ((string? obj) (string-length obj)) + ((char? obj) 1) + (else + (error "Operation not supported: size" obj)))) + + (define-predicate cell?) + (define-operation (fetch obj)) + (define-operation (store! obj newValue)) + + (define (make-cell value) + (object + ((cell? self) #t) + ((fetch self) value) + ((store! self newValue) + (set! value newValue) + newValue) + ((size self) 1) + ((print self port) + (format port "#<Cell: ~s>" (fetch self))))) + + (define-operation (discard obj value) + (format #t "Discarding ~s~%" value)) + + (define (make-filtered-cell value filter) + (object-with-ancestors + ((cell (make-cell value))) + ((store! self newValue) + (if (filter newValue) + (store! cell newValue) + (discard self newValue))))) + + (define-predicate array?) + (define-operation (array-ref array index)) + (define-operation (array-set! array index value)) + + (define (make-array num-slots) + (let ((anArray (make-vector num-slots))) + (object + ((array? self) #t) + ((size self) num-slots) + ((array-ref self index) + (vector-ref anArray index)) + ((array-set! self index newValue) + (vector-set! anArray index newValue)) + ((print self port) + (format port "#<Array ~s>" (size self)))))) + + (define-operation (position obj)) + (define-operation (discarded-value obj)) + + (define (make-cell-with-history value filter size) + (let ((pos 0) (most-recent-discard #f)) + (object-with-ancestors + ((cell (make-filtered-call value filter)) + (sequence (make-array size))) + ((array? self) #f) + ((position self) pos) + ((store! self newValue) + (operate-as cell store! self newValue) + (array-set! self pos newValue) + (set! pos (+ pos 1))) + ((discard self value) + (set! most-recent-discard value)) + ((discarded-value self) most-recent-discard) + ((print self port) + (format port "#<Cell-with-history ~s>" + (fetch self)))))) + + (define-access-operation fetch) + (add-setter fetch store!) + (define foo (make-cell 1)) + (print foo #f) + => "#<Cell: 1>" + (set (fetch foo) 2) + => + (print foo #f) + => "#<Cell: 2>" + (fetch foo) + => 2 + + +File: slib.info, Node: Textual Conversion Packages, Next: Mathematical Packages, Prev: Scheme Syntax Extension Packages, Up: Top + +Textual Conversion Packages +*************************** + +* Menu: + +* Precedence Parsing:: +* Format:: Common-Lisp Format +* Standard Formatted I/O:: Posix printf and scanf +* Programs and Arguments:: +* HTML HTTP and CGI:: Generate pages and serve WWW sites +* Printing Scheme:: Nicely +* Time and Date:: +* Vector Graphics:: +* Schmooz:: Documentation markup for Scheme programs + + +File: slib.info, Node: Precedence Parsing, Next: Format, Prev: Textual Conversion Packages, Up: Textual Conversion Packages + +Precedence Parsing +================== + + `(require 'precedence-parse)' or `(require 'parse)' + +This package implements: + + * a Pratt style precedence parser; + + * a "tokenizer" which congeals tokens according to assigned classes + of constituent characters; + + * procedures giving direct control of parser rulesets; + + * procedures for higher level specification of rulesets. + +* Menu: + +* Precedence Parsing Overview:: +* Ruleset Definition and Use:: +* Token definition:: +* Nud and Led Definition:: +* Grammar Rule Definition:: + + +File: slib.info, Node: Precedence Parsing Overview, Next: Ruleset Definition and Use, Prev: Precedence Parsing, Up: Precedence Parsing + +Precedence Parsing Overview +--------------------------- + +This package offers improvements over previous parsers. + + * Common computer language constructs are concisely specified. + + * Grammars can be changed dynamically. Operators can be assigned + different meanings within a lexical context. + + * Rulesets don't need compilation. Grammars can be changed + incrementally. + + * Operator precedence is specified by integers. + + * All possibilities of bad input are handled (1) and return as much + structure as was parsed when the error occured; The symbol `?' is + substituted for missing input. + +Here are the higher-level syntax types and an example of each. +Precedence considerations are omitted for clarity. See *Note Grammar +Rule Definition:: for full details. + + - Grammar: nofix bye exit + bye + calls the function `exit' with no arguments. + + - Grammar: prefix - negate + - 42 + Calls the function `negate' with the argument `42'. + + - Grammar: infix - difference + x - y + Calls the function `difference' with arguments `x' and `y'. + + - Grammar: nary + sum + x + y + z + Calls the function `sum' with arguments `x', `y', and `y'. + + - Grammar: postfix ! factorial + 5 ! + Calls the function `factorial' with the argument `5'. + + - Grammar: prestfix set set! + set foo bar + Calls the function `set!' with the arguments `foo' and `bar'. + + - Grammar: commentfix /* */ + /* almost any text here */ + Ignores the comment delimited by `/*' and `*/'. + + - Grammar: matchfix { list } + {0, 1, 2} + Calls the function `list' with the arguments `0', `1', and `2'. + + - Grammar: inmatchfix ( funcall ) + f(x, y) + Calls the function `funcall' with the arguments `f', `x', and `y'. + + - Grammar: delim ; + set foo bar; + delimits the extent of the restfix operator `set'. + + ---------- Footnotes ---------- + + (1) How do I know this? I parsed 250kbyte of random input (an e-mail +file) with a non-trivial grammar utilizing all constructs. + + +File: slib.info, Node: Ruleset Definition and Use, Next: Token definition, Prev: Precedence Parsing Overview, Up: Precedence Parsing + +Ruleset Definition and Use +-------------------------- + + - Variable: *syn-defs* + A grammar is built by one or more calls to `prec:define-grammar'. + The rules are appended to *SYN-DEFS*. The value of *SYN-DEFS* is + the grammar suitable for passing as an argument to `prec:parse'. + + - Constant: *syn-ignore-whitespace* + Is a nearly empty grammar with whitespace characters set to group + 0, which means they will not be made into tokens. Most rulesets + will want to start with `*syn-ignore-whitespace*' + +In order to start defining a grammar, either + + (set! *syn-defs* '()) + +or + + (set! *syn-defs* *syn-ignore-whitespace*) + + - Function: prec:define-grammar RULE1 ... + Appends RULE1 ... to *SYN-DEFS*. `prec:define-grammar' is used to + define both the character classes and rules for tokens. + +Once your grammar is defined, save the value of `*syn-defs*' in a +variable (for use when calling `prec:parse'). + + (define my-ruleset *syn-defs*) + + - Function: prec:parse RULESET DELIM + - Function: prec:parse RULESET DELIM PORT + The RULESET argument must be a list of rules as constructed by + `prec:define-grammar' and extracted from *SYN-DEFS*. + + The token DELIM may be a character, symbol, or string. A + character DELIM argument will match only a character token; i.e. a + character for which no token-group is assigned. A symbols or + string will match only a token string; i.e. a token resulting from + a token group. + + `prec:parse' reads a RULESET grammar expression delimited by DELIM + from the given input PORT. `prec:parse' returns the next object + parsable from the given input PORT, updating PORT to point to the + first character past the end of the external representation of the + object. + + If an end of file is encountered in the input before any + characters are found that can begin an object, then an end of file + object is returned. If a delimiter (such as DELIM) is found + before any characters are found that can begin an object, then + `#f' is returned. + + The PORT argument may be omitted, in which case it defaults to the + value returned by `current-input-port'. It is an error to parse + from a closed port. + + +File: slib.info, Node: Token definition, Next: Nud and Led Definition, Prev: Ruleset Definition and Use, Up: Precedence Parsing + +Token definition +---------------- + + - Function: tok:char-group GROUP CHARS CHARS-PROC + The argument CHARS may be a single character, a list of + characters, or a string. Each character in CHARS is treated as + though `tok:char-group' was called with that character alone. + + The argument CHARS-PROC must be a procedure of one argument, a + list of characters. After `tokenize' has finished accumulating + the characters for a token, it calls CHARS-PROC with the list of + characters. The value returned is the token which `tokenize' + returns. + + The argument GROUP may be an exact integer or a procedure of one + character argument. The following discussion concerns the + treatment which the tokenizing routine, `tokenize', will accord to + characters on the basis of their groups. + + When GROUP is a non-zero integer, characters whose group number is + equal to or exactly one less than GROUP will continue to + accumulate. Any other character causes the accumulation to stop + (until a new token is to be read). + + The GROUP of zero is special. These characters are ignored when + parsed pending a token, and stop the accumulation of token + characters when the accumulation has already begun. Whitespace + characters are usually put in group 0. + + If GROUP is a procedure, then, when triggerd by the occurence of + an initial (no accumulation) CHARS character, this procedure will + be repeatedly called with each successive character from the input + stream until the GROUP procedure returns a non-false value. + +The following convenient constants are provided for use with +`tok:char-group'. + + - Constant: tok:decimal-digits + Is the string `"0123456789"'. + + - Constant: tok:upper-case + Is the string consisting of all upper-case letters + ("ABCDEFGHIJKLMNOPQRSTUVWXYZ"). + + - Constant: tok:lower-case + Is the string consisting of all lower-case letters + ("abcdefghijklmnopqrstuvwxyz"). + + - Constant: tok:whitespaces + Is the string consisting of all characters between 0 and 255 for + which `char-whitespace?' returns true. + + +File: slib.info, Node: Nud and Led Definition, Next: Grammar Rule Definition, Prev: Token definition, Up: Precedence Parsing + +Nud and Led Definition +---------------------- + + This section describes advanced features. You can skip this section +on first reading. + +The "Null Denotation" (or "nud") of a token is the procedure and +arguments applying for that token when "Left", an unclaimed parsed +expression is not extant. + +The "Left Denotation" (or "led") of a token is the procedure, +arguments, and lbp applying for that token when there is a "Left", an +unclaimed parsed expression. + +In his paper, + + Pratt, V. R. Top Down Operator Precendence. `SIGACT/SIGPLAN + Symposium on Principles of Programming Languages', Boston, 1973, + pages 41-51 + + the "left binding power" (or "lbp") was an independent property of +tokens. I think this was done in order to allow tokens with NUDs but +not LEDs to also be used as delimiters, which was a problem for +statically defined syntaxes. It turns out that *dynamically binding* +NUDs and LEDs allows them independence. + +For the rule-defining procedures that follow, the variable TK may be a +character, string, or symbol, or a list composed of characters, +strings, and symbols. Each element of TK is treated as though the +procedure were called for each element. + +Character TK arguments will match only character tokens; i.e. +characters for which no token-group is assigned. Symbols and strings +will both match token strings; i.e. tokens resulting from token groups. + + - Function: prec:make-nud TK SOP ARG1 ... + Returns a rule specifying that SOP be called when TK is parsed. + If SOP is a procedure, it is called with TK and ARG1 ... as its + arguments; the resulting value is incorporated into the expression + being built. Otherwise, `(list SOP ARG1 ...)' is incorporated. + +If no NUD has been defined for a token; then if that token is a string, +it is converted to a symbol and returned; if not a string, the token is +returned. + + - Function: prec:make-led TK SOP ARG1 ... + Returns a rule specifying that SOP be called when TK is parsed and + LEFT has an unclaimed parsed expression. If SOP is a procedure, + it is called with LEFT, TK, and ARG1 ... as its arguments; the + resulting value is incorporated into the expression being built. + Otherwise, LEFT is incorporated. + +If no LED has been defined for a token, and LEFT is set, the parser +issues a warning. + + +File: slib.info, Node: Grammar Rule Definition, Prev: Nud and Led Definition, Up: Precedence Parsing + +Grammar Rule Definition +----------------------- + +Here are procedures for defining rules for the syntax types introduced +in *Note Precedence Parsing Overview::. + +For the rule-defining procedures that follow, the variable TK may be a +character, string, or symbol, or a list composed of characters, +strings, and symbols. Each element of TK is treated as though the +procedure were called for each element. + +For procedures prec:delim, ..., prec:prestfix, if the SOP argument is +`#f', then the token which triggered this rule is converted to a symbol +and returned. A false SOP argument to the procedures prec:commentfix, +prec:matchfix, or prec:inmatchfix has a different meaning. + +Character TK arguments will match only character tokens; i.e. +characters for which no token-group is assigned. Symbols and strings +will both match token strings; i.e. tokens resulting from token groups. + + - Function: prec:delim TK + Returns a rule specifying that TK should not be returned from + parsing; i.e. TK's function is purely syntactic. The end-of-file + is always treated as a delimiter. + + - Function: prec:nofix TK SOP + Returns a rule specifying the following actions take place when TK + is parsed: + * If SOP is a procedure, it is called with no arguments; the + resulting value is incorporated into the expression being + built. Otherwise, the list of SOP is incorporated. + + - Function: prec:prefix TK SOP BP RULE1 ... + Returns a rule specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * `prec:parse1' is called with binding-power BP. + + * If SOP is a procedure, it is called with the expression + returned from `prec:parse1'; the resulting value is + incorporated into the expression being built. Otherwise, the + list of SOP and the expression returned from `prec:parse1' is + incorporated. + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + - Function: prec:infix TK SOP LBP BP RULE1 ... + Returns a rule declaring the left-binding-precedence of the token + TK is LBP and specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * One expression is parsed with binding-power LBP. If instead a + delimiter is encountered, a warning is issued. + + * If SOP is a procedure, it is applied to the list of LEFT and + the parsed expression; the resulting value is incorporated + into the expression being built. Otherwise, the list of SOP, + the LEFT expression, and the parsed expression is + incorporated. + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + - Function: prec:nary TK SOP BP + Returns a rule declaring the left-binding-precedence of the token + TK is BP and specifying the following actions take place when TK + is parsed: + * Expressions are parsed with binding-power BP as far as they + are interleaved with the token TK. + + * If SOP is a procedure, it is applied to the list of LEFT and + the parsed expressions; the resulting value is incorporated + into the expression being built. Otherwise, the list of SOP, + the LEFT expression, and the parsed expressions is + incorporated. + + - Function: prec:postfix TK SOP LBP + Returns a rule declaring the left-binding-precedence of the token + TK is LBP and specifying the following actions take place when TK + is parsed: + * If SOP is a procedure, it is called with the LEFT expression; + the resulting value is incorporated into the expression being + built. Otherwise, the list of SOP and the LEFT expression is + incorporated. + + - Function: prec:prestfix TK SOP BP RULE1 ... + Returns a rule specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * Expressions are parsed with binding-power BP until a + delimiter is reached. + + * If SOP is a procedure, it is applied to the list of parsed + expressions; the resulting value is incorporated into the + expression being built. Otherwise, the list of SOP and the + parsed expressions is incorporated. + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + - Function: prec:commentfix TK STP MATCH RULE1 ... + Returns rules specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * Characters are read until and end-of-file or a sequence of + characters is read which matches the *string* MATCH. + + * If STP is a procedure, it is called with the string of all + that was read between the TK and MATCH (exclusive). + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + Parsing of commentfix syntax differs from the others in several + ways. It reads directly from input without tokenizing; It calls + STP but does not return its value; nay any value. I added the STP + argument so that comment text could be echoed. + + - Function: prec:matchfix TK SOP SEP MATCH RULE1 ... + Returns a rule specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * A rule declaring the token MATCH a delimiter takes effect. + + * Expressions are parsed with binding-power `0' until the token + MATCH is reached. If the token SEP does not appear between + each pair of expressions parsed, a warning is issued. + + * If SOP is a procedure, it is applied to the list of parsed + expressions; the resulting value is incorporated into the + expression being built. Otherwise, the list of SOP and the + parsed expressions is incorporated. + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + - Function: prec:inmatchfix TK SOP SEP MATCH LBP RULE1 ... + Returns a rule declaring the left-binding-precedence of the token + TK is LBP and specifying the following actions take place when TK + is parsed: + * The rules RULE1 ... augment and, in case of conflict, override + rules currently in effect. + + * A rule declaring the token MATCH a delimiter takes effect. + + * Expressions are parsed with binding-power `0' until the token + MATCH is reached. If the token SEP does not appear between + each pair of expressions parsed, a warning is issued. + + * If SOP is a procedure, it is applied to the list of LEFT and + the parsed expressions; the resulting value is incorporated + into the expression being built. Otherwise, the list of SOP, + the LEFT expression, and the parsed expressions is + incorporated. + + * The ruleset in effect before TK was parsed is restored; RULE1 + ... are forgotten. + + +File: slib.info, Node: Format, Next: Standard Formatted I/O, Prev: Precedence Parsing, Up: Textual Conversion Packages + +Format (version 3.0) +==================== + + `(require 'format)' + +* Menu: + +* Format Interface:: +* Format Specification:: + + +File: slib.info, Node: Format Interface, Next: Format Specification, Prev: Format, Up: Format + +Format Interface +---------------- + + - Function: format DESTINATION FORMAT-STRING . ARGUMENTS + An almost complete implementation of Common LISP format description + according to the CL reference book `Common LISP' from Guy L. + Steele, Digital Press. Backward compatible to most of the + available Scheme format implementations. + + Returns `#t', `#f' or a string; has side effect of printing + according to FORMAT-STRING. If DESTINATION is `#t', the output is + to the current output port and `#t' is returned. If DESTINATION + is `#f', a formatted string is returned as the result of the call. + NEW: If DESTINATION is a string, DESTINATION is regarded as the + format string; FORMAT-STRING is then the first argument and the + output is returned as a string. If DESTINATION is a number, the + output is to the current error port if available by the + implementation. Otherwise DESTINATION must be an output port and + `#t' is returned. + + FORMAT-STRING must be a string. In case of a formatting error + format returns `#f' and prints a message on the current output or + error port. Characters are output as if the string were output by + the `display' function with the exception of those prefixed by a + tilde (~). For a detailed description of the FORMAT-STRING syntax + please consult a Common LISP format reference manual. For a test + suite to verify this format implementation load `formatst.scm'. + Please send bug reports to `lutzeb@cs.tu-berlin.de'. + + Note: `format' is not reentrant, i.e. only one `format'-call may + be executed at a time. + + + +File: slib.info, Node: Format Specification, Prev: Format Interface, Up: Format + +Format Specification (Format version 3.0) +----------------------------------------- + + Please consult a Common LISP format reference manual for a detailed +description of the format string syntax. For a demonstration of the +implemented directives see `formatst.scm'. + + This implementation supports directive parameters and modifiers (`:' +and `@' characters). Multiple parameters must be separated by a comma +(`,'). Parameters can be numerical parameters (positive or negative), +character parameters (prefixed by a quote character (`''), variable +parameters (`v'), number of rest arguments parameter (`#'), empty and +default parameters. Directive characters are case independent. The +general form of a directive is: + +DIRECTIVE ::= ~{DIRECTIVE-PARAMETER,}[:][@]DIRECTIVE-CHARACTER + +DIRECTIVE-PARAMETER ::= [ [-|+]{0-9}+ | 'CHARACTER | v | # ] + +Implemented CL Format Control Directives +........................................ + + Documentation syntax: Uppercase characters represent the corresponding +control directive characters. Lowercase characters represent control +directive parameter descriptions. + +`~A' + Any (print as `display' does). + `~@A' + left pad. + + `~MINCOL,COLINC,MINPAD,PADCHARA' + full padding. + +`~S' + S-expression (print as `write' does). + `~@S' + left pad. + + `~MINCOL,COLINC,MINPAD,PADCHARS' + full padding. + +`~D' + Decimal. + `~@D' + print number sign always. + + `~:D' + print comma separated. + + `~MINCOL,PADCHAR,COMMACHARD' + padding. + +`~X' + Hexadecimal. + `~@X' + print number sign always. + + `~:X' + print comma separated. + + `~MINCOL,PADCHAR,COMMACHARX' + padding. + +`~O' + Octal. + `~@O' + print number sign always. + + `~:O' + print comma separated. + + `~MINCOL,PADCHAR,COMMACHARO' + padding. + +`~B' + Binary. + `~@B' + print number sign always. + + `~:B' + print comma separated. + + `~MINCOL,PADCHAR,COMMACHARB' + padding. + +`~NR' + Radix N. + `~N,MINCOL,PADCHAR,COMMACHARR' + padding. + +`~@R' + print a number as a Roman numeral. + +`~:@R' + print a number as an "old fashioned" Roman numeral. + +`~:R' + print a number as an ordinal English number. + +`~:@R' + print a number as a cardinal English number. + +`~P' + Plural. + `~@P' + prints `y' and `ies'. + + `~:P' + as `~P but jumps 1 argument backward.' + + `~:@P' + as `~@P but jumps 1 argument backward.' + +`~C' + Character. + `~@C' + prints a character as the reader can understand it (i.e. `#\' + prefixing). + + `~:C' + prints a character as emacs does (eg. `^C' for ASCII 03). + +`~F' + Fixed-format floating-point (prints a flonum like MMM.NNN). + `~WIDTH,DIGITS,SCALE,OVERFLOWCHAR,PADCHARF' + + `~@F' + If the number is positive a plus sign is printed. + +`~E' + Exponential floating-point (prints a flonum like MMM.NNN`E'EE). + `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARE' + + `~@E' + If the number is positive a plus sign is printed. + +`~G' + General floating-point (prints a flonum either fixed or + exponential). + `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARG' + + `~@G' + If the number is positive a plus sign is printed. + +`~$' + Dollars floating-point (prints a flonum in fixed with signs + separated). + `~DIGITS,SCALE,WIDTH,PADCHAR$' + + `~@$' + If the number is positive a plus sign is printed. + + `~:@$' + A sign is always printed and appears before the padding. + + `~:$' + The sign appears before the padding. + +`~%' + Newline. + `~N%' + print N newlines. + +`~&' + print newline if not at the beginning of the output line. + `~N&' + prints `~&' and then N-1 newlines. + +`~|' + Page Separator. + `~N|' + print N page separators. + +`~~' + Tilde. + `~N~' + print N tildes. + +`~'<newline> + Continuation Line. + `~:'<newline> + newline is ignored, white space left. + + `~@'<newline> + newline is left, white space ignored. + +`~T' + Tabulation. + `~@T' + relative tabulation. + + `~COLNUM,COLINCT' + full tabulation. + +`~?' + Indirection (expects indirect arguments as a list). + `~@?' + extracts indirect arguments from format arguments. + +`~(STR~)' + Case conversion (converts by `string-downcase'). + `~:(STR~)' + converts by `string-capitalize'. + + `~@(STR~)' + converts by `string-capitalize-first'. + + `~:@(STR~)' + converts by `string-upcase'. + +`~*' + Argument Jumping (jumps 1 argument forward). + `~N*' + jumps N arguments forward. + + `~:*' + jumps 1 argument backward. + + `~N:*' + jumps N arguments backward. + + `~@*' + jumps to the 0th argument. + + `~N@*' + jumps to the Nth argument (beginning from 0) + +`~[STR0~;STR1~;...~;STRN~]' + Conditional Expression (numerical clause conditional). + `~N[' + take argument from N. + + `~@[' + true test conditional. + + `~:[' + if-else-then conditional. + + `~;' + clause separator. + + `~:;' + default clause follows. + +`~{STR~}' + Iteration (args come from the next argument (a list)). + `~N{' + at most N iterations. + + `~:{' + args from next arg (a list of lists). + + `~@{' + args from the rest of arguments. + + `~:@{' + args from the rest args (lists). + +`~^' + Up and out. + `~N^' + aborts if N = 0 + + `~N,M^' + aborts if N = M + + `~N,M,K^' + aborts if N <= M <= K + +Not Implemented CL Format Control Directives +............................................ + +`~:A' + print `#f' as an empty list (see below). + +`~:S' + print `#f' as an empty list (see below). + +`~<~>' + Justification. + +`~:^' + (sorry I don't understand its semantics completely) + +Extended, Replaced and Additional Control Directives +.................................................... + +`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHD' + +`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHX' + +`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHO' + +`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHB' + +`~N,MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHR' + COMMAWIDTH is the number of characters between two comma + characters. + +`~I' + print a R4RS complex number as `~F~@Fi' with passed parameters for + `~F'. + +`~Y' + Pretty print formatting of an argument for scheme code lists. + +`~K' + Same as `~?.' + +`~!' + Flushes the output if format DESTINATION is a port. + +`~_' + Print a `#\space' character + `~N_' + print N `#\space' characters. + +`~/' + Print a `#\tab' character + `~N/' + print N `#\tab' characters. + +`~NC' + Takes N as an integer representation for a character. No arguments + are consumed. N is converted to a character by `integer->char'. N + must be a positive decimal number. + +`~:S' + Print out readproof. Prints out internal objects represented as + `#<...>' as strings `"#<...>"' so that the format output can always + be processed by `read'. + +`~:A' + Print out readproof. Prints out internal objects represented as + `#<...>' as strings `"#<...>"' so that the format output can always + be processed by `read'. + +`~Q' + Prints information and a copyright notice on the format + implementation. + `~:Q' + prints format version. + +`~F, ~E, ~G, ~$' + may also print number strings, i.e. passing a number as a string + and format it accordingly. + +Configuration Variables +....................... + + Format has some configuration variables at the beginning of +`format.scm' to suit the systems and users needs. There should be no +modification necessary for the configuration that comes with SLIB. If +modification is desired the variable should be set after the format +code is loaded. Format detects automatically if the running scheme +system implements floating point numbers and complex numbers. + +FORMAT:SYMBOL-CASE-CONV + Symbols are converted by `symbol->string' so the case type of the + printed symbols is implementation dependent. + `format:symbol-case-conv' is a one arg closure which is either + `#f' (no conversion), `string-upcase', `string-downcase' or + `string-capitalize'. (default `#f') + +FORMAT:IOBJ-CASE-CONV + As FORMAT:SYMBOL-CASE-CONV but applies for the representation of + implementation internal objects. (default `#f') + +FORMAT:EXPCH + The character prefixing the exponent value in `~E' printing. + (default `#\E') + +Compatibility With Other Format Implementations +............................................... + +SLIB format 2.x: + See `format.doc'. + +SLIB format 1.4: + Downward compatible except for padding support and `~A', `~S', + `~P', `~X' uppercase printing. SLIB format 1.4 uses C-style + `printf' padding support which is completely replaced by the CL + `format' padding style. + +MIT C-Scheme 7.1: + Downward compatible except for `~', which is not documented + (ignores all characters inside the format string up to a newline + character). (7.1 implements `~a', `~s', ~NEWLINE, `~~', `~%', + numerical and variable parameters and `:/@' modifiers in the CL + sense). + +Elk 1.5/2.0: + Downward compatible except for `~A' and `~S' which print in + uppercase. (Elk implements `~a', `~s', `~~', and `~%' (no + directive parameters or modifiers)). + +Scheme->C 01nov91: + Downward compatible except for an optional destination parameter: + S2C accepts a format call without a destination which returns a + formatted string. This is equivalent to a #f destination in S2C. + (S2C implements `~a', `~s', `~c', `~%', and `~~' (no directive + parameters or modifiers)). + + This implementation of format is solely useful in the SLIB context +because it requires other components provided by SLIB. + + +File: slib.info, Node: Standard Formatted I/O, Next: Programs and Arguments, Prev: Format, Up: Textual Conversion Packages + +Standard Formatted I/O +====================== + +* Menu: + +* Standard Formatted Output:: 'printf +* Standard Formatted Input:: 'scanf + +stdio +----- + + `(require 'stdio)' + + `require's `printf' and `scanf' and additionally defines the symbols: + + - Variable: stdin + Defined to be `(current-input-port)'. + + - Variable: stdout + Defined to be `(current-output-port)'. + + - Variable: stderr + Defined to be `(current-error-port)'. + + +File: slib.info, Node: Standard Formatted Output, Next: Standard Formatted Input, Prev: Standard Formatted I/O, Up: Standard Formatted I/O + +Standard Formatted Output +------------------------- + + `(require 'printf)' + + - Procedure: printf FORMAT ARG1 ... + - Procedure: fprintf PORT FORMAT ARG1 ... + - Procedure: sprintf STR FORMAT ARG1 ... + - Procedure: sprintf #F FORMAT ARG1 ... + - Procedure: sprintf K FORMAT ARG1 ... + Each function converts, formats, and outputs its ARG1 ... + arguments according to the control string FORMAT argument and + returns the number of characters output. + + `printf' sends its output to the port `(current-output-port)'. + `fprintf' sends its output to the port PORT. `sprintf' + `string-set!'s locations of the non-constant string argument STR + to the output characters. + + Two extensions of `sprintf' return new strings. If the first + argument is `#f', then the returned string's length is as many + characters as specified by the FORMAT and data; if the first + argument is a non-negative integer K, then the length of the + returned string is also bounded by K. + + The string FORMAT contains plain characters which are copied to + the output stream, and conversion specifications, each of which + results in fetching zero or more of the arguments ARG1 .... The + results are undefined if there are an insufficient number of + arguments for the format. If FORMAT is exhausted while some of the + ARG1 ... arguments remain unused, the excess ARG1 ... arguments + are ignored. + + The conversion specifications in a format string have the form: + + % [ FLAGS ] [ WIDTH ] [ . PRECISION ] [ TYPE ] CONVERSION + + An output conversion specifications consist of an initial `%' + character followed in sequence by: + + * Zero or more "flag characters" that modify the normal + behavior of the conversion specification. + + `-' + Left-justify the result in the field. Normally the + result is right-justified. + + `+' + For the signed `%d' and `%i' conversions and all inexact + conversions, prefix a plus sign if the value is positive. + + ` ' + For the signed `%d' and `%i' conversions, if the result + doesn't start with a plus or minus sign, prefix it with + a space character instead. Since the `+' flag ensures + that the result includes a sign, this flag is ignored if + both are specified. + + `#' + For inexact conversions, `#' specifies that the result + should always include a decimal point, even if no digits + follow it. For the `%g' and `%G' conversions, this also + forces trailing zeros after the decimal point to be + printed where they would otherwise be elided. + + For the `%o' conversion, force the leading digit to be + `0', as if by increasing the precision. For `%x' or + `%X', prefix a leading `0x' or `0X' (respectively) to + the result. This doesn't do anything useful for the + `%d', `%i', or `%u' conversions. Using this flag + produces output which can be parsed by the `scanf' + functions with the `%i' conversion (*note Standard + Formatted Input::.). + + `0' + Pad the field with zeros instead of spaces. The zeros + are placed after any indication of sign or base. This + flag is ignored if the `-' flag is also specified, or if + a precision is specified for an exact converson. + + * An optional decimal integer specifying the "minimum field + width". If the normal conversion produces fewer characters + than this, the field is padded (with spaces or zeros per the + `0' flag) to the specified width. This is a *minimum* width; + if the normal conversion produces more characters than this, + the field is *not* truncated. + + Alternatively, if the field width is `*', the next argument + in the argument list (before the actual value to be printed) + is used as the field width. The width value must be an + integer. If the value is negative it is as though the `-' + flag is set (see above) and the absolute value is used as the + field width. + + * An optional "precision" to specify the number of digits to be + written for numeric conversions and the maximum field width + for string conversions. The precision is specified by a + period (`.') followed optionally by a decimal integer (which + defaults to zero if omitted). + + Alternatively, if the precision is `.*', the next argument in + the argument list (before the actual value to be printed) is + used as the precision. The value must be an integer, and is + ignored if negative. If you specify `*' for both the field + width and precision, the field width argument precedes the + precision argument. The `.*' precision is an enhancement. C + library versions may not accept this syntax. + + For the `%f', `%e', and `%E' conversions, the precision + specifies how many digits follow the decimal-point character. + The default precision is `6'. If the precision is + explicitly `0', the decimal point character is suppressed. + + For the `%g' and `%G' conversions, the precision specifies how + many significant digits to print. Significant digits are the + first digit before the decimal point, and all the digits + after it. If the precision is `0' or not specified for `%g' + or `%G', it is treated like a value of `1'. If the value + being printed cannot be expressed accurately in the specified + number of digits, the value is rounded to the nearest number + that fits. + + For exact conversions, if a precision is supplied it + specifies the minimum number of digits to appear; leading + zeros are produced if necessary. If a precision is not + supplied, the number is printed with as many digits as + necessary. Converting an exact `0' with an explicit + precision of zero produces no characters. + + * An optional one of `l', `h' or `L', which is ignored for + numeric conversions. It is an error to specify these + modifiers for non-numeric conversions. + + * A character that specifies the conversion to be applied. + +Exact Conversions +................. + + `d', `i' + Print an integer as a signed decimal number. `%d' and `%i' + are synonymous for output, but are different when used with + `scanf' for input (*note Standard Formatted Input::.). + + `o' + Print an integer as an unsigned octal number. + + `u' + Print an integer as an unsigned decimal number. + + `x', `X' + Print an integer as an unsigned hexadecimal number. `%x' + prints using the digits `0123456789abcdef'. `%X' prints + using the digits `0123456789ABCDEF'. + +Inexact Conversions +................... + + `f' + Print a floating-point number in fixed-point notation. + + `e', `E' + Print a floating-point number in exponential notation. `%e' + prints `e' between mantissa and exponont. `%E' prints `E' + between mantissa and exponont. + + `g', `G' + Print a floating-point number in either fixed or exponential | + notation, whichever is more appropriate for its magnitude. + Unless an `#' flag has been supplied trailing zeros after a + decimal point will be stripped off. `%g' prints `e' between + mantissa and exponont. `%G' prints `E' between mantissa and + exponent. + +Other Conversions +................. + + `c' + Print a single character. The `-' flag is the only one which + can be specified. It is an error to specify a precision. + + `s' + Print a string. The `-' flag is the only one which can be + specified. A precision specifies the maximum number of + characters to output; otherwise all characters in the string + are output. + + `a', `A' + Print a scheme expression. The `-' flag left-justifies the + output. The `#' flag specifies that strings and characters + should be quoted as by `write' (which can be read using + `read'); otherwise, output is as `display' prints. A + precision specifies the maximum number of characters to + output; otherwise as many characters as needed are output. + + *Note:* `%a' and `%A' are SLIB extensions. + + `%' + Print a literal `%' character. No argument is consumed. It + is an error to specifiy flags, field width, precision, or + type modifiers with `%%'. + + +File: slib.info, Node: Standard Formatted Input, Prev: Standard Formatted Output, Up: Standard Formatted I/O + +Standard Formatted Input +------------------------ + + `(require 'scanf)' + + - Function: scanf-read-list FORMAT + - Function: scanf-read-list FORMAT PORT + - Function: scanf-read-list FORMAT STRING + + - Macro: scanf FORMAT ARG1 ... + - Macro: fscanf PORT FORMAT ARG1 ... + - Macro: sscanf STR FORMAT ARG1 ... + Each function reads characters, interpreting them according to the + control string FORMAT argument. + + `scanf-read-list' returns a list of the items specified as far as + the input matches FORMAT. `scanf', `fscanf', and `sscanf' return + the number of items successfully matched and stored. `scanf', + `fscanf', and `sscanf' also set the location corresponding to ARG1 + ... using the methods: + + symbol + `set!' + + car expression + `set-car!' + + cdr expression + `set-cdr!' + + vector-ref expression + `vector-set!' + + substring expression + `substring-move-left!' + + The argument to a `substring' expression in ARG1 ... must be a + non-constant string. Characters will be stored starting at the + position specified by the second argument to `substring'. The + number of characters stored will be limited by either the position + specified by the third argument to `substring' or the length of the + matched string, whichever is less. + + The control string, FORMAT, contains conversion specifications and + other characters used to direct interpretation of input sequences. + The control string contains: + + * White-space characters (blanks, tabs, newlines, or formfeeds) + that cause input to be read (and discarded) up to the next + non-white-space character. + + * An ordinary character (not `%') that must match the next + character of the input stream. + + * Conversion specifications, consisting of the character `%', an + optional assignment suppressing character `*', an optional + numerical maximum-field width, an optional `l', `h' or `L' + which is ignored, and a conversion code. + + Unless the specification contains the `n' conversion character + (described below), a conversion specification directs the + conversion of the next input field. The result of a conversion + specification is returned in the position of the corresponding + argument points, unless `*' indicates assignment suppression. + Assignment suppression provides a way to describe an input field + to be skipped. An input field is defined as a string of + characters; it extends to the next inappropriate character or + until the field width, if specified, is exhausted. + + *Note:* This specification of format strings differs from the + `ANSI C' and `POSIX' specifications. In SLIB, white space + before an input field is not skipped unless white space + appears before the conversion specification in the format + string. In order to write format strings which work + identically with `ANSI C' and SLIB, prepend whitespace to all + conversion specifications except `[' and `c'. + + The conversion code indicates the interpretation of the input + field; For a suppressed field, no value is returned. The + following conversion codes are legal: + + `%' + A single % is expected in the input at this point; no value + is returned. + + `d', `D' + A decimal integer is expected. + + `u', `U' + An unsigned decimal integer is expected. + + `o', `O' + An octal integer is expected. + + `x', `X' + A hexadecimal integer is expected. + + `i' + An integer is expected. Returns the value of the next input + item, interpreted according to C conventions; a leading `0' + implies octal, a leading `0x' implies hexadecimal; otherwise, + decimal is assumed. + + `n' + Returns the total number of bytes (including white space) + read by `scanf'. No input is consumed by `%n'. + + `f', `F', `e', `E', `g', `G' + A floating-point number is expected. The input format for + floating-point numbers is an optionally signed string of + digits, possibly containing a radix character `.', followed + by an optional exponent field consisting of an `E' or an `e', + followed by an optional `+', `-', or space, followed by an + integer. + + `c', `C' + WIDTH characters are expected. The normal + skip-over-white-space is suppressed in this case; to read the + next non-space character, use `%1s'. If a field width is + given, a string is returned; up to the indicated number of + characters is read. + + `s', `S' + A character string is expected The input field is terminated + by a white-space character. `scanf' cannot read a null + string. + + `[' + Indicates string data and the normal + skip-over-leading-white-space is suppressed. The left + bracket is followed by a set of characters, called the + scanset, and a right bracket; the input field is the maximal + sequence of input characters consisting entirely of + characters in the scanset. `^', when it appears as the first + character in the scanset, serves as a complement operator and + redefines the scanset as the set of all characters not + contained in the remainder of the scanset string. + Construction of the scanset follows certain conventions. A + range of characters may be represented by the construct + first-last, enabling `[0123456789]' to be expressed `[0-9]'. + Using this convention, first must be lexically less than or + equal to last; otherwise, the dash stands for itself. The + dash also stands for itself when it is the first or the last + character in the scanset. To include the right square + bracket as an element of the scanset, it must appear as the + first character (possibly preceded by a `^') of the scanset, + in which case it will not be interpreted syntactically as the + closing bracket. At least one character must match for this + conversion to succeed. + + The `scanf' functions terminate their conversions at end-of-file, + at the end of the control string, or when an input character + conflicts with the control string. In the latter case, the + offending character is left unread in the input stream. + + +File: slib.info, Node: Programs and Arguments, Next: HTML HTTP and CGI, Prev: Standard Formatted I/O, Up: Textual Conversion Packages + +Program and Arguments +===================== + +* Menu: + +* Getopt:: Command Line option parsing +* Command Line:: A command line reader for Scheme shells +* Parameter lists:: 'parameters +* Getopt Parameter lists:: 'getopt-parameters +* Filenames:: 'glob or 'filename +* Batch:: 'batch + + +File: slib.info, Node: Getopt, Next: Command Line, Prev: Programs and Arguments, Up: Programs and Arguments + +Getopt +------ + + `(require 'getopt)' + + This routine implements Posix command line argument parsing. Notice +that returning values through global variables means that `getopt' is +*not* reentrant. + + - Variable: *optind* + Is the index of the current element of the command line. It is + initially one. In order to parse a new command line or reparse an + old one, *OPTING* must be reset. + + - Variable: *optarg* + Is set by getopt to the (string) option-argument of the current + option. + + - Procedure: getopt ARGC ARGV OPTSTRING + Returns the next option letter in ARGV (starting from `(vector-ref + argv *optind*)') that matches a letter in OPTSTRING. ARGV is a + vector or list of strings, the 0th of which getopt usually + ignores. ARGC is the argument count, usually the length of ARGV. + OPTSTRING is a string of recognized option characters; if a + character is followed by a colon, the option takes an argument + which may be immediately following it in the string or in the next + element of ARGV. + + *OPTIND* is the index of the next element of the ARGV vector to be + processed. It is initialized to 1 by `getopt.scm', and `getopt' + updates it when it finishes with each element of ARGV. + + `getopt' returns the next option character from ARGV that matches + a character in OPTSTRING, if there is one that matches. If the + option takes an argument, `getopt' sets the variable *OPTARG* to + the option-argument as follows: + + * If the option was the last character in the string pointed to + by an element of ARGV, then *OPTARG* contains the next + element of ARGV, and *OPTIND* is incremented by 2. If the + resulting value of *OPTIND* is greater than or equal to ARGC, + this indicates a missing option argument, and `getopt' + returns an error indication. + + * Otherwise, *OPTARG* is set to the string following the option + character in that element of ARGV, and *OPTIND* is + incremented by 1. + + If, when `getopt' is called, the string `(vector-ref argv + *optind*)' either does not begin with the character `#\-' or is + just `"-"', `getopt' returns `#f' without changing *OPTIND*. If + `(vector-ref argv *optind*)' is the string `"--"', `getopt' + returns `#f' after incrementing *OPTIND*. + + If `getopt' encounters an option character that is not contained in + OPTSTRING, it returns the question-mark `#\?' character. If it + detects a missing option argument, it returns the colon character + `#\:' if the first character of OPTSTRING was a colon, or a + question-mark character otherwise. In either case, `getopt' sets + the variable GETOPT:OPT to the option character that caused the + error. + + The special option `"--"' can be used to delimit the end of the + options; `#f' is returned, and `"--"' is skipped. + + RETURN VALUE + + `getopt' returns the next option character specified on the command + line. A colon `#\:' is returned if `getopt' detects a missing + argument and the first character of OPTSTRING was a colon `#\:'. + + A question-mark `#\?' is returned if `getopt' encounters an option + character not in OPTSTRING or detects a missing argument and the + first character of OPTSTRING was not a colon `#\:'. + + Otherwise, `getopt' returns `#f' when all command line options + have been parsed. + + Example: + #! /usr/local/bin/scm + ;;;This code is SCM specific. + (define argv (program-arguments)) + (require 'getopt) + + (define opts ":a:b:cd") + (let loop ((opt (getopt (length argv) argv opts))) + (case opt + ((#\a) (print "option a: " *optarg*)) + ((#\b) (print "option b: " *optarg*)) + ((#\c) (print "option c")) + ((#\d) (print "option d")) + ((#\?) (print "error" getopt:opt)) + ((#\:) (print "missing arg" getopt:opt)) + ((#f) (if (< *optind* (length argv)) + (print "argv[" *optind* "]=" + (list-ref argv *optind*))) + (set! *optind* (+ *optind* 1)))) + (if (< *optind* (length argv)) + (loop (getopt (length argv) argv opts)))) + + (slib:exit) + +Getopt- +------- + + - Function: getopt- ARGC ARGV OPTSTRING + The procedure `getopt--' is an extended version of `getopt' which + parses "long option names" of the form `--hold-the-onions' and + `--verbosity-level=extreme'. `Getopt--' behaves as `getopt' + except for non-empty options beginning with `--'. + + Options beginning with `--' are returned as strings rather than + characters. If a value is assigned (using `=') to a long option, + `*optarg*' is set to the value. The `=' and value are not + returned as part of the option string. + + No information is passed to `getopt--' concerning which long + options should be accepted or whether such options can take + arguments. If a long option did not have an argument, `*optarg' + will be set to `#f'. The caller is responsible for detecting and + reporting errors. + + (define opts ":-:b:") + (define argc 5) + (define argv '("foo" "-b9" "--f1" "--2=" "--g3=35234.342" "--")) + (define *optind* 1) + (define *optarg* #f) + (require 'qp) + (do ((i 5 (+ -1 i))) + ((zero? i)) + (define opt (getopt-- argc argv opts)) + (print *optind* opt *optarg*))) + -| + 2 #\b "9" + 3 "f1" #f + 4 "2" "" + 5 "g3" "35234.342" + 5 #f "35234.342" + + +File: slib.info, Node: Command Line, Next: Parameter lists, Prev: Getopt, Up: Programs and Arguments + +Command Line +------------ + + `(require 'read-command)' + + - Function: read-command PORT + - Function: read-command + `read-command' converts a "command line" into a list of strings + suitable for parsing by `getopt'. The syntax of command lines + supported resembles that of popular "shell"s. `read-command' + updates PORT to point to the first character past the command + delimiter. + + If an end of file is encountered in the input before any + characters are found that can begin an object or comment, then an + end of file object is returned. + + The PORT argument may be omitted, in which case it defaults to the + value returned by `current-input-port'. + + The fields into which the command line is split are delimited by + whitespace as defined by `char-whitespace?'. The end of a command + is delimited by end-of-file or unescaped semicolon (<;>) or + <newline>. Any character can be literally included in a field by + escaping it with a backslach (<\>). + + The initial character and types of fields recognized are: + `\' + The next character has is taken literally and not interpreted + as a field delimiter. If <\> is the last character before a + <newline>, that <newline> is just ignored. Processing + continues from the characters after the <newline> as though + the backslash and <newline> were not there. + + `"' + The characters up to the next unescaped <"> are taken + literally, according to [R4RS] rules for literal strings + (*note Strings: (r4rs)Strings.). + + `(', `%'' + One scheme expression is `read' starting with this character. + The `read' expression is evaluated, converted to a string + (using `display'), and replaces the expression in the returned + field. + + `;' + Semicolon delimits a command. Using semicolons more than one + command can appear on a line. Escaped semicolons and + semicolons inside strings do not delimit commands. + + The comment field differs from the previous fields in that it must + be the first character of a command or appear after whitespace in + order to be recognized. <#> can be part of fields if these + conditions are not met. For instance, `ab#c' is just the field + ab#c. + + `#' + Introduces a comment. The comment continues to the end of + the line on which the semicolon appears. Comments are + treated as whitespace by `read-dommand-line' and backslashes + before <newline>s in comments are also ignored. + + - Function: read-options-file FILENAME + `read-options-file' converts an "options file" into a list of + strings suitable for parsing by `getopt'. The syntax of options + files is the same as the syntax for command lines, except that + <newline>s do not terminate reading (only <;> or end of file). + + If an end of file is encountered before any characters are found + that can begin an object or comment, then an end of file object is + returned. + + +File: slib.info, Node: Parameter lists, Next: Getopt Parameter lists, Prev: Command Line, Up: Programs and Arguments + +Parameter lists +--------------- + + `(require 'parameters)' + +Arguments to procedures in scheme are distinguished from each other by +their position in the procedure call. This can be confusing when a +procedure takes many arguments, many of which are not often used. + +A "parameter-list" is a way of passing named information to a +procedure. Procedures are also defined to set unused parameters to +default values, check parameters, and combine parameter lists. + +A PARAMETER has the form `(parameter-name value1 ...)'. This format +allows for more than one value per parameter-name. + +A PARAMETER-LIST is a list of PARAMETERs, each with a different +PARAMETER-NAME. + + - Function: make-parameter-list PARAMETER-NAMES + Returns an empty parameter-list with slots for PARAMETER-NAMES. + + - Function: parameter-list-ref PARAMETER-LIST PARAMETER-NAME + PARAMETER-NAME must name a valid slot of PARAMETER-LIST. + `parameter-list-ref' returns the value of parameter PARAMETER-NAME + of PARAMETER-LIST. + + - Procedure: adjoin-parameters! PARAMETER-LIST PARAMETER1 ... + Returns PARAMETER-LIST with PARAMETER1 ... merged in. + + - Procedure: parameter-list-expand EXPANDERS PARAMETER-LIST + EXPANDERS is a list of procedures whose order matches the order of + the PARAMETER-NAMEs in the call to `make-parameter-list' which + created PARAMETER-LIST. For each non-false element of EXPANDERS + that procedure is mapped over the corresponding parameter value + and the returned parameter lists are merged into PARAMETER-LIST. + + This process is repeated until PARAMETER-LIST stops growing. The + value returned from `parameter-list-expand' is unspecified. + + - Function: fill-empty-parameters DEFAULTERS PARAMETER-LIST + DEFAULTERS is a list of procedures whose order matches the order + of the PARAMETER-NAMEs in the call to `make-parameter-list' which + created PARAMETER-LIST. `fill-empty-parameters' returns a new + parameter-list with each empty parameter replaced with the list + returned by calling the corresponding DEFAULTER with + PARAMETER-LIST as its argument. + + - Function: check-parameters CHECKS PARAMETER-LIST + CHECKS is a list of procedures whose order matches the order of + the PARAMETER-NAMEs in the call to `make-parameter-list' which + created PARAMETER-LIST. + + `check-parameters' returns PARAMETER-LIST if each CHECK of the + corresponding PARAMETER-LIST returns non-false. If some CHECK + returns `#f' an error is signaled. + +In the following procedures ARITIES is a list of symbols. The elements +of `arities' can be: + +`single' + Requires a single parameter. + +`optional' + A single parameter or no parameter is acceptable. + +`boolean' + A single boolean parameter or zero parameters is acceptable. + +`nary' + Any number of parameters are acceptable. + +`nary1' + One or more of parameters are acceptable. + + - Function: parameter-list->arglist POSITIONS ARITIES TYPES + PARAMETER-LIST + Returns PARAMETER-LIST converted to an argument list. Parameters + of ARITY type `single' and `boolean' are converted to the single + value associated with them. The other ARITY types are converted + to lists of the value(s) of type TYPES. + + POSITIONS is a list of positive integers whose order matches the + order of the PARAMETER-NAMEs in the call to `make-parameter-list' + which created PARAMETER-LIST. The integers specify in which + argument position the corresponding parameter should appear. + + +File: slib.info, Node: Getopt Parameter lists, Next: Filenames, Prev: Parameter lists, Up: Programs and Arguments + +Getopt Parameter lists +---------------------- + + `(require 'getopt-parameters)' + + - Function: getopt->parameter-list ARGC ARGV OPTNAMES ARITIES TYPES + ALIASES + Returns ARGV converted to a parameter-list. OPTNAMES are the + parameter-names. ALIASES is a list of lists of strings and + elements of OPTNAMES. Each of these strings which have length of + 1 will be treated as a single <-> option by `getopt'. Longer + strings will be treated as long-named options (*note getopt-: + Getopt.). + + - Function: getopt->arglist ARGC ARGV OPTNAMES POSITIONS ARITIES TYPES + DEFAULTERS CHECKS ALIASES + Like `getopt->parameter-list', but converts ARGV to an + argument-list as specified by OPTNAMES, POSITIONS, ARITIES, TYPES, + DEFAULTERS, CHECKS, and ALIASES. + +These `getopt' functions can be used with SLIB relational databases. +For an example, *Note make-command-server: Database Utilities. + +If errors are encountered while processing options, directions for using +the options are printed to `current-error-port'. + + (begin + (set! *optind* 1) + (getopt->parameter-list + 2 + '("cmd" "-?") + '(flag number symbols symbols string flag2 flag3 num2 num3) + '(boolean optional nary1 nary single boolean boolean nary nary) + '(boolean integer symbol symbol string boolean boolean integer integer) + '(("flag" flag) + ("f" flag) + ("Flag" flag2) + ("B" flag3) + ("optional" number) + ("o" number) + ("nary1" symbols) + ("N" symbols) + ("nary" symbols) + ("n" symbols) + ("single" string) + ("s" string) + ("a" num2) + ("Abs" num3)))) + -| + Usage: cmd [OPTION ARGUMENT ...] ... + + -f, --flag + -o, --optional=<number> + -n, --nary=<symbols> ... + -N, --nary1=<symbols> ... + -s, --single=<string> + --Flag + -B + -a <num2> ... + --Abs=<num3> ... + + ERROR: getopt->parameter-list "unrecognized option" "-?" + + +File: slib.info, Node: Filenames, Next: Batch, Prev: Getopt Parameter lists, Up: Programs and Arguments + +Filenames +--------- + + `(require 'filename)' or `(require 'glob)' + + - Function: filename:match?? PATTERN + - Function: filename:match-ci?? PATTERN + Returns a predicate which returns a non-false value if its string + argument matches (the string) PATTERN, false otherwise. Filename + matching is like "glob" expansion described the bash manpage, + except that names beginning with `.' are matched and `/' + characters are not treated specially. + + These functions interpret the following characters specially in + PATTERN strings: + `*' + Matches any string, including the null string. + + `?' + Matches any single character. + + `[...]' + Matches any one of the enclosed characters. A pair of + characters separated by a minus sign (-) denotes a range; any + character lexically between those two characters, inclusive, + is matched. If the first character following the `[' is a + `!' or a `^' then any character not enclosed is matched. A + `-' or `]' may be matched by including it as the first or + last character in the set. + + + - Function: filename:substitute?? PATTERN TEMPLATE + - Function: filename:substitute-ci?? PATTERN TEMPLATE + Returns a function transforming a single string argument according + to glob patterns PATTERN and TEMPLATE. PATTERN and TEMPLATE must + have the same number of wildcard specifications, which need not be + identical. PATTERN and TEMPLATE may have a different number of + literal sections. If an argument to the function matches PATTERN + in the sense of `filename:match??' then it returns a copy of + TEMPLATE in which each wildcard specification is replaced by the + part of the argument matched by the corresponding wildcard + specification in PATTERN. A `*' wildcard matches the longest + leftmost string possible. If the argument does not match PATTERN + then false is returned. + + TEMPLATE may be a function accepting the same number of string + arguments as there are wildcard specifications in PATTERN. In the + case of a match the result of applying TEMPLATE to a list of the + substrings matched by wildcard specifications will be returned, + otherwise TEMPLATE will not be called and `#f' will be returned. + + ((filename:substitute?? "scm_[0-9]*.html" "scm5c4_??.htm") + "scm_10.html") + => "scm5c4_10.htm" + ((filename:substitute?? "??" "beg?mid?end") "AZ") + => "begAmidZend" + ((filename:substitute?? "*na*" "?NA?") "banana") + => "banaNA" + ((filename:substitute?? "?*?" (lambda (s1 s2 s3) (string-append s3 s1))) "ABZ") + => "ZA" + + - Function: replace-suffix STR OLD NEW + STR can be a string or a list of strings. Returns a new string + (or strings) similar to `str' but with the suffix string OLD + removed and the suffix string NEW appended. If the end of STR + does not match OLD, an error is signaled. + + (replace-suffix "/usr/local/lib/slib/batch.scm" ".scm" ".c") + => "/usr/local/lib/slib/batch.c" + + +File: slib.info, Node: Batch, Prev: Filenames, Up: Programs and Arguments + +Batch +----- + + `(require 'batch)' + +The batch procedures provide a way to write and execute portable scripts +for a variety of operating systems. Each `batch:' procedure takes as +its first argument a parameter-list (*note Parameter lists::.). This +parameter-list argument PARMS contains named associations. Batch +currently uses 2 of these: + +`batch-port' + The port on which to write lines of the batch file. + +`batch-dialect' + The syntax of batch file to generate. Currently supported are: + * unix + + * dos + + * vms + + * amigados + + * system + + * *unknown* + +`batch.scm' uses 2 enhanced relational tables (*note Database +Utilities::.) to store information linking the names of +`operating-system's to `batch-dialect'es. + + - Function: batch:initialize! DATABASE + Defines `operating-system' and `batch-dialect' tables and adds the + domain `operating-system' to the enhanced relational database + DATABASE. + + - Variable: batch:platform + Is batch's best guess as to which operating-system it is running + under. `batch:platform' is set to `(software-type)' (*note + Configuration::.) unless `(software-type)' is `unix', in which + case finer distinctions are made. + + - Function: batch:call-with-output-script PARMS FILE PROC + PROC should be a procedure of one argument. If FILE is an + output-port, `batch:call-with-output-script' writes an appropriate + header to FILE and then calls PROC with FILE as the only argument. + If FILE is a string, `batch:call-with-output-script' opens a + output-file of name FILE, writes an appropriate header to FILE, + and then calls PROC with the newly opened port as the only + argument. Otherwise, `batch:call-with-output-script' acts as if + it was called with the result of `(current-output-port)' as its + third argument. + | +The rest of the `batch:' procedures write (or execute if +`batch-dialect' is `system') commands to the batch port which has been +added to PARMS or `(copy-tree PARMS)' by the code: + + (adjoin-parameters! PARMS (list 'batch-port PORT)) + + - Function: batch:command PARMS STRING1 STRING2 ... | + Calls `batch:try-command' (below) with arguments, but signals an | + error if `batch:try-command' returns `#f'. | + +These functions return a non-false value if the command was successfully +translated into the batch dialect and `#f' if not. In the case of the +`system' dialect, the value is non-false if the operation suceeded. + + - Function: batch:try-command PARMS STRING1 STRING2 ... | + Writes a command to the `batch-port' in PARMS which executes the + program named STRING1 with arguments STRING2 .... + + - Function: batch:try-chopped-command PARMS ARG1 ARG2 ... LIST | + breaks the last argument LIST into chunks small enough so that the | + command: | + | + ARG1 ARG2 ... CHUNK | + | + fits withing the platform's maximum command-line length. | + | + `batch:try-chopped-command' calls `batch:try-command' with the | + command and returns non-false only if the commands all fit and | + `batch:try-command' of each command line returned non-false. | + | + - Function: batch:run-script PARMS STRING1 STRING2 ... + Writes a command to the `batch-port' in PARMS which executes the + batch script named STRING1 with arguments STRING2 .... + + *Note:* `batch:run-script' and `batch:try-command' are not the | + same for some operating systems (VMS). | + + - Function: batch:comment PARMS LINE1 ... + Writes comment lines LINE1 ... to the `batch-port' in PARMS. + + - Function: batch:lines->file PARMS FILE LINE1 ... + Writes commands to the `batch-port' in PARMS which create a file + named FILE with contents LINE1 .... + + - Function: batch:delete-file PARMS FILE + Writes a command to the `batch-port' in PARMS which deletes the + file named FILE. + + - Function: batch:rename-file PARMS OLD-NAME NEW-NAME + Writes a command to the `batch-port' in PARMS which renames the + file OLD-NAME to NEW-NAME. + +In addition, batch provides some small utilities very useful for writing +scripts: + + - Function: truncate-up-to PATH CHAR + - Function: truncate-up-to PATH STRING + - Function: truncate-up-to PATH CHARLIST + PATH can be a string or a list of strings. Returns PATH sans any + prefixes ending with a character of the second argument. This can + be used to derive a filename moved locally from elsewhere. + + (truncate-up-to "/usr/local/lib/slib/batch.scm" "/") + => "batch.scm" + + - Function: string-join JOINER STRING1 ... + Returns a new string consisting of all the strings STRING1 ... in + order appended together with the string JOINER between each + adjacent pair. + + - Function: must-be-first LIST1 LIST2 + Returns a new list consisting of the elements of LIST2 ordered so + that if some elements of LIST1 are `equal?' to elements of LIST2, + then those elements will appear first and in the order of LIST1. + + - Function: must-be-last LIST1 LIST2 + Returns a new list consisting of the elements of LIST1 ordered so + that if some elements of LIST2 are `equal?' to elements of LIST1, + then those elements will appear last and in the order of LIST2. + + - Function: os->batch-dialect OSNAME + Returns its best guess for the `batch-dialect' to be used for the + operating-system named OSNAME. `os->batch-dialect' uses the + tables added to DATABASE by `batch:initialize!'. + +Here is an example of the use of most of batch's procedures: + + (require 'database-utilities) + (require 'parameters) + (require 'batch) + (require 'glob) + + (define batch (create-database #f 'alist-table)) + (batch:initialize! batch) + + (define my-parameters + (list (list 'batch-dialect (os->batch-dialect batch:platform)) + (list 'platform batch:platform) + (list 'batch-port (current-output-port)))) ;gets filled in later + + (batch:call-with-output-script + my-parameters + "my-batch" + (lambda (batch-port) + (adjoin-parameters! my-parameters (list 'batch-port batch-port)) + (and + (batch:comment my-parameters + "================ Write file with C program.") + (batch:rename-file my-parameters "hello.c" "hello.c~") + (batch:lines->file my-parameters "hello.c" + "#include <stdio.h>" + "int main(int argc, char **argv)" + "{" + " printf(\"hello world\\n\");" + " return 0;" + "}" ) + (batch:command my-parameters "cc" "-c" "hello.c") | + (batch:command my-parameters "cc" "-o" "hello" | + (replace-suffix "hello.c" ".c" ".o")) + (batch:command my-parameters "hello") | + (batch:delete-file my-parameters "hello") + (batch:delete-file my-parameters "hello.c") + (batch:delete-file my-parameters "hello.o") + (batch:delete-file my-parameters "my-batch") + ))) + +Produces the file `my-batch': + + #!/bin/sh + # "my-batch" script created by SLIB/batch Sun Oct 31 18:24:10 1999 | + # ================ Write file with C program. + mv -f hello.c hello.c~ + rm -f hello.c + echo '#include <stdio.h>'>>hello.c + echo 'int main(int argc, char **argv)'>>hello.c + echo '{'>>hello.c + echo ' printf("hello world\n");'>>hello.c + echo ' return 0;'>>hello.c + echo '}'>>hello.c + cc -c hello.c + cc -o hello hello.o + hello + rm -f hello + rm -f hello.c + rm -f hello.o + rm -f my-batch + +When run, `my-batch' prints: + + bash$ my-batch + mv: hello.c: No such file or directory + hello world + + +File: slib.info, Node: HTML HTTP and CGI, Next: Printing Scheme, Prev: Programs and Arguments, Up: Textual Conversion Packages + +HTML Forms +========== + + `(require 'html-form)' + + - Variable: *html:output-port* + Procedure names starting with `html:' send their output to the + port *HTML:OUTPUT-PORT*. *HTML:OUTPUT-PORT* is initially the + current output port. + + - Function: make-atval TXT + Returns a string with character substitutions appropriate to send + TXT as an "attribute-value". + + - Function: make-plain TXT + Returns a string with character substitutions appropriate to send + TXT as an "plain-text". + + - Function: html:start-page TITLE BACKLINK TAGS ... + - Function: html:start-page TITLE BACKLINK + - Function: html:start-page TITLE + Outputs headers for an HTML page named TITLE. If string arguments + BACKLINK ... are supplied they are printed verbatim within the + <HEAD> section. + + - Function: html:end-page + Outputs HTML codes to end a page. + + - Function: html:pre LINE1 LINE ... + Writes (using `html:printf') the strings LINE1, LINES as + "PRE"formmated plain text (rendered in fixed-width font). + Newlines are inserted between LINE1, LINES. HTML tags (`<tag>') + within LINES will be visible verbatim. + + - Function: html:comment LINE1 LINE ... + Writes (using `html:printf') the strings LINE1 as HTML comments. + +HTML Tables +=========== + + - Function: html:start-table CAPTION + + - Function: html:end-table + + - Function: html:heading COLUMNS + Outputs a heading row for the currently-started table. + + - Function: html:href-heading COLUMNS URLS + Outputs a heading row with column-names COLUMNS linked to URLs + URLS. + + - Function: make-row-converter K FOREIGNS + The positive integer K is the primary-key-limit (number of + primary-keys) of the table. FOREIGNS is a list of the filenames of + foreign-key field pages and #f for non foreign-key fields. + + `make-row-converter' returns a procedure taking a row for its + single argument. This returned procedure prints the table row to + *HTML:OUTPUT-PORT*. + + - Function: table-name->filename TABLE-NAME + Returns the symbol TABLE-NAME converted to a filename. + + - Function: table->html CAPTION DB TABLE-NAME MATCH-KEY1 ... + Writes HTML for DB table TABLE-NAME to *HTML:OUTPUT-PORT*. + + The optional MATCH-KEY1 ... arguments restrict actions to a subset + of the table. *Note match-key: Table Operations. + + - Function: table->page DB TABLE-NAME INDEX-FILENAME + Writes a complete HTML page to *HTML:OUTPUT-PORT*. The string + INDEX-FILENAME names the page which refers to this one. + + - Function: catalog->html DB CAPTION + Writes HTML for the catalog table of DB to *HTML:OUTPUT-PORT*. + + - Function: catalog->page DB CAPTION + Writes a complete HTML page for the catalog of DB to + *HTML:OUTPUT-PORT*. + +HTML Forms +========== + + - Function: html:start-form METHOD ACTION + The symbol METHOD is either `get', `head', `post', `put', or + `delete'. `html:start-form' prints the header for an HTML "form". + + - Function: html:end-form PNAME SUBMIT-LABEL + `html:end-form' prints the footer for an HTML "form". The string + SUBMIT-LABEL appears on the button which submits the form. + + - Function: command->html RDB COMMAND-TABLE COMMAND METHOD ACTION + The symbol COMMAND-TABLE names a command table in the RDB + relational database. + + `command->html' writes an HTML-2.0 "form" for command COMMAND to + the current-output-port. The `SUBMIT' button, which is labeled + COMMAND, invokes the URI ACTION with method METHOD with a hidden + attribute `*command*' bound to the command symbol submitted. + + An action may invoke a CGI script + (`http://www.my-site.edu/cgi-bin/search.cgi') or HTTP daemon + (`http://www.my-site.edu:8001'). + + This example demonstrates how to create a HTML-form for the `build' + command. + + (require (in-vicinity (implementation-vicinity) "build.scm")) + (call-with-output-file "buildscm.html" + (lambda (port) + (fluid-let ((*html:output-port* port)) + (html:start-page 'commands) + (command->html + build '*commands* 'build 'post + (or "/cgi-bin/build.cgi" + "http://localhost:8081/buildscm")) + html:end-page))) + +HTTP and CGI service +==================== + + `(require 'html-form)' + + - Function: cgi:serve-command RDB COMMAND-TABLE + Reads a `"POST"' or `"GET"' query from `(current-input-port)' and + executes the encoded command from COMMAND-TABLE in + relational-database RDB. + + This example puts up a plain-text page in response to a CGI query. + + (display "Content-Type: text/plain") (newline) (newline) + (require 'html-form) + (load (in-vicinity (implementation-vicinity) "build.scm")) + (cgi:serve-command build '*commands*) + + - Function: serve-urlencoded-command RDB COMMAND-TABLE URLENCODED + Reads attribute-value pairs from URLENCODED, converts them to + parameters and invokes the RDB command named by the parameter + `*command*'. + + - Function: http:serve-query INPUT-PORT OUTPUT-PORT SERVE-PROC + reads the "query-string" from INPUT-PORT. If this is a valid + `"POST"' or `"GET"' query, then `http:serve-query' calls + SERVE-PROC with two arguments, the query-string and the + header-alist. + + Otherwise, `http:serve-query' replies (to OUTPUT-PORT) with + appropriate HTML describing the problem. + + This example services HTTP queries from port 8081: + + (define socket (make-stream-socket AF_INET 0)) + (socket:bind socket 8081) + (socket:listen socket 10) + (dynamic-wind + (lambda () #f) + (lambda () + (do ((port (socket:accept socket) + (socket:accept socket))) + (#f) + (dynamic-wind + (lambda () #f) + (lambda () + (fluid-let ((*html:output-port* port)) + (http:serve-query + port port + (lambda (query-string header) + (http:send-header + '(("Content-Type" . "text/plain"))) + (with-output-to-port port + (lambda () + (serve-urlencoded-command + build '*commands* query-string))))))) + (lambda () (close-port port))))) + (lambda () (close-port socket))) + + - Function: http:read-request-line PORT + Reads the first non-blank line from PORT and, if successful, + returns a list of three itmes from the request-line: + + 0. Method + + Either one of the symbols `options', `get', `head', `post', + `put', `delete', or `trace'; Or a string. + + 1. Request-URI + + A string. At the minimum, it will be the string `"/"'. + + 2. HTTP-Version + + A string. For example, `HTTP/1.0'. + + - Function: cgi:read-query-string + Reads the "query-string" from `(current-input-port)'. + `cgi:read-query-string' reads a `"POST"' or `"GET"' queries, + depending on the value of `(getenv "REQUEST_METHOD")'. + + +File: slib.info, Node: Printing Scheme, Next: Time and Date, Prev: HTML HTTP and CGI, Up: Textual Conversion Packages + +Printing Scheme +=============== + +* Menu: + +* Generic-Write:: 'generic-write +* Object-To-String:: 'object->string +* Pretty-Print:: 'pretty-print, 'pprint-file + + +File: slib.info, Node: Generic-Write, Next: Object-To-String, Prev: Printing Scheme, Up: Printing Scheme + +Generic-Write +------------- + + `(require 'generic-write)' + + `generic-write' is a procedure that transforms a Scheme data value +(or Scheme program expression) into its textual representation and +prints it. The interface to the procedure is sufficiently general to +easily implement other useful formatting procedures such as pretty +printing, output to a string and truncated output. + + - Procedure: generic-write OBJ DISPLAY? WIDTH OUTPUT + OBJ + Scheme data value to transform. + + DISPLAY? + Boolean, controls whether characters and strings are quoted. + + WIDTH + Extended boolean, selects format: + #f + single line format + + integer > 0 + pretty-print (value = max nb of chars per line) + + OUTPUT + Procedure of 1 argument of string type, called repeatedly with + successive substrings of the textual representation. This + procedure can return `#f' to stop the transformation. + + The value returned by `generic-write' is undefined. + + Examples: + (write obj) == (generic-write obj #f #f DISPLAY-STRING) + (display obj) == (generic-write obj #t #f DISPLAY-STRING) + + where + DISPLAY-STRING == + (lambda (s) (for-each write-char (string->list s)) #t) + + +File: slib.info, Node: Object-To-String, Next: Pretty-Print, Prev: Generic-Write, Up: Printing Scheme + +Object-To-String +---------------- + + `(require 'object->string)' + + - Function: object->string OBJ + Returns the textual representation of OBJ as a string. + + - Function: object->limited-string OBJ LIMIT + Returns the textual representation of OBJ as a string of length at + most LIMIT. + + +File: slib.info, Node: Pretty-Print, Prev: Object-To-String, Up: Printing Scheme + +Pretty-Print +------------ + + `(require 'pretty-print)' + + - Procedure: pretty-print OBJ + - Procedure: pretty-print OBJ PORT + `pretty-print's OBJ on PORT. If PORT is not specified, + `current-output-port' is used. + + Example: + (pretty-print '((1 2 3 4 5) (6 7 8 9 10) (11 12 13 14 15) + (16 17 18 19 20) (21 22 23 24 25))) + -| ((1 2 3 4 5) + -| (6 7 8 9 10) + -| (11 12 13 14 15) + -| (16 17 18 19 20) + -| (21 22 23 24 25)) + + `(require 'pprint-file)' + + - Procedure: pprint-file INFILE + - Procedure: pprint-file INFILE OUTFILE + Pretty-prints all the code in INFILE. If OUTFILE is specified, + the output goes to OUTFILE, otherwise it goes to + `(current-output-port)'. + + - Function: pprint-filter-file INFILE PROC OUTFILE + - Function: pprint-filter-file INFILE PROC + INFILE is a port or a string naming an existing file. Scheme + source code expressions and definitions are read from the port (or + file) and PROC is applied to them sequentially. + + OUTFILE is a port or a string. If no OUTFILE is specified then + `current-output-port' is assumed. These expanded expressions are + then `pretty-print'ed to this port. + + Whitepsace and comments (introduced by `;') which are not part of + scheme expressions are reproduced in the output. This procedure + does not affect the values returned by `current-input-port' and + `current-output-port'. + + `pprint-filter-file' can be used to pre-compile macro-expansion and +thus can reduce loading time. The following will write into +`exp-code.scm' the result of expanding all defmacros in `code.scm'. + (require 'pprint-file) + (require 'defmacroexpand) + (defmacro:load "my-macros.scm") + (pprint-filter-file "code.scm" defmacro:expand* "exp-code.scm") + + +File: slib.info, Node: Time and Date, Next: Vector Graphics, Prev: Printing Scheme, Up: Textual Conversion Packages + +Time and Date +============= + +* Menu: + +* Time Zone:: +* Posix Time:: 'posix-time +* Common-Lisp Time:: 'common-lisp-time + +If `(provided? 'current-time)': + +The procedures `current-time', `difftime', and `offset-time' deal with +a "calendar time" datatype which may or may not be disjoint from other +Scheme datatypes. + + - Function: current-time + Returns the time since 00:00:00 GMT, January 1, 1970, measured in + seconds. Note that the reference time is different from the + reference time for `get-universal-time' in *Note Common-Lisp + Time::. + + - Function: difftime CALTIME1 CALTIME0 + Returns the difference (number of seconds) between twe calendar + times: CALTIME1 - CALTIME0. CALTIME0 may also be a number. + + - Function: offset-time CALTIME OFFSET + Returns the calendar time of CALTIME offset by OFFSET number of + seconds `(+ caltime offset)'. + + +File: slib.info, Node: Time Zone, Next: Posix Time, Prev: Time and Date, Up: Time and Date + +Time Zone +--------- + + (require 'time-zone) + + - Data Format: TZ-string + POSIX standards specify several formats for encoding time-zone + rules. + + :<pathname> + If the first character of <pathname> is `/', then <pathname> + specifies the absolute pathname of a tzfile(5) format + time-zone file. Otherwise, <pathname> is interpreted as a + pathname within TZFILE:VICINITY (/usr/lib/zoneinfo/) naming a + tzfile(5) format time-zone file. + + <std><offset> + The string <std> consists of 3 or more alphabetic characters. + <offset> specifies the time difference from GMT. The <offset> + is positive if the local time zone is west of the Prime + Meridian and negative if it is east. <offset> can be the + number of hours or hours and minutes (and optionally seconds) + separated by `:'. For example, `-4:30'. + + <std><offset><dst> + <dst> is the at least 3 alphabetic characters naming the local + daylight-savings-time. + + <std><offset><dst><doffset> + <doffset> specifies the offset from the Prime Meridian when + daylight-savings-time is in effect. + + The non-tzfile formats can optionally be followed by transition + times specifying the day and time when a zone changes from + standard to daylight-savings and back again. + + ,<date>/<time>,<date>/<time> + The <time>s are specified like the <offset>s above, except + that leading `+' and `-' are not allowed. + + Each <date> has one of the formats: + + J<day> + specifies the Julian day with <day> between 1 and 365. + February 29 is never counted and cannot be referenced. + + <day> + This specifies the Julian day with n between 0 and 365. + February 29 is counted in leap years and can be + specified. + + M<month>.<week>.<day> + This specifies day <day> (0 <= <day> <= 6) of week + <week> (1 <= <week> <= 5) of month <month> (1 <= <month> + <= 12). Week 1 is the first week in which day d occurs + and week 5 is the last week in which day <day> occurs. + Day 0 is a Sunday. + + + - Data Type: time-zone + is a datatype encoding how many hours from Greenwich Mean Time the + local time is, and the "Daylight Savings Time" rules for changing + it. + + - Function: time-zone TZ-STRING + Creates and returns a time-zone object specified by the string + TZ-STRING. If `time-zone' cannot interpret TZ-STRING, `#f' is + returned. + + - Function: tz:params CALTIME TZ + TZ is a time-zone object. `tz:params' returns a list of three + items: + 0. An integer. 0 if standard time is in effect for timezone TZ + at CALTIME; 1 if daylight savings time is in effect for + timezone TZ at CALTIME. + + 1. The number of seconds west of the Prime Meridian timezone TZ + is at CALTIME. + + 2. The name for timezone TZ at CALTIME. + + `tz:params' is unaffected by the default timezone; inquiries can be + made of any timezone at any calendar time. + + +The rest of these procedures and variables are provided for POSIX +compatability. Because of shared state they are not thread-safe. + + - Function: tzset + Returns the default time-zone. + + - Function: tzset TZ + Sets (and returns) the default time-zone to TZ. + + - Function: tzset TZ-STRING + Sets (and returns) the default time-zone to that specified by + TZ-STRING. + + `tzset' also sets the variables *TIMEZONE*, DAYLIGHT?, and TZNAME. + This function is automatically called by the time conversion + procedures which depend on the time zone (*note Time and Date::.). + + - Variable: *timezone* + Contains the difference, in seconds, between Greenwich Mean Time + and local standard time (for example, in the U.S. Eastern time + zone (EST), timezone is 5*60*60). `*timezone*' is initialized by + `tzset'. + + - Variable: daylight? + is `#t' if the default timezone has rules for "Daylight Savings + Time". *Note:* DAYLIGHT? does not tell you when Daylight Savings + Time is in effect, just that the default zone sometimes has + Daylight Savings Time. + + - Variable: tzname + is a vector of strings. Index 0 has the abbreviation for the + standard timezone; If DAYLIGHT?, then index 1 has the abbreviation + for the Daylight Savings timezone. + + +File: slib.info, Node: Posix Time, Next: Common-Lisp Time, Prev: Time Zone, Up: Time and Date + +Posix Time +---------- + + (require 'posix-time) + + - Data Type: Calendar-Time + is a datatype encapsulating time. + + - Data Type: Coordinated Universal Time + (abbreviated "UTC") is a vector of integers representing time: + + 0. seconds (0 - 61) + + 1. minutes (0 - 59) + + 2. hours since midnight (0 - 23) + + 3. day of month (1 - 31) + + 4. month (0 - 11). Note difference from + `decode-universal-time'. + + 5. the number of years since 1900. Note difference from + `decode-universal-time'. + + 6. day of week (0 - 6) + + 7. day of year (0 - 365) + + 8. 1 for daylight savings, 0 for regular time + + - Function: gmtime CALTIME + Converts the calendar time CALTIME to UTC and returns it. + + - Function: localtime CALTIME TZ + Returns CALTIME converted to UTC relative to timezone TZ. + + - Function: localtime CALTIME + converts the calendar time CALTIME to a vector of integers + expressed relative to the user's time zone. `localtime' sets the + variable *TIMEZONE* with the difference between Coordinated + Universal Time (UTC) and local standard time in seconds (*note + tzset: Time Zone.). + + + - Function: gmktime UNIVTIME + Converts a vector of integers in GMT Coordinated Universal Time + (UTC) format to a calendar time. + + - Function: mktime UNIVTIME + Converts a vector of integers in local Coordinated Universal Time + (UTC) format to a calendar time. + + - Function: mktime UNIVTIME TZ + Converts a vector of integers in Coordinated Universal Time (UTC) + format (relative to time-zone TZ) to calendar time. + + - Function: asctime UNIVTIME + Converts the vector of integers CALTIME in Coordinated Universal + Time (UTC) format into a string of the form `"Wed Jun 30 21:49:08 + 1993"'. + + - Function: gtime CALTIME + - Function: ctime CALTIME + - Function: ctime CALTIME TZ + Equivalent to `(asctime (gmtime CALTIME))', `(asctime (localtime + CALTIME))', and `(asctime (localtime CALTIME TZ))', respectively. + + +File: slib.info, Node: Common-Lisp Time, Prev: Posix Time, Up: Time and Date + +Common-Lisp Time +---------------- + + - Function: get-decoded-time + Equivalent to `(decode-universal-time (get-universal-time))'. + + - Function: get-universal-time + Returns the current time as "Universal Time", number of seconds + since 00:00:00 Jan 1, 1900 GMT. Note that the reference time is + different from `current-time'. + + - Function: decode-universal-time UNIVTIME + Converts UNIVTIME to "Decoded Time" format. Nine values are + returned: + 0. seconds (0 - 61) + + 1. minutes (0 - 59) + + 2. hours since midnight + + 3. day of month + + 4. month (1 - 12). Note difference from `gmtime' and + `localtime'. + + 5. year (A.D.). Note difference from `gmtime' and `localtime'. + + 6. day of week (0 - 6) + + 7. #t for daylight savings, #f otherwise + + 8. hours west of GMT (-24 - +24) + + Notice that the values returned by `decode-universal-time' do not + match the arguments to `encode-universal-time'. + + - Function: encode-universal-time SECOND MINUTE HOUR DATE MONTH YEAR + - Function: encode-universal-time SECOND MINUTE HOUR DATE MONTH YEAR + TIME-ZONE + Converts the arguments in Decoded Time format to Universal Time + format. If TIME-ZONE is not specified, the returned time is + adjusted for daylight saving time. Otherwise, no adjustment is + performed. + + Notice that the values returned by `decode-universal-time' do not + match the arguments to `encode-universal-time'. + + +File: slib.info, Node: Vector Graphics, Next: Schmooz, Prev: Time and Date, Up: Textual Conversion Packages + +Vector Graphics +=============== + +* Menu: + +* Tektronix Graphics Support:: + + +File: slib.info, Node: Tektronix Graphics Support, Prev: Vector Graphics, Up: Vector Graphics + +Tektronix Graphics Support +-------------------------- + + *Note:* The Tektronix graphics support files need more work, and are +not complete. + +Tektronix 4000 Series Graphics +.............................. + + The Tektronix 4000 series graphics protocol gives the user a 1024 by +1024 square drawing area. The origin is in the lower left corner of the +screen. Increasing y is up and increasing x is to the right. + + The graphics control codes are sent over the current-output-port and +can be mixed with regular text and ANSI or other terminal control +sequences. + + - Procedure: tek40:init + + - Procedure: tek40:graphics + + - Procedure: tek40:text + + - Procedure: tek40:linetype LINETYPE + + - Procedure: tek40:move X Y + + - Procedure: tek40:draw X Y + + - Procedure: tek40:put-text X Y STR + + - Procedure: tek40:reset + +Tektronix 4100 Series Graphics +.............................. + + The graphics control codes are sent over the current-output-port and +can be mixed with regular text and ANSI or other terminal control +sequences. + + - Procedure: tek41:init + + - Procedure: tek41:reset + + - Procedure: tek41:graphics + + - Procedure: tek41:move X Y + + - Procedure: tek41:draw X Y + + - Procedure: tek41:point X Y NUMBER + + - Procedure: tek41:encode-x-y X Y + + - Procedure: tek41:encode-int NUMBER + + +File: slib.info, Node: Schmooz, Prev: Vector Graphics, Up: Textual Conversion Packages + +Schmooz +======= + + "Schmooz" is a simple, lightweight markup language for interspersing +Texinfo documentation with Scheme source code. Schmooz does not create +the top level Texinfo file; it creates `txi' files which can be +imported into the documentation using the Texinfo command `@include'. + + `(require 'schmooz)' defines the function `schmooz', which is used to +process files. Files containing schmooz documentation should not +contain `(require 'schmooz)'. + + - Procedure: schmooz FILENAMEscm ... + FILENAMEscm should be a string ending with `scm' naming an + existing file containing Scheme source code. `schmooz' extracts + top-level comments containing schmooz commands from FILENAMEscm + and writes the converted Texinfo source to a file named + FILENAMEtxi. + + - Procedure: schmooz FILENAMEtexi ... + - Procedure: schmooz FILENAMEtex ... + - Procedure: schmooz FILENAMEtxi ... + FILENAME should be a string naming an existing file containing + Texinfo source code. For every occurrence of the string `@include + FILENAMEtxi' within that file, `schmooz' calls itself with the + argument `FILENAMEscm'. + + Schmooz comments are distinguished (from non-schmooz comments) by +their first line, which must start with an at-sign (@) preceded by one +or more semicolons (;). A schmooz comment ends at the first subsequent +line which does *not* start with a semicolon. Currently schmooz +comments are recognized only at top level. + + Schmooz comments are copied to the Texinfo output file with the +leading contiguous semicolons removed. Certain character sequences +starting with at-sign are treated specially. Others are copied +unchanged. + + A schmooz comment starting with `@body' must be followed by a Scheme +definition. All comments between the `@body' line and the definition +will be included in a Texinfo definition, either a `@defun' or a +`@defvar', depending on whether a procedure or a variable is being +defined. + + Within the text of that schmooz comment, at-sign followed by `0' will +be replaced by `@code{procedure-name}' if the following definition is +of a procedure; or `@var{variable}' if defining a variable. + + An at-sign followed by a non-zero digit will expand to the variable +citation of that numbered argument: `@var{argument-name}'. + + If more than one definition follows a `@body' comment line without an +intervening blank or comment line, then those definitions will be +included in the same Texinfo definition using `@defvarx' or `@defunx', +depending on whether the first definition is of a variable or of a +procedure. + + Schmooz can figure out whether a definition is of a procedure if it +is of the form: + + `(define (<identifier> <arg> ...) <expression>)' + +or if the left hand side of the definition is some form ending in a +lambda expression. Obviously, it can be fooled. In order to force +recognition of a procedure definition, start the documentation with +`@args' instead of `@body'. `@args' should be followed by the argument +list of the function being defined, which may be enclosed in +parentheses and delimited by whitespace, (as in Scheme), enclosed in +braces and separated by commas, (as in Texinfo), or consist of the +remainder of the line, separated by whitespace. + + For example: + + ;;@args arg1 args ... + ;;@0 takes argument @1 and any number of @2 + (define myfun (some-function-returning-magic)) + + Will result in: + + @defun myfun arg1 args @dots{} + + @code{myfun} takes argument @var{arg1} and any number of @var{args} + @end defun + + `@args' may also be useful for indicating optional arguments by name. +If `@args' occurs inside a schmooz comment section, rather than at the +beginning, then it will generate a `@defunx' line with the arguments +supplied. + + If the first at-sign in a schmooz comment is immediately followed by +whitespace, then the comment will be expanded to whatever follows that +whitespace. If the at-sign is followed by a non-whitespace character +then the at-sign will be included as the first character of the +expansion. This feature is intended to make it easy to include Texinfo +directives in schmooz comments. + + +File: slib.info, Node: Mathematical Packages, Next: Database Packages, Prev: Textual Conversion Packages, Up: Top + +Mathematical Packages +********************* + +* Menu: + +* Bit-Twiddling:: 'logical +* Modular Arithmetic:: 'modular +* Prime Numbers:: 'factor +* Random Numbers:: 'random +* Fast Fourier Transform:: 'fft +* Cyclic Checksum:: 'make-crc +* Plotting:: 'charplot +* Root Finding:: 'root +* Commutative Rings:: 'commutative-ring +* Determinant:: 'determinant + + +File: slib.info, Node: Bit-Twiddling, Next: Modular Arithmetic, Prev: Mathematical Packages, Up: Mathematical Packages + +Bit-Twiddling +============= + + `(require 'logical)' + + The bit-twiddling functions are made available through the use of the +`logical' package. `logical' is loaded by inserting `(require +'logical)' before the code that uses these functions. These functions +behave as though operating on integers in two's-complement +representation. + +Bitwise Operations +------------------ + + - Function: logand N1 N1 + Returns the integer which is the bit-wise AND of the two integer + arguments. + + Example: + (number->string (logand #b1100 #b1010) 2) + => "1000" + + - Function: logior N1 N2 + Returns the integer which is the bit-wise OR of the two integer + arguments. + + Example: + (number->string (logior #b1100 #b1010) 2) + => "1110" + + - Function: logxor N1 N2 + Returns the integer which is the bit-wise XOR of the two integer + arguments. + + Example: + (number->string (logxor #b1100 #b1010) 2) + => "110" + + - Function: lognot N + Returns the integer which is the 2s-complement of the integer + argument. + + Example: + (number->string (lognot #b10000000) 2) + => "-10000001" + (number->string (lognot #b0) 2) + => "-1" + + - Function: bitwise-if MASK N0 N1 + Returns an integer composed of some bits from integer N0 and some + from integer N1. A bit of the result is taken from N0 if the + corresponding bit of integer MASK is 1 and from N1 if that bit of + MASK is 0. + + - Function: logtest J K + (logtest j k) == (not (zero? (logand j k))) + + (logtest #b0100 #b1011) => #f + (logtest #b0100 #b0111) => #t + + - Function: logcount N + Returns the number of bits in integer N. If integer is positive, + the 1-bits in its binary representation are counted. If negative, + the 0-bits in its two's-complement binary representation are + counted. If 0, 0 is returned. + + Example: + (logcount #b10101010) + => 4 + (logcount 0) + => 0 + (logcount -2) + => 1 + +Bit Within Word +--------------- + + - Function: logbit? INDEX J + (logbit? index j) == (logtest (integer-expt 2 index) j) + + (logbit? 0 #b1101) => #t + (logbit? 1 #b1101) => #f + (logbit? 2 #b1101) => #t + (logbit? 3 #b1101) => #t + (logbit? 4 #b1101) => #f + + - Function: copy-bit INDEX FROM BIT + Returns an integer the same as FROM except in the INDEXth bit, + which is 1 if BIT is `#t' and 0 if BIT is `#f'. + + Example: + (number->string (copy-bit 0 0 #t) 2) => "1" + (number->string (copy-bit 2 0 #t) 2) => "100" + (number->string (copy-bit 2 #b1111 #f) 2) => "1011" + +Fields of Bits +-------------- + + - Function: bit-field N START END + Returns the integer composed of the START (inclusive) through END + (exclusive) bits of N. The STARTth bit becomes the 0-th bit in + the result. + + This function was called `bit-extract' in previous versions of + SLIB. + + Example: + (number->string (bit-field #b1101101010 0 4) 2) + => "1010" + (number->string (bit-field #b1101101010 4 9) 2) + => "10110" + + - Function: copy-bit-field TO START END FROM + Returns an integer the same as TO except possibly in the START + (inclusive) through END (exclusive) bits, which are the same as + those of FROM. The 0-th bit of FROM becomes the STARTth bit of + the result. + + Example: + (number->string (copy-bit-field #b1101101010 0 4 0) 2) + => "1101100000" + (number->string (copy-bit-field #b1101101010 0 4 -1) 2) + => "1101101111" + + - Function: ash INT COUNT + Returns an integer equivalent to `(inexact->exact (floor (* INT + (expt 2 COUNT))))'. + + Example: + (number->string (ash #b1 3) 2) + => "1000" + (number->string (ash #b1010 -1) 2) + => "101" + + - Function: integer-length N + Returns the number of bits neccessary to represent N. + + Example: + (integer-length #b10101010) + => 8 + (integer-length 0) + => 0 + (integer-length #b1111) + => 4 + + - Function: integer-expt N K + Returns N raised to the non-negative integer exponent K. + + Example: + (integer-expt 2 5) + => 32 + (integer-expt -3 3) + => -27 + + +File: slib.info, Node: Modular Arithmetic, Next: Prime Numbers, Prev: Bit-Twiddling, Up: Mathematical Packages + +Modular Arithmetic +================== + + `(require 'modular)' + + - Function: extended-euclid N1 N2 + Returns a list of 3 integers `(d x y)' such that d = gcd(N1, N2) = + N1 * x + N2 * y. + + - Function: symmetric:modulus N + Returns `(quotient (+ -1 n) -2)' for positive odd integer N. + + - Function: modulus->integer MODULUS + Returns the non-negative integer characteristic of the ring formed + when MODULUS is used with `modular:' procedures. + + - Function: modular:normalize MODULUS N + Returns the integer `(modulo N (modulus->integer MODULUS))' in the + representation specified by MODULUS. + +The rest of these functions assume normalized arguments; That is, the +arguments are constrained by the following table: + +For all of these functions, if the first argument (MODULUS) is: +`positive?' + Work as before. The result is between 0 and MODULUS. + +`zero?' + The arguments are treated as integers. An integer is returned. + +`negative?' + The arguments and result are treated as members of the integers + modulo `(+ 1 (* -2 MODULUS))', but with "symmetric" + representation; i.e. `(<= (- MODULUS) N MODULUS)'. + +If all the arguments are fixnums the computation will use only fixnums. + + - Function: modular:invertable? MODULUS K + Returns `#t' if there exists an integer n such that K * n == 1 mod + MODULUS, and `#f' otherwise. + + - Function: modular:invert MODULUS K2 + Returns an integer n such that 1 = (n * K2) mod MODULUS. If K2 + has no inverse mod MODULUS an error is signaled. + + - Function: modular:negate MODULUS K2 + Returns (-K2) mod MODULUS. + + - Function: modular:+ MODULUS K2 K3 + Returns (K2 + K3) mod MODULUS. + + - Function: modular:- MODULUS K2 K3 + Returns (K2 - K3) mod MODULUS. + + - Function: modular:* MODULUS K2 K3 + Returns (K2 * K3) mod MODULUS. + + The Scheme code for `modular:*' with negative MODULUS is not + completed for fixnum-only implementations. + + - Function: modular:expt MODULUS K2 K3 + Returns (K2 ^ K3) mod MODULUS. + + +File: slib.info, Node: Prime Numbers, Next: Random Numbers, Prev: Modular Arithmetic, Up: Mathematical Packages + +Prime Numbers +============= + + `(require 'factor)' + + - Variable: prime:prngs + PRIME:PRNGS is the random-state (*note Random Numbers::.) used by + these procedures. If you call these procedures from more than one | + thread (or from interrupt), `random' may complain about reentrant | + calls. | + | + *Note:* The prime test and generation procedures implement (or use) | +the Solovay-Strassen primality test. See | + | + * Robert Solovay and Volker Strassen, `A Fast Monte-Carlo Test for | + Primality', SIAM Journal on Computing, 1977, pp 84-85. | + + - Function: jacobi-symbol P Q + Returns the value (+1, -1, or 0) of the Jacobi-Symbol of exact + non-negative integer P and exact positive odd integer Q. + + - Variable: prime:trials + PRIME:TRIALS the maxinum number of iterations of Solovay-Strassen + that will be done to test a number for primality. + + - Function: prime? N + Returns `#f' if N is composite; `#t' if N is prime. There is a + slight chance `(expt 2 (- prime:trials))' that a composite will + return `#t'. + + - Function: primes< START COUNT + Returns a list of the first COUNT prime numbers less than START. + If there are fewer than COUNT prime numbers less than START, then + the returned list will have fewer than START elements. + + - Function: primes> START COUNT + Returns a list of the first COUNT prime numbers greater than START. + + - Function: factor K + Returns a list of the prime factors of K. The order of the + factors is unspecified. In order to obtain a sorted list do + `(sort! (factor K) <)'. + + +File: slib.info, Node: Random Numbers, Next: Fast Fourier Transform, Prev: Prime Numbers, Up: Mathematical Packages + +Random Numbers +============== + + `(require 'random)' + + A pseudo-random number generator is only as good as the tests it +passes. George Marsaglia of Florida State University developed a +battery of tests named "DIEHARD" +(`http://stat.fsu.edu/~geo/diehard.html'). `diehard.c' has a bug which +the patch | +`http://swissnet.ai.mit.edu/ftpdir/users/jaffer/diehard.c.pat' corrects. | + + SLIB's new PRNG generates 8 bits at a time. With the degenerate seed +`0', the numbers generated pass DIEHARD; but when bits are combined +from sequential bytes, tests fail. With the seed +`http://swissnet.ai.mit.edu/~jaffer/SLIB.html', all of those tests pass. + + - Function: random N + - Function: random N STATE + Accepts a positive integer or real N and returns a number of the + same type between zero (inclusive) and N (exclusive). The values + returned by `random' are uniformly distributed from 0 to N. + + The optional argument STATE must be of the type returned by + `(seed->random-state)' or `(make-random-state)'. It defaults to + the value of the variable `*random-state*'. This object is used + to maintain the state of the pseudo-random-number generator and is + altered as a side effect of calls to `random'. + + - Variable: *random-state* + Holds a data structure that encodes the internal state of the + random-number generator that `random' uses by default. The nature + of this data structure is implementation-dependent. It may be + printed out and successfully read back in, but may or may not + function correctly as a random-number state object in another + implementation. + + - Function: copy-random-state STATE + Returns a new copy of argument STATE. + + - Function: copy-random-state + Returns a new copy of `*random-state*'. + + - Function: seed->random-state SEED + Returns a new object of type suitable for use as the value of the + variable `*random-state*' or as a second argument to `random'. + The number or string SEED is used to initialize the state. If + `seed->random-state' is called twice with arguments which are + `equal?', then the returned data structures will be `equal?'. + Calling `seed->random-state' with unequal arguments will nearly + always return unequal states. + + - Function: make-random-state + - Function: make-random-state OBJ + Returns a new object of type suitable for use as the value of the + variable `*random-state*' or as a second argument to `random'. If + the optional argument OBJ is given, it should be a printable + Scheme object; the first 50 characters of its printed + representation will be used as the seed. Otherwise the value of + `*random-state*' is used as the seed. + + If inexact numbers are supported by the Scheme implementation, +`randinex.scm' will be loaded as well. `randinex.scm' contains +procedures for generating inexact distributions. + + - Function: random:uniform + - Function: random:uniform STATE + Returns an uniformly distributed inexact real random number in the + range between 0 and 1. + + - Function: random:exp + - Function: random:exp STATE + Returns an inexact real in an exponential distribution with mean + 1. For an exponential distribution with mean U use + `(* U (random:exp))'. + + - Function: random:normal + - Function: random:normal STATE + Returns an inexact real in a normal distribution with mean 0 and + standard deviation 1. For a normal distribution with mean M and + standard deviation D use `(+ M (* D (random:normal)))'. + + - Function: random:normal-vector! VECT + - Function: random:normal-vector! VECT STATE + Fills VECT with inexact real random numbers which are independent + and standard normally distributed (i.e., with mean 0 and variance + 1). + + - Function: random:hollow-sphere! VECT + - Function: random:hollow-sphere! VECT STATE + Fills VECT with inexact real random numbers the sum of whose + squares is less than 1.0. Thinking of VECT as coordinates in + space of dimension N = `(vector-length VECT)', the coordinates are + uniformly distributed within the unit N-shere. The sum of the + squares of the numbers is returned. + + - Function: random:solid-sphere! VECT + - Function: random:solid-sphere! VECT STATE + Fills VECT with inexact real random numbers the sum of whose + squares is equal to 1.0. Thinking of VECT as coordinates in space + of dimension n = `(vector-length VECT)', the coordinates are + uniformly distributed over the surface of the unit n-shere. + + +File: slib.info, Node: Fast Fourier Transform, Next: Cyclic Checksum, Prev: Random Numbers, Up: Mathematical Packages + +Fast Fourier Transform +====================== + + `(require 'fft)' + + - Function: fft ARRAY + ARRAY is an array of `(expt 2 n)' numbers. `fft' returns an array + of complex numbers comprising the "Discrete Fourier Transform" of + ARRAY. + + - Function: fft-1 ARRAY + `fft-1' returns an array of complex numbers comprising the inverse + Discrete Fourier Transform of ARRAY. + + `(fft-1 (fft ARRAY))' will return an array of values close to ARRAY. + + (fft '#(1 0+i -1 0-i 1 0+i -1 0-i)) => + + #(0.0 0.0 0.0+628.0783185208527e-18i 0.0 + 0.0 0.0 8.0-628.0783185208527e-18i 0.0) + + (fft-1 '#(0 0 0 0 0 0 8 0)) => + + #(1.0 -61.23031769111886e-18+1.0i -1.0 61.23031769111886e-18-1.0i + 1.0 -61.23031769111886e-18+1.0i -1.0 61.23031769111886e-18-1.0i) + + +File: slib.info, Node: Cyclic Checksum, Next: Plotting, Prev: Fast Fourier Transform, Up: Mathematical Packages + +Cyclic Checksum +=============== + + `(require 'make-crc)' + + - Function: make-port-crc + - Function: make-port-crc DEGREE + - Function: make-port-crc DEGREE GENERATOR + Returns an expression for a procedure of one argument, a port. + This procedure reads characters from the port until the end of + file and returns the integer checksum of the bytes read. + + The integer DEGREE, if given, specifies the degree of the + polynomial being computed - which is also the number of bits + computed in the checksums. The default value is 32. + + The integer GENERATOR specifies the polynomial being computed. + The power of 2 generating each 1 bit is the exponent of a term of + the polynomial. The bit at position DEGREE is implicit and should + not be part of GENERATOR. This allows systems with numbers + limited to 32 bits to calculate 32 bit checksums. The default + value of GENERATOR when DEGREE is 32 (its default) is: + + (make-port-crc 32 #b00000100110000010001110110110111) + + Creates a procedure to calculate the P1003.2/D11.2 (POSIX.2) 32-bit + checksum from the polynomial: + + 32 26 23 22 16 12 11 + ( x + x + x + x + x + x + x + + + 10 8 7 5 4 2 1 + x + x + x + x + x + x + x + 1 ) mod 2 + + (require 'make-crc) + (define crc32 (slib:eval (make-port-crc))) + (define (file-check-sum file) (call-with-input-file file crc32)) + (file-check-sum (in-vicinity (library-vicinity) "ratize.scm")) + + => 3553047446 + + +File: slib.info, Node: Plotting, Next: Root Finding, Prev: Cyclic Checksum, Up: Mathematical Packages + +Plotting on Character Devices +============================= + + `(require 'charplot)' + + The plotting procedure is made available through the use of the +`charplot' package. `charplot' is loaded by inserting `(require +'charplot)' before the code that uses this procedure. + + - Variable: charplot:height + The number of rows to make the plot vertically. + + - Variable: charplot:width + The number of columns to make the plot horizontally. + + - Procedure: plot! COORDS X-LABEL Y-LABEL + COORDS is a list of pairs of x and y coordinates. X-LABEL and + Y-LABEL are strings with which to label the x and y axes. + + Example: + (require 'charplot) + (set! charplot:height 19) + (set! charplot:width 45) + + (define (make-points n) + (if (zero? n) + '() + (cons (cons (/ n 6) (sin (/ n 6))) (make-points (1- n))))) + + (plot! (make-points 37) "x" "Sin(x)") + -| + Sin(x) ______________________________________________ + 1.25|- | + | | + 1|- **** | + | ** ** | + 750.0e-3|- * * | + | * * | + 500.0e-3|- * * | + | * | + 250.0e-3|- * | + | * * | + 0|-------------------*--------------------------| + | * | + -250.0e-3|- * * | + | * * | + -500.0e-3|- * | + | * * | + -750.0e-3|- * * | + | ** ** | + -1|- **** | + |____________:_____._____:_____._____:_________| + x 2 4 + + +File: slib.info, Node: Root Finding, Next: Commutative Rings, Prev: Plotting, Up: Mathematical Packages + +Root Finding +============ + + `(require 'root)' + + - Function: newtown:find-integer-root F DF/DX X0 + Given integer valued procedure F, its derivative (with respect to + its argument) DF/DX, and initial integer value X0 for which + DF/DX(X0) is non-zero, returns an integer X for which F(X) is + closer to zero than either of the integers adjacent to X; or + returns `#f' if such an integer can't be found. + + To find the closest integer to a given integers square root: + + (define (integer-sqrt y) + (newton:find-integer-root + (lambda (x) (- (* x x) y)) + (lambda (x) (* 2 x)) + (ash 1 (quotient (integer-length y) 2)))) + + (integer-sqrt 15) => 4 + + - Function: integer-sqrt Y + Given a non-negative integer Y, returns the rounded square-root of + Y. + + - Function: newton:find-root F DF/DX X0 PREC + Given real valued procedures F, DF/DX of one (real) argument, + initial real value X0 for which DF/DX(X0) is non-zero, and + positive real number PREC, returns a real X for which `abs'(F(X)) + is less than PREC; or returns `#f' if such a real can't be found. + + If PREC is instead a negative integer, `newton:find-root' returns + the result of -PREC iterations. + +H. J. Orchard, `The Laguerre Method for Finding the Zeros of +Polynomials', IEEE Transactions on Circuits and Systems, Vol. 36, No. +11, November 1989, pp 1377-1381. + + There are 2 errors in Orchard's Table II. Line k=2 for starting + value of 1000+j0 should have Z_k of 1.0475 + j4.1036 and line k=2 + for starting value of 0+j1000 should have Z_k of 1.0988 + j4.0833. + + - Function: laguerre:find-root F DF/DZ DDF/DZ^2 Z0 PREC + Given complex valued procedure F of one (complex) argument, its + derivative (with respect to its argument) DF/DX, its second + derivative DDF/DZ^2, initial complex value Z0, and positive real + number PREC, returns a complex number Z for which + `magnitude'(F(Z)) is less than PREC; or returns `#f' if such a + number can't be found. + + If PREC is instead a negative integer, `laguerre:find-root' + returns the result of -PREC iterations. + + - Function: laguerre:find-polynomial-root DEG F DF/DZ DDF/DZ^2 Z0 PREC + Given polynomial procedure F of integer degree DEG of one + argument, its derivative (with respect to its argument) DF/DX, its + second derivative DDF/DZ^2, initial complex value Z0, and positive + real number PREC, returns a complex number Z for which + `magnitude'(F(Z)) is less than PREC; or returns `#f' if such a + number can't be found. + + If PREC is instead a negative integer, + `laguerre:find-polynomial-root' returns the result of -PREC + iterations. + + - Function: secant:find-root F X0 X1 PREC + - Function: secant:find-bracketed-root F X0 X1 PREC + Given a real valued procedure F and two real valued starting + points X0 and X1, returns a real X for which `(abs (f x))' is less + than PREC; or returns `#f' if such a real can't be found. + + If X0 and X1 are chosen such that they bracket a root, that is + (or (< (f x0) 0 (f x1)) + (< (f x1) 0 (f x0))) + then the root returned will be between X0 and X1, and F will not + be passed an argument outside of that interval. + + `secant:find-bracketed-root' will return `#f' unless X0 and X1 + bracket a root. + + The secant method is used until a bracketing interval is found, at + which point a modified regula falsi method is used. + + If PREC is instead a negative integer, `secant:find-root' returns + the result of -PREC iterations. + + If PREC is a procedure it should accept 5 arguments: X0 F0 X1 F1 + and COUNT, where F0 will be `(f x0)', F1 `(f x1)', and COUNT the + number of iterations performed so far. PREC should return + non-false if the iteration should be stopped. + + +File: slib.info, Node: Commutative Rings, Next: Determinant, Prev: Root Finding, Up: Mathematical Packages + +Commutative Rings +================= + + Scheme provides a consistent and capable set of numeric functions. +Inexacts implement a field; integers a commutative ring (and Euclidean +domain). This package allows one to use basic Scheme numeric functions +with symbols and non-numeric elements of commutative rings. + + `(require 'commutative-ring)' + + The "commutative-ring" package makes the procedures `+', `-', `*', +`/', and `^' "careful" in the sense that any non-numeric arguments they +do not reduce appear in the expression output. In order to see what +working with this package is like, self-set all the single letter +identifiers (to their corresponding symbols). + + (define a 'a) + ... + (define z 'z) + + Or just `(require 'self-set)'. Now try some sample expressions: + + (+ (+ a b) (- a b)) => (* a 2) + (* (+ a b) (+ a b)) => (^ (+ a b) 2) + (* (+ a b) (- a b)) => (* (+ a b) (- a b)) + (* (- a b) (- a b)) => (^ (- a b) 2) + (* (- a b) (+ a b)) => (* (+ a b) (- a b)) + (/ (+ a b) (+ c d)) => (/ (+ a b) (+ c d)) + (^ (+ a b) 3) => (^ (+ a b) 3) + (^ (+ a 2) 3) => (^ (+ 2 a) 3) + + Associative rules have been applied and repeated addition and +multiplication converted to multiplication and exponentiation. + + We can enable distributive rules, thus expanding to sum of products +form: + (set! *ruleset* (combined-rulesets distribute* distribute/)) + + (* (+ a b) (+ a b)) => (+ (* 2 a b) (^ a 2) (^ b 2)) + (* (+ a b) (- a b)) => (- (^ a 2) (^ b 2)) + (* (- a b) (- a b)) => (- (+ (^ a 2) (^ b 2)) (* 2 a b)) + (* (- a b) (+ a b)) => (- (^ a 2) (^ b 2)) + (/ (+ a b) (+ c d)) => (+ (/ a (+ c d)) (/ b (+ c d))) + (/ (+ a b) (- c d)) => (+ (/ a (- c d)) (/ b (- c d))) + (/ (- a b) (- c d)) => (- (/ a (- c d)) (/ b (- c d))) + (/ (- a b) (+ c d)) => (- (/ a (+ c d)) (/ b (+ c d))) + (^ (+ a b) 3) => (+ (* 3 a (^ b 2)) (* 3 b (^ a 2)) (^ a 3) (^ b 3)) + (^ (+ a 2) 3) => (+ 8 (* a 12) (* (^ a 2) 6) (^ a 3)) + + Use of this package is not restricted to simple arithmetic +expressions: + + (require 'determinant) + + (determinant '((a b c) (d e f) (g h i))) => + (- (+ (* a e i) (* b f g) (* c d h)) (* a f h) (* b d i) (* c e g)) + + Currently, only `+', `-', `*', `/', and `^' support non-numeric +elements. Expressions with `-' are converted to equivalent expressions +without `-', so behavior for `-' is not defined separately. `/' +expressions are handled similarly. + + This list might be extended to include `quotient', `modulo', +`remainder', `lcm', and `gcd'; but these work only for the more +restrictive Euclidean (Unique Factorization) Domain. + +Rules and Rulesets +================== + + The "commutative-ring" package allows control of ring properties +through the use of "rulesets". + + - Variable: *ruleset* + Contains the set of rules currently in effect. Rules defined by + `cring:define-rule' are stored within the value of *ruleset* at the + time `cring:define-rule' is called. If *RULESET* is `#f', then no + rules apply. + + - Function: make-ruleset RULE1 ... + - Function: make-ruleset NAME RULE1 ... + Returns a new ruleset containing the rules formed by applying + `cring:define-rule' to each 4-element list argument RULE. If the + first argument to `make-ruleset' is a symbol, then the database + table created for the new ruleset will be named NAME. Calling + `make-ruleset' with no rule arguments creates an empty ruleset. + + - Function: combined-rulesets RULESET1 ... + - Function: combined-rulesets NAME RULESET1 ... + Returns a new ruleset containing the rules contained in each + ruleset argument RULESET. If the first argument to + `combined-ruleset' is a symbol, then the database table created for + the new ruleset will be named NAME. Calling `combined-ruleset' + with no ruleset arguments creates an empty ruleset. + + Two rulesets are defined by this package. + + - Constant: distribute* + Contain the ruleset to distribute multiplication over addition and + subtraction. + + - Constant: distribute/ + Contain the ruleset to distribute division over addition and + subtraction. + + Take care when using both DISTRIBUTE* and DISTRIBUTE/ + simultaneously. It is possible to put `/' into an infinite loop. + + You can specify how sum and product expressions containing non-numeric +elements simplify by specifying the rules for `+' or `*' for cases +where expressions involving objects reduce to numbers or to expressions +involving different non-numeric elements. + + - Function: cring:define-rule OP SUB-OP1 SUB-OP2 REDUCTION + Defines a rule for the case when the operation represented by + symbol OP is applied to lists whose `car's are SUB-OP1 and + SUB-OP2, respectively. The argument REDUCTION is a procedure + accepting 2 arguments which will be lists whose `car's are SUB-OP1 + and SUB-OP2. + + - Function: cring:define-rule OP SUB-OP1 'IDENTITY REDUCTION + Defines a rule for the case when the operation represented by + symbol OP is applied to a list whose `car' is SUB-OP1, and some + other argument. REDUCTION will be called with the list whose + `car' is SUB-OP1 and some other argument. + + If REDUCTION returns `#f', the reduction has failed and other + reductions will be tried. If REDUCTION returns a non-false value, + that value will replace the two arguments in arithmetic (`+', `-', + and `*') calculations involving non-numeric elements. + + The operations `+' and `*' are assumed commutative; hence both + orders of arguments to REDUCTION will be tried if necessary. + + The following rule is the definition for distributing `*' over `+'. + + (cring:define-rule + '* '+ 'identity + (lambda (exp1 exp2) + (apply + (map (lambda (trm) (* trm exp2)) (cdr exp1)))))) + +How to Create a Commutative Ring +================================ + + The first step in creating your commutative ring is to write +procedures to create elements of the ring. A non-numeric element of +the ring must be represented as a list whose first element is a symbol +or string. This first element identifies the type of the object. A +convenient and clear convention is to make the type-identifying element +be the same symbol whose top-level value is the procedure to create it. + + (define (n . list1) + (cond ((and (= 2 (length list1)) + (eq? (car list1) (cadr list1))) + 0) + ((not (term< (first list1) (last1 list1))) + (apply n (reverse list1))) + (else (cons 'n list1)))) + + (define (s x y) (n x y)) + + (define (m . list1) + (cond ((neq? (first list1) (term_min list1)) + (apply m (cyclicrotate list1))) + ((term< (last1 list1) (cadr list1)) + (apply m (reverse (cyclicrotate list1)))) + (else (cons 'm list1)))) + + Define a procedure to multiply 2 non-numeric elements of the ring. +Other multiplicatons are handled automatically. Objects for which rules +have *not* been defined are not changed. + + (define (n*n ni nj) + (let ((list1 (cdr ni)) (list2 (cdr nj))) + (cond ((null? (intersection list1 list2)) #f) + ((and (eq? (last1 list1) (first list2)) + (neq? (first list1) (last1 list2))) + (apply n (splice list1 list2))) + ((and (eq? (first list1) (first list2)) + (neq? (last1 list1) (last1 list2))) + (apply n (splice (reverse list1) list2))) + ((and (eq? (last1 list1) (last1 list2)) + (neq? (first list1) (first list2))) + (apply n (splice list1 (reverse list2)))) + ((and (eq? (last1 list1) (first list2)) + (eq? (first list1) (last1 list2))) + (apply m (cyclicsplice list1 list2))) + ((and (eq? (first list1) (first list2)) + (eq? (last1 list1) (last1 list2))) + (apply m (cyclicsplice (reverse list1) list2))) + (else #f)))) + + Test the procedures to see if they work. + + ;;; where cyclicrotate(list) is cyclic rotation of the list one step + ;;; by putting the first element at the end + (define (cyclicrotate list1) + (append (rest list1) (list (first list1)))) + ;;; and where term_min(list) is the element of the list which is + ;;; first in the term ordering. + (define (term_min list1) + (car (sort list1 term<))) + (define (term< sym1 sym2) + (string<? (symbol->string sym1) (symbol->string sym2))) + (define first car) + (define rest cdr) + (define (last1 list1) (car (last-pair list1))) + (define (neq? obj1 obj2) (not (eq? obj1 obj2))) + ;;; where splice is the concatenation of list1 and list2 except that their + ;;; common element is not repeated. + (define (splice list1 list2) + (cond ((eq? (last1 list1) (first list2)) + (append list1 (cdr list2))) + (else (error 'splice list1 list2)))) + ;;; where cyclicsplice is the result of leaving off the last element of + ;;; splice(list1,list2). + (define (cyclicsplice list1 list2) + (cond ((and (eq? (last1 list1) (first list2)) + (eq? (first list1) (last1 list2))) + (butlast (splice list1 list2) 1)) + (else (error 'cyclicsplice list1 list2)))) + + (N*N (S a b) (S a b)) => (m a b) + + Then register the rule for multiplying type N objects by type N +objects. + + (cring:define-rule '* 'N 'N N*N)) + + Now we are ready to compute! + + (define (t) + (define detM + (+ (* (S g b) + (+ (* (S f d) + (- (* (S a f) (S d g)) (* (S a g) (S d f)))) + (* (S f f) + (- (* (S a g) (S d d)) (* (S a d) (S d g)))) + (* (S f g) + (- (* (S a d) (S d f)) (* (S a f) (S d d)))))) + (* (S g d) + (+ (* (S f b) + (- (* (S a g) (S d f)) (* (S a f) (S d g)))) + (* (S f f) + (- (* (S a b) (S d g)) (* (S a g) (S d b)))) + (* (S f g) + (- (* (S a f) (S d b)) (* (S a b) (S d f)))))) + (* (S g f) + (+ (* (S f b) + (- (* (S a d) (S d g)) (* (S a g) (S d d)))) + (* (S f d) + (- (* (S a g) (S d b)) (* (S a b) (S d g)))) + (* (S f g) + (- (* (S a b) (S d d)) (* (S a d) (S d b)))))) + (* (S g g) + (+ (* (S f b) + (- (* (S a f) (S d d)) (* (S a d) (S d f)))) + (* (S f d) + (- (* (S a b) (S d f)) (* (S a f) (S d b)))) + (* (S f f) + (- (* (S a d) (S d b)) (* (S a b) (S d d)))))))) + (* (S b e) (S c a) (S e c) + detM + )) + (pretty-print (t)) + -| + (- (+ (m a c e b d f g) + (m a c e b d g f) + (m a c e b f d g) + (m a c e b f g d) + (m a c e b g d f) + (m a c e b g f d)) + (* 2 (m a b e c) (m d f g)) + (* (m a c e b d) (m f g)) + (* (m a c e b f) (m d g)) + (* (m a c e b g) (m d f))) + + +File: slib.info, Node: Determinant, Prev: Commutative Rings, Up: Mathematical Packages + +Determinant +=========== + + (require 'determinant) + (determinant '((1 2) (3 4))) => -2 + (determinant '((1 2 3) (4 5 6) (7 8 9))) => 0 + (determinant '((1 2 3 4) (5 6 7 8) (9 10 11 12))) => 0 + + +File: slib.info, Node: Database Packages, Next: Other Packages, Prev: Mathematical Packages, Up: Top + +Database Packages +***************** + +* Menu: + +* Base Table:: +* Relational Database:: 'relational-database +* Weight-Balanced Trees:: 'wt-tree + + +File: slib.info, Node: Base Table, Next: Relational Database, Prev: Database Packages, Up: Database Packages + +Base Table +========== + + A base table implementation using Scheme association lists is +available as the value of the identifier `alist-table' after doing: + + `(require 'alist-table)' + + Association list base tables are suitable for small databases and +support all Scheme types when temporary and readable/writeable Scheme +types when saved. I hope support for other base table implementations +will be added in the future. + + This rest of this section documents the interface for a base table +implementation from which the *Note Relational Database:: package +constructs a Relational system. It will be of interest primarily to +those wishing to port or write new base-table implementations. + + All of these functions are accessed through a single procedure by +calling that procedure with the symbol name of the operation. A +procedure will be returned if that operation is supported and `#f' +otherwise. For example: + + (require 'alist-table) + (define open-base (alist-table 'make-base)) + make-base => *a procedure* + (define foo (alist-table 'foo)) + foo => #f + + - Function: make-base FILENAME KEY-DIMENSION COLUMN-TYPES + Returns a new, open, low-level database (collection of tables) + associated with FILENAME. This returned database has an empty + table associated with CATALOG-ID. The positive integer + KEY-DIMENSION is the number of keys composed to make a PRIMARY-KEY + for the catalog table. The list of symbols COLUMN-TYPES describes + the types of each column for that table. If the database cannot + be created as specified, `#f' is returned. + + Calling the `close-base' method on this database and possibly other + operations will cause FILENAME to be written to. If FILENAME is + `#f' a temporary, non-disk based database will be created if such + can be supported by the base table implelentation. + + - Function: open-base FILENAME MUTABLE + Returns an open low-level database associated with FILENAME. If + MUTABLE? is `#t', this database will have methods capable of + effecting change to the database. If MUTABLE? is `#f', only + methods for inquiring the database will be available. If the + database cannot be opened as specified `#f' is returned. + + Calling the `close-base' (and possibly other) method on a MUTABLE? + database will cause FILENAME to be written to. + + - Function: write-base LLDB FILENAME + Causes the low-level database LLDB to be written to FILENAME. If + the write is successful, also causes LLDB to henceforth be + associated with FILENAME. Calling the `close-database' (and + possibly other) method on LLDB may cause FILENAME to be written + to. If FILENAME is `#f' this database will be changed to a + temporary, non-disk based database if such can be supported by the + underlying base table implelentation. If the operations completed + successfully, `#t' is returned. Otherwise, `#f' is returned. + + - Function: sync-base LLDB + Causes the file associated with the low-level database LLDB to be + updated to reflect its current state. If the associated filename + is `#f', no action is taken and `#f' is returned. If this + operation completes successfully, `#t' is returned. Otherwise, + `#f' is returned. + + - Function: close-base LLDB + Causes the low-level database LLDB to be written to its associated + file (if any). If the write is successful, subsequent operations + to LLDB will signal an error. If the operations complete + successfully, `#t' is returned. Otherwise, `#f' is returned. + + - Function: make-table LLDB KEY-DIMENSION COLUMN-TYPES + Returns the BASE-ID for a new base table, otherwise returns `#f'. + The base table can then be opened using `(open-table LLDB + BASE-ID)'. The positive integer KEY-DIMENSION is the number of + keys composed to make a PRIMARY-KEY for this table. The list of + symbols COLUMN-TYPES describes the types of each column. + + - Constant: catalog-id + A constant BASE-ID suitable for passing as a parameter to + `open-table'. CATALOG-ID will be used as the base table for the + system catalog. + + - Function: open-table LLDB BASE-ID KEY-DIMENSION COLUMN-TYPES + Returns a HANDLE for an existing base table in the low-level + database LLDB if that table exists and can be opened in the mode + indicated by MUTABLE?, otherwise returns `#f'. + + As with `make-table', the positive integer KEY-DIMENSION is the + number of keys composed to make a PRIMARY-KEY for this table. The + list of symbols COLUMN-TYPES describes the types of each column. + + - Function: kill-table LLDB BASE-ID KEY-DIMENSION COLUMN-TYPES + Returns `#t' if the base table associated with BASE-ID was removed + from the low level database LLDB, and `#f' otherwise. + + - Function: make-keyifier-1 TYPE + Returns a procedure which accepts a single argument which must be + of type TYPE. This returned procedure returns an object suitable + for being a KEY argument in the functions whose descriptions + follow. + + Any 2 arguments of the supported type passed to the returned + function which are not `equal?' must result in returned values + which are not `equal?'. + + - Function: make-list-keyifier KEY-DIMENSION TYPES + The list of symbols TYPES must have at least KEY-DIMENSION + elements. Returns a procedure which accepts a list of length + KEY-DIMENSION and whose types must corresopond to the types named + by TYPES. This returned procedure combines the elements of its + list argument into an object suitable for being a KEY argument in + the functions whose descriptions follow. + + Any 2 lists of supported types (which must at least include + symbols and non-negative integers) passed to the returned function + which are not `equal?' must result in returned values which are not + `equal?'. + + - Function: make-key-extractor KEY-DIMENSION TYPES COLUMN-NUMBER + Returns a procedure which accepts objects produced by application + of the result of `(make-list-keyifier KEY-DIMENSION TYPES)'. This + procedure returns a KEY which is `equal?' to the COLUMN-NUMBERth + element of the list which was passed to create COMBINED-KEY. The + list TYPES must have at least KEY-DIMENSION elements. + + - Function: make-key->list KEY-DIMENSION TYPES + Returns a procedure which accepts objects produced by application + of the result of `(make-list-keyifier KEY-DIMENSION TYPES)'. This + procedure returns a list of KEYs which are elementwise `equal?' to + the list which was passed to create COMBINED-KEY. + +In the following functions, the KEY argument can always be assumed to +be the value returned by a call to a *keyify* routine. + +In contrast, a MATCH-KEY argument is a list of length equal to the +number of primary keys. The MATCH-KEY restricts the actions of the +table command to those records whose primary keys all satisfy the +corresponding element of the MATCH-KEY list. The elements and their +actions are: + + `#f' + The false value matches any key in the corresponding position. + + an object of type procedure + This procedure must take a single argument, the key in the + corresponding position. Any key for which the procedure + returns a non-false value is a match; Any key for which the + procedure returns a `#f' is not. + + other values + Any other value matches only those keys `equal?' to it. + + - Function: for-each-key HANDLE PROCEDURE MATCH-KEY + Calls PROCEDURE once with each KEY in the table opened in HANDLE + which satisfies MATCH-KEY in an unspecified order. An unspecified + value is returned. + + - Function: map-key HANDLE PROCEDURE MATCH-KEY + Returns a list of the values returned by calling PROCEDURE once + with each KEY in the table opened in HANDLE which satisfies + MATCH-KEY in an unspecified order. + + - Function: ordered-for-each-key HANDLE PROCEDURE MATCH-KEY + Calls PROCEDURE once with each KEY in the table opened in HANDLE + which satisfies MATCH-KEY in the natural order for the types of + the primary key fields of that table. An unspecified value is + returned. + + - Function: delete* HANDLE MATCH-KEY + Removes all rows which satisfy MATCH-KEY from the table opened in + HANDLE. An unspecified value is returned. + + - Function: present? HANDLE KEY + Returns a non-`#f' value if there is a row associated with KEY in + the table opened in HANDLE and `#f' otherwise. + + - Function: delete HANDLE KEY + Removes the row associated with KEY from the table opened in + HANDLE. An unspecified value is returned. + + - Function: make-getter KEY-DIMENSION TYPES + Returns a procedure which takes arguments HANDLE and KEY. This + procedure returns a list of the non-primary values of the relation + (in the base table opened in HANDLE) whose primary key is KEY if + it exists, and `#f' otherwise. + + - Function: make-putter KEY-DIMENSION TYPES + Returns a procedure which takes arguments HANDLE and KEY and + VALUE-LIST. This procedure associates the primary key KEY with + the values in VALUE-LIST (in the base table opened in HANDLE) and + returns an unspecified value. + + - Function: supported-type? SYMBOL + Returns `#t' if SYMBOL names a type allowed as a column value by + the implementation, and `#f' otherwise. At a minimum, an + implementation must support the types `integer', `symbol', + `string', `boolean', and `base-id'. + + - Function: supported-key-type? SYMBOL + Returns `#t' if SYMBOL names a type allowed as a key value by the + implementation, and `#f' otherwise. At a minimum, an + implementation must support the types `integer', and `symbol'. + +`integer' + Scheme exact integer. + +`symbol' + Scheme symbol. + +`boolean' + `#t' or `#f'. + +`base-id' + Objects suitable for passing as the BASE-ID parameter to + `open-table'. The value of CATALOG-ID must be an acceptable + `base-id'. + + +File: slib.info, Node: Relational Database, Next: Weight-Balanced Trees, Prev: Base Table, Up: Database Packages + +Relational Database +=================== + + `(require 'relational-database)' + + This package implements a database system inspired by the Relational +Model (`E. F. Codd, A Relational Model of Data for Large Shared Data +Banks'). An SLIB relational database implementation can be created +from any *Note Base Table:: implementation. + +* Menu: + +* Motivations:: Database Manifesto +* Creating and Opening Relational Databases:: +* Relational Database Operations:: +* Table Operations:: +* Catalog Representation:: +* Unresolved Issues:: +* Database Utilities:: 'database-utilities +* Database Reports:: +* Database Browser:: 'database-browse + + +File: slib.info, Node: Motivations, Next: Creating and Opening Relational Databases, Prev: Relational Database, Up: Relational Database + +Motivations +----------- + + Most nontrivial programs contain databases: Makefiles, configure +scripts, file backup, calendars, editors, source revision control, CAD +systems, display managers, menu GUIs, games, parsers, debuggers, +profilers, and even error reporting are all rife with databases. Coding +databases is such a common activity in programming that many may not be +aware of how often they do it. + + A database often starts as a dispatch in a program. The author, +perhaps because of the need to make the dispatch configurable, the need +for correlating dispatch in other routines, or because of changes or +growth, devises a data structure to contain the information, a routine +for interpreting that data structure, and perhaps routines for +augmenting and modifying the stored data. The dispatch must be +converted into this form and tested. + + The programmer may need to devise an interactive program for enabling +easy examination and modification of the information contained in this +database. Often, in an attempt to foster modularity and avoid delays in +release, intermediate file formats for the database information are +devised. It often turns out that users prefer modifying these +intermediate files with a text editor to using the interactive program +in order to do operations (such as global changes) not forseen by the +program's author. + + In order to address this need, the conscientious software engineer may +even provide a scripting language to allow users to make repetitive +database changes. Users will grumble that they need to read a large +manual and learn yet another programming language (even if it *almost* +has language "xyz" syntax) in order to do simple configuration. + + All of these facilities need to be designed, coded, debugged, +documented, and supported; often causing what was very simple in concept +to become a major developement project. + + This view of databases just outlined is somewhat the reverse of the +view of the originators of the "Relational Model" of database +abstraction. The relational model was devised to unify and allow +interoperation of large multi-user databases running on diverse +platforms. A fairly general purpose "Comprehensive Language" for +database manipulations is mandated (but not specified) as part of the +relational model for databases. + + One aspect of the Relational Model of some importance is that the +"Comprehensive Language" must be expressible in some form which can be +stored in the database. This frees the programmer from having to make +programs data-driven in order to use a database. + + This package includes as one of its basic supported types Scheme +"expression"s. This type allows expressions as defined by the Scheme +standards to be stored in the database. Using `slib:eval' retrieved +expressions can be evaluated (in the top-level environment). Scheme's +`lambda' facilitates closure of environments, modularity, etc. so that +procedures (which could not be stored directly most databases) can +still be effectively retrieved. Since `slib:eval' evaluates +expressions in the top-level environment, built-in and user defined +procedures can be easily accessed by name. + + This package's purpose is to standardize (through a common interface) +database creation and usage in Scheme programs. The relational model's +provision for inclusion of language expressions as data as well as the +description (in tables, of course) of all of its tables assures that +relational databases are powerful enough to assume the roles currently +played by thousands of ad-hoc routines and data formats. + +Such standardization to a relational-like model brings many benefits: + + * Tables, fields, domains, and types can be dealt with by name in + programs. + + * The underlying database implementation can be changed (for + performance or other reasons) by changing a single line of code. + + * The formats of tables can be easily extended or changed without + altering code. + + * Consistency checks are specified as part of the table descriptions. + Changes in checks need only occur in one place. + + * All the configuration information which the developer wishes to + group together is easily grouped, without needing to change + programs aware of only some of these tables. + + * Generalized report generators, interactive entry programs, and + other database utilities can be part of a shared library. The + burden of adding configurability to a program is greatly reduced. + + * Scheme is the "comprehensive language" for these databases. + Scripting for configuration no longer needs to be in a separate + language with additional documentation. + + * Scheme's latent types mesh well with the strict typing and logical + requirements of the relational model. + + * Portable formats allow easy interchange of data. The included + table descriptions help prevent misinterpretation of format. + + +File: slib.info, Node: Creating and Opening Relational Databases, Next: Relational Database Operations, Prev: Motivations, Up: Relational Database + +Creating and Opening Relational Databases +----------------------------------------- + + - Function: make-relational-system BASE-TABLE-IMPLEMENTATION + Returns a procedure implementing a relational database using the + BASE-TABLE-IMPLEMENTATION. + + All of the operations of a base table implementation are accessed + through a procedure defined by `require'ing that implementation. + Similarly, all of the operations of the relational database + implementation are accessed through the procedure returned by + `make-relational-system'. For instance, a new relational database + could be created from the procedure returned by + `make-relational-system' by: + + (require 'alist-table) + (define relational-alist-system + (make-relational-system alist-table)) + (define create-alist-database + (relational-alist-system 'create-database)) + (define my-database + (create-alist-database "mydata.db")) + +What follows are the descriptions of the methods available from +relational system returned by a call to `make-relational-system'. + + - Function: create-database FILENAME + Returns an open, nearly empty relational database associated with + FILENAME. The only tables defined are the system catalog and + domain table. Calling the `close-database' method on this database + and possibly other operations will cause FILENAME to be written + to. If FILENAME is `#f' a temporary, non-disk based database will + be created if such can be supported by the underlying base table + implelentation. If the database cannot be created as specified + `#f' is returned. For the fields and layout of descriptor tables, + *Note Catalog Representation:: + + - Function: open-database FILENAME MUTABLE? + Returns an open relational database associated with FILENAME. If + MUTABLE? is `#t', this database will have methods capable of + effecting change to the database. If MUTABLE? is `#f', only + methods for inquiring the database will be available. Calling the + `close-database' (and possibly other) method on a MUTABLE? + database will cause FILENAME to be written to. If the database + cannot be opened as specified `#f' is returned. + + +File: slib.info, Node: Relational Database Operations, Next: Table Operations, Prev: Creating and Opening Relational Databases, Up: Relational Database + +Relational Database Operations +------------------------------ + +These are the descriptions of the methods available from an open +relational database. A method is retrieved from a database by calling +the database with the symbol name of the operation. For example: + + (define my-database + (create-alist-database "mydata.db")) + (define telephone-table-desc + ((my-database 'create-table) 'telephone-table-desc)) + + - Function: close-database + Causes the relational database to be written to its associated + file (if any). If the write is successful, subsequent operations + to this database will signal an error. If the operations completed + successfully, `#t' is returned. Otherwise, `#f' is returned. + + - Function: write-database FILENAME + Causes the relational database to be written to FILENAME. If the + write is successful, also causes the database to henceforth be + associated with FILENAME. Calling the `close-database' (and + possibly other) method on this database will cause FILENAME to be + written to. If FILENAME is `#f' this database will be changed to + a temporary, non-disk based database if such can be supported by + the underlying base table implelentation. If the operations + completed successfully, `#t' is returned. Otherwise, `#f' is + returned. + + - Function: table-exists? TABLE-NAME + Returns `#t' if TABLE-NAME exists in the system catalog, otherwise + returns `#f'. + + - Function: open-table TABLE-NAME MUTABLE? + Returns a "methods" procedure for an existing relational table in + this database if it exists and can be opened in the mode indicated + by MUTABLE?, otherwise returns `#f'. + +These methods will be present only in databases which are MUTABLE?. + + - Function: delete-table TABLE-NAME + Removes and returns the TABLE-NAME row from the system catalog if + the table or view associated with TABLE-NAME gets removed from the + database, and `#f' otherwise. + + - Function: create-table TABLE-DESC-NAME + Returns a methods procedure for a new (open) relational table for + describing the columns of a new base table in this database, + otherwise returns `#f'. For the fields and layout of descriptor + tables, *Note Catalog Representation::. + + - Function: create-table TABLE-NAME TABLE-DESC-NAME + Returns a methods procedure for a new (open) relational table with + columns as described by TABLE-DESC-NAME, otherwise returns `#f'. + + - Function: create-view ?? + - Function: project-table ?? + - Function: restrict-table ?? + - Function: cart-prod-tables ?? + Not yet implemented. + + +File: slib.info, Node: Table Operations, Next: Catalog Representation, Prev: Relational Database Operations, Up: Relational Database + +Table Operations +---------------- + +These are the descriptions of the methods available from an open +relational table. A method is retrieved from a table by calling the +table with the symbol name of the operation. For example: + + (define telephone-table-desc + ((my-database 'create-table) 'telephone-table-desc)) + (require 'common-list-functions) + (define ndrp (telephone-table-desc 'row:insert)) + (ndrp '(1 #t name #f string)) + (ndrp '(2 #f telephone + (lambda (d) + (and (string? d) (> (string-length d) 2) + (every + (lambda (c) + (memv c '(#\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9 + #\+ #\( #\ #\) #\-))) + (string->list d)))) + string)) + +Some operations described below require primary key arguments. Primary +keys arguments are denoted KEY1 KEY2 .... It is an error to call an +operation for a table which takes primary key arguments with the wrong +number of primary keys for that table. + +The term "row" used below refers to a Scheme list of values (one for +each column) in the order specified in the descriptor (table) for this +table. Missing values appear as `#f'. Primary keys must not be +missing. + + - Function: get COLUMN-NAME + Returns a procedure of arguments KEY1 KEY2 ... which returns the + value for the COLUMN-NAME column of the row associated with + primary keys KEY1, KEY2 ... if that row exists in the table, or + `#f' otherwise. + + ((plat 'get 'processor) 'djgpp) => i386 + ((plat 'get 'processor) 'be-os) => #f + + - Function: get* COLUMN-NAME + Returns a procedure of optional arguments MATCH-KEY1 ... which + returns a list of the values for the specified column for all rows + in this table. The optional MATCH-KEY1 ... arguments restrict + actions to a subset of the table. See the match-key description + below for details. + + ((plat 'get* 'processor)) => + (i386 8086 i386 8086 i386 i386 8086 m68000 + m68000 m68000 m68000 m68000 powerpc) + + ((plat 'get* 'processor) #f) => + (i386 8086 i386 8086 i386 i386 8086 m68000 + m68000 m68000 m68000 m68000 powerpc) + + (define (a-key? key) + (char=? #\a (string-ref (symbol->string key) 0))) + + ((plat 'get* 'processor) a-key?) => + (m68000 m68000 m68000 m68000 m68000 powerpc) + + ((plat 'get* 'name) a-key?) => + (atari-st-turbo-c atari-st-gcc amiga-sas/c-5.10 + amiga-aztec amiga-dice-c aix) + + - Function: row:retrieve + Returns a procedure of arguments KEY1 KEY2 ... which returns the + row associated with primary keys KEY1, KEY2 ... if it exists, or + `#f' otherwise. + + ((plat 'row:retrieve) 'linux) => (linux i386 linux gcc) + ((plat 'row:retrieve) 'multics) => #f + + - Function: row:retrieve* + Returns a procedure of optional arguments MATCH-KEY1 ... which + returns a list of all rows in this table. The optional MATCH-KEY1 + ... arguments restrict actions to a subset of the table. See the + match-key description below for details. + + ((plat 'row:retrieve*) a-key?) => + ((atari-st-turbo-c m68000 atari turbo-c) + (atari-st-gcc m68000 atari gcc) + (amiga-sas/c-5.10 m68000 amiga sas/c) + (amiga-aztec m68000 amiga aztec) + (amiga-dice-c m68000 amiga dice-c) + (aix powerpc aix -)) + + - Function: row:remove + Returns a procedure of arguments KEY1 KEY2 ... which removes and + returns the row associated with primary keys KEY1, KEY2 ... if it + exists, or `#f' otherwise. + + - Function: row:remove* + Returns a procedure of optional arguments MATCH-KEY1 ... which + removes and returns a list of all rows in this table. The optional + MATCH-KEY1 ... arguments restrict actions to a subset of the + table. See the match-key description below for details. + + - Function: row:delete + Returns a procedure of arguments KEY1 KEY2 ... which deletes the + row associated with primary keys KEY1, KEY2 ... if it exists. The + value returned is unspecified. + + - Function: row:delete* + Returns a procedure of optional arguments MATCH-KEY1 ... which + Deletes all rows from this table. The optional MATCH-KEY1 ... + arguments restrict deletions to a subset of the table. See the + match-key description below for details. The value returned is + unspecified. The descriptor table and catalog entry for this + table are not affected. + + - Function: row:update + Returns a procedure of one argument, ROW, which adds the row, ROW, + to this table. If a row for the primary key(s) specified by ROW + already exists in this table, it will be overwritten. The value + returned is unspecified. + + - Function: row:update* + Returns a procedure of one argument, ROWS, which adds each row in + the list of rows, ROWS, to this table. If a row for the primary + key specified by an element of ROWS already exists in this table, + it will be overwritten. The value returned is unspecified. + + - Function: row:insert + Adds the row ROW to this table. If a row for the primary key(s) + specified by ROW already exists in this table an error is + signaled. The value returned is unspecified. + + - Function: row:insert* + Returns a procedure of one argument, ROWS, which adds each row in + the list of rows, ROWS, to this table. If a row for the primary + key specified by an element of ROWS already exists in this table, + an error is signaled. The value returned is unspecified. + + - Function: for-each-row + Returns a procedure of arguments PROC MATCH-KEY1 ... which calls + PROC with each ROW in this table in the (implementation-dependent) + natural ordering for rows. The optional MATCH-KEY1 ... arguments + restrict actions to a subset of the table. See the match-key + description below for details. + + *Real* relational programmers would use some least-upper-bound join + for every row to get them in order; But we don't have joins yet. + +The (optional) MATCH-KEY1 ... arguments are used to restrict actions of +a whole-table operation to a subset of that table. Those procedures +(returned by methods) which accept match-key arguments will accept any +number of match-key arguments between zero and the number of primary +keys in the table. Any unspecified MATCH-KEY arguments default to `#f'. + +The MATCH-KEY1 ... restrict the actions of the table command to those +records whose primary keys each satisfy the corresponding MATCH-KEY +argument. The arguments and their actions are: + + `#f' + The false value matches any key in the corresponding position. + + an object of type procedure + This procedure must take a single argument, the key in the + corresponding position. Any key for which the procedure + returns a non-false value is a match; Any key for which the + procedure returns a `#f' is not. + + other values + Any other value matches only those keys `equal?' to it. + + - Function: close-table + Subsequent operations to this table will signal an error. + + - Constant: column-names + - Constant: column-foreigns + - Constant: column-domains + - Constant: column-types + Return a list of the column names, foreign-key table names, domain + names, or type names respectively for this table. These 4 methods + are different from the others in that the list is returned, rather + than a procedure to obtain the list. + + - Constant: primary-limit + Returns the number of primary keys fields in the relations in this + table. + + +File: slib.info, Node: Catalog Representation, Next: Unresolved Issues, Prev: Table Operations, Up: Relational Database + +Catalog Representation +---------------------- + +Each database (in an implementation) has a "system catalog" which +describes all the user accessible tables in that database (including +itself). + +The system catalog base table has the following fields. `PRI' +indicates a primary key for that table. + + PRI table-name + column-limit the highest column number + coltab-name descriptor table name + bastab-id data base table identifier + user-integrity-rule + view-procedure A scheme thunk which, when called, + produces a handle for the view. coltab + and bastab are specified if and only if + view-procedure is not. + +Descriptors for base tables (not views) are tables (pointed to by +system catalog). Descriptor (base) tables have the fields: + + PRI column-number sequential integers from 1 + primary-key? boolean TRUE for primary key components + column-name + column-integrity-rule + domain-name + +A "primary key" is any column marked as `primary-key?' in the +corresponding descriptor table. All the `primary-key?' columns must +have lower column numbers than any non-`primary-key?' columns. Every +table must have at least one primary key. Primary keys must be +sufficient to distinguish all rows from each other in the table. All of +the system defined tables have a single primary key. + +This package currently supports tables having from 1 to 4 primary keys +if there are non-primary columns, and any (natural) number if *all* +columns are primary keys. If you need more than 4 primary keys, I would +like to hear what you are doing! + +A "domain" is a category describing the allowable values to occur in a +column. It is described by a (base) table with the fields: + + PRI domain-name + foreign-table + domain-integrity-rule + type-id + type-param + +The "type-id" field value is a symbol. This symbol may be used by the +underlying base table implementation in storing that field. + +If the `foreign-table' field is non-`#f' then that field names a table +from the catalog. The values for that domain must match a primary key +of the table referenced by the TYPE-PARAM (or `#f', if allowed). This +package currently does not support composite foreign-keys. + +The types for which support is planned are: + atom + symbol + string [<length>] + number [<base>] + money <currency> + date-time + boolean + + foreign-key <table-name> + expression + virtual <expression> + + +File: slib.info, Node: Unresolved Issues, Next: Database Utilities, Prev: Catalog Representation, Up: Relational Database + +Unresolved Issues +----------------- + + Although `rdms.scm' is not large, I found it very difficult to write +(six rewrites). I am not aware of any other examples of a generalized +relational system (although there is little new in CS). I left out +several aspects of the Relational model in order to simplify the job. +The major features lacking (which might be addressed portably) are +views, transaction boundaries, and protection. + + Protection needs a model for specifying priveledges. Given how +operations are accessed from handles it should not be difficult to +restrict table accesses to those allowed for that user. + + The system catalog has a field called `view-procedure'. This should +allow a purely functional implementation of views. This will work but +is unsatisfying for views resulting from a "select"ion (subset of +rows); for whole table operations it will not be possible to reduce the +number of keys scanned over when the selection is specified only by an +opaque procedure. + + Transaction boundaries present the most intriguing area. Transaction +boundaries are actually a feature of the "Comprehensive Language" of the +Relational database and not of the database. Scheme would seem to +provide the opportunity for an extremely clean semantics for transaction +boundaries since the builtin procedures with side effects are small in +number and easily identified. + + These side-effect builtin procedures might all be portably redefined +to versions which properly handled transactions. Compiled library +routines would need to be recompiled as well. Many system extensions +(delete-file, system, etc.) would also need to be redefined. + +There are 2 scope issues that must be resolved for multiprocess +transaction boundaries: + +Process scope + The actions captured by a transaction should be only for the + process which invoked the start of transaction. Although standard + Scheme does not provide process primitives as such, `dynamic-wind' + would provide a workable hook into process switching for many + implementations. + +Shared utilities with state + Some shared utilities have state which should *not* be part of a + transaction. An example would be calling a pseudo-random number + generator. If the success of a transaction depended on the + pseudo-random number and failed, the state of the generator would + be set back. Subsequent calls would keep returning the same + number and keep failing. + + Pseudo-random number generators are not reentrant; thus they would + require locks in order to operate properly in a multiprocess + environment. Are all examples of utilities whose state should not + be part of transactions also non-reentrant? If so, perhaps + suspending transaction capture for the duration of locks would + solve this problem. + + +File: slib.info, Node: Database Utilities, Next: Database Reports, Prev: Unresolved Issues, Up: Relational Database + +Database Utilities +------------------ + + `(require 'database-utilities)' + +This enhancement wraps a utility layer on `relational-database' which +provides: + * Automatic loading of the appropriate base-table package when + opening a database. + + * Automatic execution of initialization commands stored in database. + + * Transparent execution of database commands stored in `*commands*' + table in database. + +Also included are utilities which provide: + * Data definition from Scheme lists and + + * Report generation + +for any SLIB relational database. + + - Function: create-database FILENAME BASE-TABLE-TYPE + Returns an open, nearly empty enhanced (with `*commands*' table) + relational database (with base-table type BASE-TABLE-TYPE) + associated with FILENAME. + + - Function: open-database FILENAME + - Function: open-database FILENAME BASE-TABLE-TYPE + Returns an open enchanced relational database associated with + FILENAME. The database will be opened with base-table type + BASE-TABLE-TYPE) if supplied. If BASE-TABLE-TYPE is not supplied, + `open-database' will attempt to deduce the correct + base-table-type. If the database can not be opened or if it lacks + the `*commands*' table, `#f' is returned. + + - Function: open-database! FILENAME + - Function: open-database! FILENAME BASE-TABLE-TYPE + Returns *mutable* open enchanced relational database ... + +The table `*commands*' in an "enhanced" relational-database has the +fields (with domains): + PRI name symbol + parameters parameter-list + procedure expression + documentation string + + The `parameters' field is a foreign key (domain `parameter-list') of +the `*catalog-data*' table and should have the value of a table +described by `*parameter-columns*'. This `parameter-list' table +describes the arguments suitable for passing to the associated command. +The intent of this table is to be of a form such that different +user-interfaces (for instance, pull-down menus or plain-text queries) +can operate from the same table. A `parameter-list' table has the +following fields: + PRI index uint + name symbol + arity parameter-arity + domain domain + defaulter expression + expander expression + documentation string + + The `arity' field can take the values: + +`single' + Requires a single parameter of the specified domain. + +`optional' + A single parameter of the specified domain or zero parameters is + acceptable. + +`boolean' + A single boolean parameter or zero parameters (in which case `#f' + is substituted) is acceptable. + +`nary' + Any number of parameters of the specified domain are acceptable. + The argument passed to the command function is always a list of the + parameters. + +`nary1' + One or more of parameters of the specified domain are acceptable. + The argument passed to the command function is always a list of the + parameters. + + The `domain' field specifies the domain which a parameter or +parameters in the `index'th field must satisfy. + + The `defaulter' field is an expression whose value is either `#f' or +a procedure of one argument (the parameter-list) which returns a *list* +of the default value or values as appropriate. Note that since the +`defaulter' procedure is called every time a default parameter is +needed for this column, "sticky" defaults can be implemented using +shared state with the domain-integrity-rule. + +Invoking Commands +................. + + When an enhanced relational-database is called with a symbol which +matches a NAME in the `*commands*' table, the associated procedure +expression is evaluated and applied to the enhanced +relational-database. A procedure should then be returned which the user +can invoke on (optional) arguments. + + The command `*initialize*' is special. If present in the +`*commands*' table, `open-database' or `open-database!' will return +the value of the `*initialize*' command. Notice that arbitrary code +can be run when the `*initialize*' procedure is automatically applied +to the enhanced relational-database. + + Note also that if you wish to shadow or hide from the user +relational-database methods described in *Note Relational Database +Operations::, this can be done by a dispatch in the closure returned by +the `*initialize*' expression rather than by entries in the +`*commands*' table if it is desired that the underlying methods remain +accessible to code in the `*commands*' table. + + - Function: make-command-server RDB TABLE-NAME + Returns a procedure of 2 arguments, a (symbol) command and a + call-back procedure. When this returned procedure is called, it + looks up COMMAND in table TABLE-NAME and calls the call-back + procedure with arguments: + COMMAND + The COMMAND + + COMMAND-VALUE + The result of evaluating the expression in the PROCEDURE + field of TABLE-NAME and calling it with RDB. + + PARAMETER-NAME + A list of the "official" name of each parameter. Corresponds + to the `name' field of the COMMAND's parameter-table. + + POSITIONS + A list of the positive integer index of each parameter. + Corresponds to the `index' field of the COMMAND's + parameter-table. + + ARITIES + A list of the arities of each parameter. Corresponds to the + `arity' field of the COMMAND's parameter-table. For a + description of `arity' see table above. + + TYPES + A list of the type name of each parameter. Correspnds to the + `type-id' field of the contents of the `domain' of the + COMMAND's parameter-table. + + DEFAULTERS + A list of the defaulters for each parameter. Corresponds to + the `defaulters' field of the COMMAND's parameter-table. + + DOMAIN-INTEGRITY-RULES + A list of procedures (one for each parameter) which tests + whether a value for a parameter is acceptable for that + parameter. The procedure should be called with each datum in + the list for `nary' arity parameters. + + ALIASES + A list of lists of `(alias parameter-name)'. There can be + more than one alias per PARAMETER-NAME. + + For information about parameters, *Note Parameter lists::. Here is an +example of setting up a command with arguments and parsing those +arguments from a `getopt' style argument list (*note Getopt::.). + + (require 'database-utilities) + (require 'fluid-let) + (require 'parameters) + (require 'getopt) + + (define my-rdb (create-database #f 'alist-table)) + + (define-tables my-rdb + '(foo-params + *parameter-columns* + *parameter-columns* + ((1 single-string single string + (lambda (pl) '("str")) #f "single string") + (2 nary-symbols nary symbol + (lambda (pl) '()) #f "zero or more symbols") + (3 nary1-symbols nary1 symbol + (lambda (pl) '(symb)) #f "one or more symbols") + (4 optional-number optional uint + (lambda (pl) '()) #f "zero or one number") + (5 flag boolean boolean + (lambda (pl) '(#f)) #f "a boolean flag"))) + '(foo-pnames + ((name string)) + ((parameter-index uint)) + (("s" 1) + ("single-string" 1) + ("n" 2) + ("nary-symbols" 2) + ("N" 3) + ("nary1-symbols" 3) + ("o" 4) + ("optional-number" 4) + ("f" 5) + ("flag" 5))) + '(my-commands + ((name symbol)) + ((parameters parameter-list) + (parameter-names parameter-name-translation) + (procedure expression) + (documentation string)) + ((foo + foo-params + foo-pnames + (lambda (rdb) (lambda args (print args))) + "test command arguments")))) + + (define (dbutil:serve-command-line rdb command-table + command argc argv) + (set! argv (if (vector? argv) (vector->list argv) argv)) + ((make-command-server rdb command-table) + command + (lambda (comname comval options positions + arities types defaulters dirs aliases) + (apply comval (getopt->arglist + argc argv options positions + arities types defaulters dirs aliases))))) + + (define (cmd . opts) + (fluid-let ((*optind* 1)) + (printf "%-34s => " + (call-with-output-string + (lambda (pt) (write (cons 'cmd opts) pt)))) + (set! opts (cons "cmd" opts)) + (force-output) + (dbutil:serve-command-line + my-rdb 'my-commands 'foo (length opts) opts))) + + (cmd) => ("str" () (symb) () #f) + (cmd "-f") => ("str" () (symb) () #t) + (cmd "--flag") => ("str" () (symb) () #t) + (cmd "-o177") => ("str" () (symb) (177) #f) + (cmd "-o" "177") => ("str" () (symb) (177) #f) + (cmd "--optional" "621") => ("str" () (symb) (621) #f) + (cmd "--optional=621") => ("str" () (symb) (621) #f) + (cmd "-s" "speciality") => ("speciality" () (symb) () #f) + (cmd "-sspeciality") => ("speciality" () (symb) () #f) + (cmd "--single" "serendipity") => ("serendipity" () (symb) () #f) + (cmd "--single=serendipity") => ("serendipity" () (symb) () #f) + (cmd "-n" "gravity" "piety") => ("str" () (piety gravity) () #f) + (cmd "-ngravity" "piety") => ("str" () (piety gravity) () #f) + (cmd "--nary" "chastity") => ("str" () (chastity) () #f) + (cmd "--nary=chastity" "") => ("str" () ( chastity) () #f) + (cmd "-N" "calamity") => ("str" () (calamity) () #f) + (cmd "-Ncalamity") => ("str" () (calamity) () #f) + (cmd "--nary1" "surety") => ("str" () (surety) () #f) + (cmd "--nary1=surety") => ("str" () (surety) () #f) + (cmd "-N" "levity" "fealty") => ("str" () (fealty levity) () #f) + (cmd "-Nlevity" "fealty") => ("str" () (fealty levity) () #f) + (cmd "--nary1" "surety" "brevity") => ("str" () (brevity surety) () #f) + (cmd "--nary1=surety" "brevity") => ("str" () (brevity surety) () #f) + (cmd "-?") + -| + Usage: cmd [OPTION ARGUMENT ...] ... + + -f, --flag + -o, --optional[=]<number> + -n, --nary[=]<symbols> ... + -N, --nary1[=]<symbols> ... + -s, --single[=]<string> + + ERROR: getopt->parameter-list "unrecognized option" "-?" + + Some commands are defined in all extended relational-databases. The +are called just like *Note Relational Database Operations::. + + - Function: add-domain DOMAIN-ROW + Adds DOMAIN-ROW to the "domains" table if there is no row in the + domains table associated with key `(car DOMAIN-ROW)' and returns + `#t'. Otherwise returns `#f'. + + For the fields and layout of the domain table, *Note Catalog + Representation::. Currently, these fields are + * domain-name + + * foreign-table + + * domain-integrity-rule + + * type-id + + * type-param + + The following example adds 3 domains to the `build' database. + `Optstring' is either a string or `#f'. `filename' is a string + and `build-whats' is a symbol. + + (for-each (build 'add-domain) + '((optstring #f + (lambda (x) (or (not x) (string? x))) + string + #f) + (filename #f #f string #f) + (build-whats #f #f symbol #f))) + + - Function: delete-domain DOMAIN-NAME + Removes and returns the DOMAIN-NAME row from the "domains" table. + + - Function: domain-checker DOMAIN + Returns a procedure to check an argument for conformance to domain + DOMAIN. + +Defining Tables +............... + + - Procedure: define-tables RDB SPEC-0 ... + Adds tables as specified in SPEC-0 ... to the open + relational-database RDB. Each SPEC has the form: + + (<name> <descriptor-name> <descriptor-name> <rows>) + or + (<name> <primary-key-fields> <other-fields> <rows>) + + where <name> is the table name, <descriptor-name> is the symbol + name of a descriptor table, <primary-key-fields> and + <other-fields> describe the primary keys and other fields + respectively, and <rows> is a list of data rows to be added to the + table. + + <primary-key-fields> and <other-fields> are lists of field + descriptors of the form: + + (<column-name> <domain>) + or + (<column-name> <domain> <column-integrity-rule>) + + where <column-name> is the column name, <domain> is the domain of + the column, and <column-integrity-rule> is an expression whose + value is a procedure of one argument (which returns `#f' to signal + an error). + + If <domain> is not a defined domain name and it matches the name of + this table or an already defined (in one of SPEC-0 ...) single key + field table, a foriegn-key domain will be created for it. + +The following example shows a new database with the name of `foo.db' +being created with tables describing processor families and +processor/os/compiler combinations. + +The database command `define-tables' is defined to call `define-tables' +with its arguments. The database is also configured to print `Welcome' +when the database is opened. The database is then closed and reopened. + + (require 'database-utilities) + (define my-rdb (create-database "foo.db" 'alist-table)) + + (define-tables my-rdb + '(*commands* + ((name symbol)) + ((parameters parameter-list) + (procedure expression) + (documentation string)) + ((define-tables + no-parameters + no-parameter-names + (lambda (rdb) (lambda specs (apply define-tables rdb specs))) + "Create or Augment tables from list of specs") + (*initialize* + no-parameters + no-parameter-names + (lambda (rdb) (display "Welcome") (newline) rdb) + "Print Welcome")))) + + ((my-rdb 'define-tables) + '(processor-family + ((family atom)) + ((also-ran processor-family)) + ((m68000 #f) + (m68030 m68000) + (i386 8086) + (8086 #f) + (powerpc #f))) + + '(platform + ((name symbol)) + ((processor processor-family) + (os symbol) + (compiler symbol)) + ((aix powerpc aix -) + (amiga-dice-c m68000 amiga dice-c) + (amiga-aztec m68000 amiga aztec) + (amiga-sas/c-5.10 m68000 amiga sas/c) + (atari-st-gcc m68000 atari gcc) + (atari-st-turbo-c m68000 atari turbo-c) + (borland-c-3.1 8086 ms-dos borland-c) + (djgpp i386 ms-dos gcc) + (linux i386 linux gcc) + (microsoft-c 8086 ms-dos microsoft-c) + (os/2-emx i386 os/2 gcc) + (turbo-c-2 8086 ms-dos turbo-c) + (watcom-9.0 i386 ms-dos watcom)))) + + ((my-rdb 'close-database)) + + (set! my-rdb (open-database "foo.db" 'alist-table)) + -| + Welcome + + +File: slib.info, Node: Database Reports, Next: Database Browser, Prev: Database Utilities, Up: Relational Database + +Database Reports +---------------- + +Code for generating database reports is in `report.scm'. After writing +it using `format', I discovered that Common-Lisp `format' is not +useable for this application because there is no mechanismm for +truncating fields. `report.scm' needs to be rewritten using `printf'. + + - Procedure: create-report RDB DESTINATION REPORT-NAME TABLE + - Procedure: create-report RDB DESTINATION REPORT-NAME + The symbol REPORT-NAME must be primary key in the table named + `*reports*' in the relational database RDB. DESTINATION is a + port, string, or symbol. If DESTINATION is a: + + port + The table is created as ascii text and written to that port. + + string + The table is created as ascii text and written to the file + named by DESTINATION. + + symbol + DESTINATION is the primary key for a row in the table named + *printers*. + + The report is prepared as follows: + + * `Format' (*note Format::.) is called with the `header' field + and the (list of) `column-names' of the table. + + * `Format' is called with the `reporter' field and (on + successive calls) each record in the natural order for the + table. A count is kept of the number of newlines output by + format. When the number of newlines to be output exceeds the + number of lines per page, the set of lines will be broken if + there are more than `minimum-break' left on this page and the + number of lines for this row is larger or equal to twice + `minimum-break'. + + * `Format' is called with the `footer' field and the (list of) + `column-names' of the table. The footer field should not + output a newline. + + * A new page is output. + + * This entire process repeats until all the rows are output. + + Each row in the table *reports* has the fields: + +name + The report name. + +default-table + The table to report on if none is specified. + +header, footer + A `format' string. At the beginning and end of each page + respectively, `format' is called with this string and the (list of) + column-names of this table. + +reporter + A `format' string. For each row in the table, `format' is called + with this string and the row. + +minimum-break + The minimum number of lines into which the report lines for a row + can be broken. Use `0' if a row's lines should not be broken over + page boundaries. + + Each row in the table *printers* has the fields: + +name + The printer name. + +print-procedure + The procedure to call to actually print. + + +File: slib.info, Node: Database Browser, Prev: Database Reports, Up: Relational Database + +Database Browser +---------------- + + (require 'database-browse) + + - Procedure: browse DATABASE + Prints the names of all the tables in DATABASE and sets browse's + default to DATABASE. + + - Procedure: browse + Prints the names of all the tables in the default database. + + - Procedure: browse TABLE-NAME + For each record of the table named by the symbol TABLE-NAME, + prints a line composed of all the field values. + + - Procedure: browse PATHNAME + Opens the database named by the string PATHNAME, prints the names + of all its tables, and sets browse's default to the database. + + - Procedure: browse DATABASE TABLE-NAME + Sets browse's default to DATABASE and prints the records of the + table named by the symbol TABLE-NAME. + + - Procedure: browse PATHNAME TABLE-NAME + Opens the database named by the string PATHNAME and sets browse's + default to it; `browse' prints the records of the table named by + the symbol TABLE-NAME. + + + +File: slib.info, Node: Weight-Balanced Trees, Prev: Relational Database, Up: Database Packages + +Weight-Balanced Trees +===================== + + `(require 'wt-tree)' + + Balanced binary trees are a useful data structure for maintaining +large sets of ordered objects or sets of associations whose keys are +ordered. MIT Scheme has an comprehensive implementation of +weight-balanced binary trees which has several advantages over the +other data structures for large aggregates: + + * In addition to the usual element-level operations like insertion, + deletion and lookup, there is a full complement of collection-level + operations, like set intersection, set union and subset test, all + of which are implemented with good orders of growth in time and + space. This makes weight balanced trees ideal for rapid + prototyping of functionally derived specifications. + + * An element in a tree may be indexed by its position under the + ordering of the keys, and the ordinal position of an element may + be determined, both with reasonable efficiency. + + * Operations to find and remove minimum element make weight balanced + trees simple to use for priority queues. + + * The implementation is *functional* rather than *imperative*. This + means that operations like `inserting' an association in a tree do + not destroy the old tree, in much the same way that `(+ 1 x)' + modifies neither the constant 1 nor the value bound to `x'. The + trees are referentially transparent thus the programmer need not + worry about copying the trees. Referential transparency allows + space efficiency to be achieved by sharing subtrees. + + These features make weight-balanced trees suitable for a wide range of +applications, especially those that require large numbers of sets or +discrete maps. Applications that have a few global databases and/or +concentrate on element-level operations like insertion and lookup are +probably better off using hash-tables or red-black trees. + + The *size* of a tree is the number of associations that it contains. +Weight balanced binary trees are balanced to keep the sizes of the +subtrees of each node within a constant factor of each other. This +ensures logarithmic times for single-path operations (like lookup and +insertion). A weight balanced tree takes space that is proportional to +the number of associations in the tree. For the current +implementation, the constant of proportionality is six words per +association. + + Weight balanced trees can be used as an implementation for either +discrete sets or discrete maps (associations). Sets are implemented by +ignoring the datum that is associated with the key. Under this scheme +if an associations exists in the tree this indicates that the key of the +association is a member of the set. Typically a value such as `()', +`#t' or `#f' is associated with the key. + + Many operations can be viewed as computing a result that, depending on +whether the tree arguments are thought of as sets or maps, is known by +two different names. An example is `wt-tree/member?', which, when +regarding the tree argument as a set, computes the set membership +operation, but, when regarding the tree as a discrete map, +`wt-tree/member?' is the predicate testing if the map is defined at an +element in its domain. Most names in this package have been chosen +based on interpreting the trees as sets, hence the name +`wt-tree/member?' rather than `wt-tree/defined-at?'. + + The weight balanced tree implementation is a run-time-loadable option. +To use weight balanced trees, execute + + (load-option 'wt-tree) + +once before calling any of the procedures defined here. + +* Menu: + +* Construction of Weight-Balanced Trees:: +* Basic Operations on Weight-Balanced Trees:: +* Advanced Operations on Weight-Balanced Trees:: +* Indexing Operations on Weight-Balanced Trees:: + + +File: slib.info, Node: Construction of Weight-Balanced Trees, Next: Basic Operations on Weight-Balanced Trees, Prev: Weight-Balanced Trees, Up: Weight-Balanced Trees + +Construction of Weight-Balanced Trees +------------------------------------- + + Binary trees require there to be a total order on the keys used to +arrange the elements in the tree. Weight balanced trees are organized +by *types*, where the type is an object encapsulating the ordering +relation. Creating a tree is a two-stage process. First a tree type +must be created from the predicate which gives the ordering. The tree +type is then used for making trees, either empty or singleton trees or +trees from other aggregate structures like association lists. Once +created, a tree `knows' its type and the type is used to test +compatibility between trees in operations taking two trees. Usually a +small number of tree types are created at the beginning of a program and +used many times throughout the program's execution. + + - procedure+: make-wt-tree-type KEY<? + This procedure creates and returns a new tree type based on the + ordering predicate KEY<?. KEY<? must be a total ordering, having + the property that for all key values `a', `b' and `c': + + (key<? a a) => #f + (and (key<? a b) (key<? b a)) => #f + (if (and (key<? a b) (key<? b c)) + (key<? a c) + #t) => #t + + Two key values are assumed to be equal if neither is less than the + other by KEY<?. + + Each call to `make-wt-tree-type' returns a distinct value, and + trees are only compatible if their tree types are `eq?'. A + consequence is that trees that are intended to be used in binary + tree operations must all be created with a tree type originating + from the same call to `make-wt-tree-type'. + + - variable+: number-wt-type + A standard tree type for trees with numeric keys. `Number-wt-type' + could have been defined by + + (define number-wt-type (make-wt-tree-type <)) + + - variable+: string-wt-type + A standard tree type for trees with string keys. `String-wt-type' + could have been defined by + + (define string-wt-type (make-wt-tree-type string<?)) + + - procedure+: make-wt-tree WT-TREE-TYPE + This procedure creates and returns a newly allocated weight + balanced tree. The tree is empty, i.e. it contains no + associations. WT-TREE-TYPE is a weight balanced tree type + obtained by calling `make-wt-tree-type'; the returned tree has + this type. + + - procedure+: singleton-wt-tree WT-TREE-TYPE KEY DATUM + This procedure creates and returns a newly allocated weight + balanced tree. The tree contains a single association, that of + DATUM with KEY. WT-TREE-TYPE is a weight balanced tree type + obtained by calling `make-wt-tree-type'; the returned tree has + this type. + + - procedure+: alist->wt-tree TREE-TYPE ALIST + Returns a newly allocated weight-balanced tree that contains the + same associations as ALIST. This procedure is equivalent to: + + (lambda (type alist) + (let ((tree (make-wt-tree type))) + (for-each (lambda (association) + (wt-tree/add! tree + (car association) + (cdr association))) + alist) + tree)) + + +File: slib.info, Node: Basic Operations on Weight-Balanced Trees, Next: Advanced Operations on Weight-Balanced Trees, Prev: Construction of Weight-Balanced Trees, Up: Weight-Balanced Trees + +Basic Operations on Weight-Balanced Trees +----------------------------------------- + + This section describes the basic tree operations on weight balanced +trees. These operations are the usual tree operations for insertion, +deletion and lookup, some predicates and a procedure for determining the +number of associations in a tree. + + - procedure+: wt-tree? OBJECT + Returns `#t' if OBJECT is a weight-balanced tree, otherwise + returns `#f'. + + - procedure+: wt-tree/empty? WT-TREE + Returns `#t' if WT-TREE contains no associations, otherwise + returns `#f'. + + - procedure+: wt-tree/size WT-TREE + Returns the number of associations in WT-TREE, an exact + non-negative integer. This operation takes constant time. + + - procedure+: wt-tree/add WT-TREE KEY DATUM + Returns a new tree containing all the associations in WT-TREE and + the association of DATUM with KEY. If WT-TREE already had an + association for KEY, the new association overrides the old. The + average and worst-case times required by this operation are + proportional to the logarithm of the number of associations in + WT-TREE. + + - procedure+: wt-tree/add! WT-TREE KEY DATUM + Associates DATUM with KEY in WT-TREE and returns an unspecified + value. If WT-TREE already has an association for KEY, that + association is replaced. The average and worst-case times + required by this operation are proportional to the logarithm of + the number of associations in WT-TREE. + + - procedure+: wt-tree/member? KEY WT-TREE + Returns `#t' if WT-TREE contains an association for KEY, otherwise + returns `#f'. The average and worst-case times required by this + operation are proportional to the logarithm of the number of + associations in WT-TREE. + + - procedure+: wt-tree/lookup WT-TREE KEY DEFAULT + Returns the datum associated with KEY in WT-TREE. If WT-TREE + doesn't contain an association for KEY, DEFAULT is returned. The + average and worst-case times required by this operation are + proportional to the logarithm of the number of associations in + WT-TREE. + + - procedure+: wt-tree/delete WT-TREE KEY + Returns a new tree containing all the associations in WT-TREE, + except that if WT-TREE contains an association for KEY, it is + removed from the result. The average and worst-case times required + by this operation are proportional to the logarithm of the number + of associations in WT-TREE. + + - procedure+: wt-tree/delete! WT-TREE KEY + If WT-TREE contains an association for KEY the association is + removed. Returns an unspecified value. The average and worst-case + times required by this operation are proportional to the logarithm + of the number of associations in WT-TREE. + + +File: slib.info, Node: Advanced Operations on Weight-Balanced Trees, Next: Indexing Operations on Weight-Balanced Trees, Prev: Basic Operations on Weight-Balanced Trees, Up: Weight-Balanced Trees + +Advanced Operations on Weight-Balanced Trees +-------------------------------------------- + + In the following the *size* of a tree is the number of associations +that the tree contains, and a *smaller* tree contains fewer +associations. + + - procedure+: wt-tree/split< WT-TREE BOUND + Returns a new tree containing all and only the associations in + WT-TREE which have a key that is less than BOUND in the ordering + relation of the tree type of WT-TREE. The average and worst-case + times required by this operation are proportional to the logarithm + of the size of WT-TREE. + + - procedure+: wt-tree/split> WT-TREE BOUND + Returns a new tree containing all and only the associations in + WT-TREE which have a key that is greater than BOUND in the + ordering relation of the tree type of WT-TREE. The average and + worst-case times required by this operation are proportional to the + logarithm of size of WT-TREE. + + - procedure+: wt-tree/union WT-TREE-1 WT-TREE-2 + Returns a new tree containing all the associations from both trees. + This operation is asymmetric: when both trees have an association + for the same key, the returned tree associates the datum from + WT-TREE-2 with the key. Thus if the trees are viewed as discrete + maps then `wt-tree/union' computes the map override of WT-TREE-1 by + WT-TREE-2. If the trees are viewed as sets the result is the set + union of the arguments. The worst-case time required by this + operation is proportional to the sum of the sizes of both trees. + If the minimum key of one tree is greater than the maximum key of + the other tree then the time required is at worst proportional to + the logarithm of the size of the larger tree. + + - procedure+: wt-tree/intersection WT-TREE-1 WT-TREE-2 + Returns a new tree containing all and only those associations from + WT-TREE-1 which have keys appearing as the key of an association + in WT-TREE-2. Thus the associated data in the result are those + from WT-TREE-1. If the trees are being used as sets the result is + the set intersection of the arguments. As a discrete map + operation, `wt-tree/intersection' computes the domain restriction + of WT-TREE-1 to (the domain of) WT-TREE-2. The time required by + this operation is never worse that proportional to the sum of the + sizes of the trees. + + - procedure+: wt-tree/difference WT-TREE-1 WT-TREE-2 + Returns a new tree containing all and only those associations from + WT-TREE-1 which have keys that *do not* appear as the key of an + association in WT-TREE-2. If the trees are viewed as sets the + result is the asymmetric set difference of the arguments. As a + discrete map operation, it computes the domain restriction of + WT-TREE-1 to the complement of (the domain of) WT-TREE-2. The + time required by this operation is never worse that proportional to + the sum of the sizes of the trees. + + - procedure+: wt-tree/subset? WT-TREE-1 WT-TREE-2 + Returns `#t' iff the key of each association in WT-TREE-1 is the + key of some association in WT-TREE-2, otherwise returns `#f'. + Viewed as a set operation, `wt-tree/subset?' is the improper subset + predicate. A proper subset predicate can be constructed: + + (define (proper-subset? s1 s2) + (and (wt-tree/subset? s1 s2) + (< (wt-tree/size s1) (wt-tree/size s2)))) + + As a discrete map operation, `wt-tree/subset?' is the subset test + on the domain(s) of the map(s). In the worst-case the time + required by this operation is proportional to the size of + WT-TREE-1. + + - procedure+: wt-tree/set-equal? WT-TREE-1 WT-TREE-2 + Returns `#t' iff for every association in WT-TREE-1 there is an + association in WT-TREE-2 that has the same key, and *vice versa*. + + Viewing the arguments as sets `wt-tree/set-equal?' is the set + equality predicate. As a map operation it determines if two maps + are defined on the same domain. + + This procedure is equivalent to + + (lambda (wt-tree-1 wt-tree-2) + (and (wt-tree/subset? wt-tree-1 wt-tree-2 + (wt-tree/subset? wt-tree-2 wt-tree-1))) + + In the worst-case the time required by this operation is + proportional to the size of the smaller tree. + + - procedure+: wt-tree/fold COMBINER INITIAL WT-TREE + This procedure reduces WT-TREE by combining all the associations, + using an reverse in-order traversal, so the associations are + visited in reverse order. COMBINER is a procedure of three + arguments: a key, a datum and the accumulated result so far. + Provided COMBINER takes time bounded by a constant, `wt-tree/fold' + takes time proportional to the size of WT-TREE. + + A sorted association list can be derived simply: + + (wt-tree/fold (lambda (key datum list) + (cons (cons key datum) list)) + '() + WT-TREE)) + + The data in the associations can be summed like this: + + (wt-tree/fold (lambda (key datum sum) (+ sum datum)) + 0 + WT-TREE) + + - procedure+: wt-tree/for-each ACTION WT-TREE + This procedure traverses the tree in-order, applying ACTION to + each association. The associations are processed in increasing + order of their keys. ACTION is a procedure of two arguments which + take the key and datum respectively of the association. Provided + ACTION takes time bounded by a constant, `wt-tree/for-each' takes + time proportional to in the size of WT-TREE. The example prints + the tree: + + (wt-tree/for-each (lambda (key value) + (display (list key value))) + WT-TREE)) + + +File: slib.info, Node: Indexing Operations on Weight-Balanced Trees, Prev: Advanced Operations on Weight-Balanced Trees, Up: Weight-Balanced Trees + +Indexing Operations on Weight-Balanced Trees +-------------------------------------------- + + Weight balanced trees support operations that view the tree as sorted +sequence of associations. Elements of the sequence can be accessed by +position, and the position of an element in the sequence can be +determined, both in logarthmic time. + + - procedure+: wt-tree/index WT-TREE INDEX + - procedure+: wt-tree/index-datum WT-TREE INDEX + - procedure+: wt-tree/index-pair WT-TREE INDEX + Returns the 0-based INDEXth association of WT-TREE in the sorted + sequence under the tree's ordering relation on the keys. + `wt-tree/index' returns the INDEXth key, `wt-tree/index-datum' + returns the datum associated with the INDEXth key and + `wt-tree/index-pair' returns a new pair `(KEY . DATUM)' which is + the `cons' of the INDEXth key and its datum. The average and + worst-case times required by this operation are proportional to + the logarithm of the number of associations in the tree. + + These operations signal an error if the tree is empty, if + INDEX`<0', or if INDEX is greater than or equal to the number of + associations in the tree. + + Indexing can be used to find the median and maximum keys in the + tree as follows: + + median: (wt-tree/index WT-TREE + (quotient (wt-tree/size WT-TREE) 2)) + + maximum: (wt-tree/index WT-TREE + (-1+ (wt-tree/size WT-TREE))) + + - procedure+: wt-tree/rank WT-TREE KEY + Determines the 0-based position of KEY in the sorted sequence of + the keys under the tree's ordering relation, or `#f' if the tree + has no association with for KEY. This procedure returns either an + exact non-negative integer or `#f'. The average and worst-case + times required by this operation are proportional to the logarithm + of the number of associations in the tree. + + - procedure+: wt-tree/min WT-TREE + - procedure+: wt-tree/min-datum WT-TREE + - procedure+: wt-tree/min-pair WT-TREE + Returns the association of WT-TREE that has the least key under + the tree's ordering relation. `wt-tree/min' returns the least key, + `wt-tree/min-datum' returns the datum associated with the least key + and `wt-tree/min-pair' returns a new pair `(key . datum)' which is + the `cons' of the minimum key and its datum. The average and + worst-case times required by this operation are proportional to the + logarithm of the number of associations in the tree. + + These operations signal an error if the tree is empty. They could + be written + (define (wt-tree/min tree) (wt-tree/index tree 0)) + (define (wt-tree/min-datum tree) (wt-tree/index-datum tree 0)) + (define (wt-tree/min-pair tree) (wt-tree/index-pair tree 0)) + + - procedure+: wt-tree/delete-min WT-TREE + Returns a new tree containing all of the associations in WT-TREE + except the association with the least key under the WT-TREE's + ordering relation. An error is signalled if the tree is empty. + The average and worst-case times required by this operation are + proportional to the logarithm of the number of associations in the + tree. This operation is equivalent to + + (wt-tree/delete WT-TREE (wt-tree/min WT-TREE)) + + - procedure+: wt-tree/delete-min! WT-TREE + Removes the association with the least key under the WT-TREE's + ordering relation. An error is signalled if the tree is empty. + The average and worst-case times required by this operation are + proportional to the logarithm of the number of associations in the + tree. This operation is equivalent to + + (wt-tree/delete! WT-TREE (wt-tree/min WT-TREE)) + + +File: slib.info, Node: Other Packages, Next: About SLIB, Prev: Database Packages, Up: Top + +Other Packages +************** + +* Menu: + +* Data Structures:: Various data structures. +* Procedures:: Miscellaneous utility procedures. +* Standards Support:: Support for Scheme Standards. +* Session Support:: REPL and Debugging. +* Extra-SLIB Packages:: + + +File: slib.info, Node: Data Structures, Next: Procedures, Prev: Other Packages, Up: Other Packages + +Data Structures +=============== + +* Menu: + +* Arrays:: 'array +* Array Mapping:: 'array-for-each +* Association Lists:: 'alist +* Byte:: 'byte +* Collections:: 'collect +* Dynamic Data Type:: 'dynamic +* Hash Tables:: 'hash-table +* Hashing:: 'hash, 'sierpinski, 'soundex +* Object:: 'object +* Priority Queues:: 'priority-queue +* Queues:: 'queue +* Records:: 'record +* Structures:: 'struct, 'structure + + +File: slib.info, Node: Arrays, Next: Array Mapping, Prev: Data Structures, Up: Data Structures + +Arrays +------ + + `(require 'array)' + + - Function: array? OBJ + Returns `#t' if the OBJ is an array, and `#f' if not. + + - Function: make-array INITIAL-VALUE BOUND1 BOUND2 ... + Creates and returns an array that has as many dimensins as there + are BOUNDs and fills it with INITIAL-VALUE. + + When constructing an array, BOUND is either an inclusive range of +indices expressed as a two element list, or an upper bound expressed as +a single integer. So + (make-array 'foo 3 3) == (make-array 'foo '(0 2) '(0 2)) + + - Function: make-shared-array ARRAY MAPPER BOUND1 BOUND2 ... + `make-shared-array' can be used to create shared subarrays of other + arrays. The MAPPER is a function that translates coordinates in + the new array into coordinates in the old array. A MAPPER must be + linear, and its range must stay within the bounds of the old + array, but it can be otherwise arbitrary. A simple example: + (define fred (make-array #f 8 8)) + (define freds-diagonal + (make-shared-array fred (lambda (i) (list i i)) 8)) + (array-set! freds-diagonal 'foo 3) + (array-ref fred 3 3) + => FOO + (define freds-center + (make-shared-array fred (lambda (i j) (list (+ 3 i) (+ 3 j))) + 2 2)) + (array-ref freds-center 0 0) + => FOO + + - Function: array-rank OBJ + Returns the number of dimensions of OBJ. If OBJ is not an array, + 0 is returned. + + - Function: array-shape ARRAY + `array-shape' returns a list of inclusive bounds. So: + (array-shape (make-array 'foo 3 5)) + => ((0 2) (0 4)) + + - Function: array-dimensions ARRAY + `array-dimensions' is similar to `array-shape' but replaces + elements with a 0 minimum with one greater than the maximum. So: + (array-dimensions (make-array 'foo 3 5)) + => (3 5) + + - Procedure: array-in-bounds? ARRAY INDEX1 INDEX2 ... + Returns `#t' if its arguments would be acceptable to `array-ref'. + + - Function: array-ref ARRAY INDEX1 INDEX2 ... + Returns the element at the `(INDEX1, INDEX2)' element in ARRAY. + + - Procedure: array-set! ARRAY NEW-VALUE INDEX1 INDEX2 ... + + - Function: array-1d-ref ARRAY INDEX + - Function: array-2d-ref ARRAY INDEX1 INDEX2 + - Function: array-3d-ref ARRAY INDEX1 INDEX2 INDEX3 + + - Procedure: array-1d-set! ARRAY NEW-VALUE INDEX + - Procedure: array-2d-set! ARRAY NEW-VALUE INDEX1 INDEX2 + - Procedure: array-3d-set! ARRAY NEW-VALUE INDEX1 INDEX2 INDEX3 + + The functions are just fast versions of `array-ref' and `array-set!' +that take a fixed number of arguments, and perform no bounds checking. + + If you comment out the bounds checking code, this is about as +efficient as you could ask for without help from the compiler. + + An exercise left to the reader: implement the rest of APL. + + +File: slib.info, Node: Array Mapping, Next: Association Lists, Prev: Arrays, Up: Data Structures + +Array Mapping +------------- + + `(require 'array-for-each)' + + - Function: array-map! ARRAY0 PROC ARRAY1 ... + ARRAY1, ... must have the same number of dimensions as ARRAY0 and + have a range for each index which includes the range for the + corresponding index in ARRAY0. PROC is applied to each tuple of + elements of ARRAY1 ... and the result is stored as the + corresponding element in ARRAY0. The value returned is + unspecified. The order of application is unspecified. + + - Function: array-for-each PROC ARRAY0 ... + PROC is applied to each tuple of elements of ARRAY0 ... in + row-major order. The value returned is unspecified. + + - Function: array-indexes ARRAY + Returns an array of lists of indexes for ARRAY such that, if LI is + a list of indexes for which ARRAY is defined, (equal? LI (apply + array-ref (array-indexes ARRAY) LI)). + + - Function: array-index-map! ARRAY PROC + applies PROC to the indices of each element of ARRAY in turn, + storing the result in the corresponding element. The value + returned and the order of application are unspecified. + + One can implement ARRAY-INDEXES as + (define (array-indexes array) + (let ((ra (apply make-array #f (array-shape array)))) + (array-index-map! ra (lambda x x)) + ra)) + Another example: + (define (apl:index-generator n) + (let ((v (make-uniform-vector n 1))) + (array-index-map! v (lambda (i) i)) + v)) + + - Function: array-copy! SOURCE DESTINATION + Copies every element from vector or array SOURCE to the + corresponding element of DESTINATION. DESTINATION must have the + same rank as SOURCE, and be at least as large in each dimension. + The order of copying is unspecified. + + +File: slib.info, Node: Association Lists, Next: Byte, Prev: Array Mapping, Up: Data Structures + +Association Lists +----------------- + + `(require 'alist)' + + Alist functions provide utilities for treating a list of key-value +pairs as an associative database. These functions take an equality +predicate, PRED, as an argument. This predicate should be repeatable, +symmetric, and transitive. + + Alist functions can be used with a secondary index method such as hash +tables for improved performance. + + - Function: predicate->asso PRED + Returns an "association function" (like `assq', `assv', or + `assoc') corresponding to PRED. The returned function returns a + key-value pair whose key is `pred'-equal to its first argument or + `#f' if no key in the alist is PRED-equal to the first argument. + + - Function: alist-inquirer PRED + Returns a procedure of 2 arguments, ALIST and KEY, which returns + the value associated with KEY in ALIST or `#f' if KEY does not + appear in ALIST. + + - Function: alist-associator PRED + Returns a procedure of 3 arguments, ALIST, KEY, and VALUE, which + returns an alist with KEY and VALUE associated. Any previous + value associated with KEY will be lost. This returned procedure + may or may not have side effects on its ALIST argument. An + example of correct usage is: + (define put (alist-associator string-ci=?)) + (define alist '()) + (set! alist (put alist "Foo" 9)) + + - Function: alist-remover PRED + Returns a procedure of 2 arguments, ALIST and KEY, which returns + an alist with an association whose KEY is key removed. This + returned procedure may or may not have side effects on its ALIST + argument. An example of correct usage is: + (define rem (alist-remover string-ci=?)) + (set! alist (rem alist "foo")) + + - Function: alist-map PROC ALIST + Returns a new association list formed by mapping PROC over the + keys and values of ALIST. PROC must be a function of 2 arguments + which returns the new value part. + + - Function: alist-for-each PROC ALIST + Applies PROC to each pair of keys and values of ALIST. PROC must + be a function of 2 arguments. The returned value is unspecified. + + +File: slib.info, Node: Byte, Next: Collections, Prev: Association Lists, Up: Data Structures + +Byte +---- + + `(require 'byte)' + + Some algorithms are expressed in terms of arrays of small integers. +Using Scheme strings to implement these arrays is not portable vis-a-vis +the correspondence between integers and characters and non-ascii +character sets. These functions abstract the notion of a "byte". + + - Function: byte-ref BYTES K + K must be a valid index of BYTES. `byte-ref' returns byte K of + BYTES using zero-origin indexing. + + - Procedure: byte-set! BYTES K BYTE + K must be a valid index of BYTES%, and BYTE must be a small + integer. `Byte-set!' stores BYTE in element K of BYTES and + returns an unspecified value. + + - Function: make-bytes K + - Function: make-bytes K BYTE + `Make-bytes' returns a newly allocated byte-array of length K. If + BYTE is given, then all elements of the byte-array are initialized + to BYTE, otherwise the contents of the byte-array are unspecified. + + + - Function: bytes-length BYTES + `bytes-length' returns length of byte-array BYTES. + + + - Function: write-byte BYTE + - Function: write-byte BYTE PORT + Writes the byte BYTE (not an external representation of the byte) + to the given PORT and returns an unspecified value. The PORT + argument may be omitted, in which case it defaults to the value + returned by `current-output-port'. + + + - Function: read-byte + - Function: read-byte PORT + Returns the next byte available from the input PORT, updating the + PORT to point to the following byte. If no more bytes are + available, an end of file object is returned. PORT may be + omitted, in which case it defaults to the value returned by + `current-input-port'. + + + - Function: bytes BYTE ... + Returns a newly allocated byte-array composed of the arguments. + + + - Function: bytes->list BYTES + - Function: list->bytes BYTES + `Bytes->list' returns a newly allocated list of the bytes that + make up the given byte-array. `List->bytes' returns a newly + allocated byte-array formed from the small integers in the list + BYTES. `Bytes->list' and `list->bytes' are inverses so far as + `equal?' is concerned. + + + +File: slib.info, Node: Collections, Next: Dynamic Data Type, Prev: Byte, Up: Data Structures + +Collections +----------- + + `(require 'collect)' + + Routines for managing collections. Collections are aggregate data +structures supporting iteration over their elements, similar to the +Dylan(TM) language, but with a different interface. They have +"elements" indexed by corresponding "keys", although the keys may be +implicit (as with lists). + + New types of collections may be defined as YASOS objects (*note +Yasos::.). They must support the following operations: + * `(collection? SELF)' (always returns `#t'); + + * `(size SELF)' returns the number of elements in the collection; + + * `(print SELF PORT)' is a specialized print operation for the + collection which prints a suitable representation on the given + PORT or returns it as a string if PORT is `#t'; + + * `(gen-elts SELF)' returns a thunk which on successive invocations + yields elements of SELF in order or gives an error if it is + invoked more than `(size SELF)' times; + + * `(gen-keys SELF)' is like `gen-elts', but yields the collection's + keys in order. + + They might support specialized `for-each-key' and `for-each-elt' +operations. + + - Function: collection? OBJ + A predicate, true initially of lists, vectors and strings. New + sorts of collections must answer `#t' to `collection?'. + + - Procedure: map-elts PROC . COLLECTIONS + - Procedure: do-elts PROC . COLLECTIONS + PROC is a procedure taking as many arguments as there are + COLLECTIONS (at least one). The COLLECTIONS are iterated over in + their natural order and PROC is applied to the elements yielded by + each iteration in turn. The order in which the arguments are + supplied corresponds to te order in which the COLLECTIONS appear. + `do-elts' is used when only side-effects of PROC are of interest + and its return value is unspecified. `map-elts' returns a + collection (actually a vector) of the results of the applications + of PROC. + + Example: + (map-elts + (list 1 2 3) (vector 1 2 3)) + => #(2 4 6) + + - Procedure: map-keys PROC . COLLECTIONS + - Procedure: do-keys PROC . COLLECTIONS + These are analogous to `map-elts' and `do-elts', but each + iteration is over the COLLECTIONS' *keys* rather than their + elements. + + Example: + (map-keys + (list 1 2 3) (vector 1 2 3)) + => #(0 2 4) + + - Procedure: for-each-key COLLECTION PROC + - Procedure: for-each-elt COLLECTION PROC + These are like `do-keys' and `do-elts' but only for a single + collection; they are potentially more efficient. + + - Function: reduce PROC SEED . COLLECTIONS + A generalization of the list-based `comlist:reduce-init' (*note + Lists as sequences::.) to collections which will shadow the + list-based version if `(require 'collect)' follows `(require + 'common-list-functions)' (*note Common List Functions::.). + + Examples: + (reduce + 0 (vector 1 2 3)) + => 6 + (reduce union '() '((a b c) (b c d) (d a))) + => (c b d a). + + - Function: any? PRED . COLLECTIONS + A generalization of the list-based `some' (*note Lists as + sequences::.) to collections. + + Example: + (any? odd? (list 2 3 4 5)) + => #t + + - Function: every? PRED . COLLECTIONS + A generalization of the list-based `every' (*note Lists as + sequences::.) to collections. + + Example: + (every? collection? '((1 2) #(1 2))) + => #t + + - Function: empty? COLLECTION + Returns `#t' iff there are no elements in COLLECTION. + + `(empty? COLLECTION) == (zero? (size COLLECTION))' + + - Function: size COLLECTION + Returns the number of elements in COLLECTION. + + - Function: Setter LIST-REF + See *Note Setters:: for a definition of "setter". N.B. `(setter + list-ref)' doesn't work properly for element 0 of a list. + + Here is a sample collection: `simple-table' which is also a `table'. + (define-predicate TABLE?) + (define-operation (LOOKUP table key failure-object)) + (define-operation (ASSOCIATE! table key value)) ;; returns key + (define-operation (REMOVE! table key)) ;; returns value + + (define (MAKE-SIMPLE-TABLE) + (let ( (table (list)) ) + (object + ;; table behaviors + ((TABLE? self) #t) + ((SIZE self) (size table)) + ((PRINT self port) (format port "#<SIMPLE-TABLE>")) + ((LOOKUP self key failure-object) + (cond + ((assq key table) => cdr) + (else failure-object) + )) + ((ASSOCIATE! self key value) + (cond + ((assq key table) + => (lambda (bucket) (set-cdr! bucket value) key)) + (else + (set! table (cons (cons key value) table)) + key) + )) + ((REMOVE! self key);; returns old value + (cond + ((null? table) (slib:error "TABLE:REMOVE! Key not found: " key)) + ((eq? key (caar table)) + (let ( (value (cdar table)) ) + (set! table (cdr table)) + value) + ) + (else + (let loop ( (last table) (this (cdr table)) ) + (cond + ((null? this) + (slib:error "TABLE:REMOVE! Key not found: " key)) + ((eq? key (caar this)) + (let ( (value (cdar this)) ) + (set-cdr! last (cdr this)) + value) + ) + (else + (loop (cdr last) (cdr this))) + ) ) ) + )) + ;; collection behaviors + ((COLLECTION? self) #t) + ((GEN-KEYS self) (collect:list-gen-elts (map car table))) + ((GEN-ELTS self) (collect:list-gen-elts (map cdr table))) + ((FOR-EACH-KEY self proc) + (for-each (lambda (bucket) (proc (car bucket))) table) + ) + ((FOR-EACH-ELT self proc) + (for-each (lambda (bucket) (proc (cdr bucket))) table) + ) + ) ) ) + + +File: slib.info, Node: Dynamic Data Type, Next: Hash Tables, Prev: Collections, Up: Data Structures + +Dynamic Data Type +----------------- + + `(require 'dynamic)' + + - Function: make-dynamic OBJ + Create and returns a new "dynamic" whose global value is OBJ. + + - Function: dynamic? OBJ + Returns true if and only if OBJ is a dynamic. No object + satisfying `dynamic?' satisfies any of the other standard type + predicates. + + - Function: dynamic-ref DYN + Return the value of the given dynamic in the current dynamic + environment. + + - Procedure: dynamic-set! DYN OBJ + Change the value of the given dynamic to OBJ in the current + dynamic environment. The returned value is unspecified. + + - Function: call-with-dynamic-binding DYN OBJ THUNK + Invoke and return the value of the given thunk in a new, nested + dynamic environment in which the given dynamic has been bound to a + new location whose initial contents are the value OBJ. This + dynamic environment has precisely the same extent as the + invocation of the thunk and is thus captured by continuations + created within that invocation and re-established by those + continuations when they are invoked. + + The `dynamic-bind' macro is not implemented. + + +File: slib.info, Node: Hash Tables, Next: Hashing, Prev: Dynamic Data Type, Up: Data Structures + +Hash Tables +----------- + + `(require 'hash-table)' + + - Function: predicate->hash PRED + Returns a hash function (like `hashq', `hashv', or `hash') + corresponding to the equality predicate PRED. PRED should be + `eq?', `eqv?', `equal?', `=', `char=?', `char-ci=?', `string=?', or + `string-ci=?'. + + A hash table is a vector of association lists. + + - Function: make-hash-table K + Returns a vector of K empty (association) lists. + + Hash table functions provide utilities for an associative database. +These functions take an equality predicate, PRED, as an argument. PRED +should be `eq?', `eqv?', `equal?', `=', `char=?', `char-ci=?', +`string=?', or `string-ci=?'. + + - Function: predicate->hash-asso PRED + Returns a hash association function of 2 arguments, KEY and + HASHTAB, corresponding to PRED. The returned function returns a + key-value pair whose key is PRED-equal to its first argument or + `#f' if no key in HASHTAB is PRED-equal to the first argument. + + - Function: hash-inquirer PRED + Returns a procedure of 3 arguments, `hashtab' and `key', which + returns the value associated with `key' in `hashtab' or `#f' if + key does not appear in `hashtab'. + + - Function: hash-associator PRED + Returns a procedure of 3 arguments, HASHTAB, KEY, and VALUE, which + modifies HASHTAB so that KEY and VALUE associated. Any previous + value associated with KEY will be lost. + + - Function: hash-remover PRED + Returns a procedure of 2 arguments, HASHTAB and KEY, which + modifies HASHTAB so that the association whose key is KEY is + removed. + + - Function: hash-map PROC HASH-TABLE + Returns a new hash table formed by mapping PROC over the keys and + values of HASH-TABLE. PROC must be a function of 2 arguments + which returns the new value part. + + - Function: hash-for-each PROC HASH-TABLE + Applies PROC to each pair of keys and values of HASH-TABLE. PROC + must be a function of 2 arguments. The returned value is + unspecified. + + +File: slib.info, Node: Hashing, Next: Object, Prev: Hash Tables, Up: Data Structures + +Hashing +------- + + `(require 'hash)' + + These hashing functions are for use in quickly classifying objects. +Hash tables use these functions. + + - Function: hashq OBJ K + - Function: hashv OBJ K + - Function: hash OBJ K + Returns an exact non-negative integer less than K. For each + non-negative integer less than K there are arguments OBJ for which + the hashing functions applied to OBJ and K returns that integer. + + For `hashq', `(eq? obj1 obj2)' implies `(= (hashq obj1 k) (hashq + obj2))'. + + For `hashv', `(eqv? obj1 obj2)' implies `(= (hashv obj1 k) (hashv + obj2))'. + + For `hash', `(equal? obj1 obj2)' implies `(= (hash obj1 k) (hash + obj2))'. + + `hash', `hashv', and `hashq' return in time bounded by a constant. + Notice that items having the same `hash' implies the items have + the same `hashv' implies the items have the same `hashq'. + + `(require 'sierpinski)' + + - Function: make-sierpinski-indexer MAX-COORDINATE + Returns a procedure (eg hash-function) of 2 numeric arguments which + preserves *nearness* in its mapping from NxN to N. + + MAX-COORDINATE is the maximum coordinate (a positive integer) of a + population of points. The returned procedures is a function that + takes the x and y coordinates of a point, (non-negative integers) + and returns an integer corresponding to the relative position of + that point along a Sierpinski curve. (You can think of this as + computing a (pseudo-) inverse of the Sierpinski spacefilling + curve.) + + Example use: Make an indexer (hash-function) for integer points + lying in square of integer grid points [0,99]x[0,99]: + (define space-key (make-sierpinski-indexer 100)) + Now let's compute the index of some points: + (space-key 24 78) => 9206 + (space-key 23 80) => 9172 + + Note that locations (24, 78) and (23, 80) are near in index and + therefore, because the Sierpinski spacefilling curve is + continuous, we know they must also be near in the plane. Nearness + in the plane does not, however, necessarily correspond to nearness + in index, although it *tends* to be so. + + Example applications: + * Sort points by Sierpinski index to get heuristic solution to + *travelling salesman problem*. For details of performance, + see L. Platzman and J. Bartholdi, "Spacefilling curves and the + Euclidean travelling salesman problem", JACM 36(4):719-737 + (October 1989) and references therein. + + * Use Sierpinski index as key by which to store 2-dimensional + data in a 1-dimensional data structure (such as a table). + Then locations that are near each other in 2-d space will + tend to be near each other in 1-d data structure; and + locations that are near in 1-d data structure will be near in + 2-d space. This can significantly speed retrieval from + secondary storage because contiguous regions in the plane + will tend to correspond to contiguous regions in secondary + storage. (This is a standard technique for managing CAD/CAM + or geographic data.) + + + `(require 'soundex)' + + - Function: soundex NAME + Computes the *soundex* hash of NAME. Returns a string of an + initial letter and up to three digits between 0 and 6. Soundex + supposedly has the property that names that sound similar in normal + English pronunciation tend to map to the same key. + + Soundex was a classic algorithm used for manual filing of personal + records before the advent of computers. It performs adequately for + English names but has trouble with other nationalities. + + See Knuth, Vol. 3 `Sorting and searching', pp 391-2 + + To manage unusual inputs, `soundex' omits all non-alphabetic + characters. Consequently, in this implementation: + + (soundex <string of blanks>) => "" + (soundex "") => "" + + Examples from Knuth: + + (map soundex '("Euler" "Gauss" "Hilbert" "Knuth" + "Lloyd" "Lukasiewicz")) + => ("E460" "G200" "H416" "K530" "L300" "L222") + + (map soundex '("Ellery" "Ghosh" "Heilbronn" "Kant" + "Ladd" "Lissajous")) + => ("E460" "G200" "H416" "K530" "L300" "L222") + + Some cases in which the algorithm fails (Knuth): + + (map soundex '("Rogers" "Rodgers")) => ("R262" "R326") + + (map soundex '("Sinclair" "St. Clair")) => ("S524" "S324") + + (map soundex '("Tchebysheff" "Chebyshev")) => ("T212" "C121") + + +File: slib.info, Node: Object, Next: Priority Queues, Prev: Hashing, Up: Data Structures + +Macroless Object System +----------------------- + + `(require 'object)' + + This is the Macroless Object System written by Wade Humeniuk +(whumeniu@datap.ca). Conceptual Tributes: *Note Yasos::, MacScheme's +%object, CLOS, Lack of R4RS macros. + +Concepts +-------- + +OBJECT + An object is an ordered association-list (by `eq?') of methods + (procedures). Methods can be added (`make-method!'), deleted + (`unmake-method!') and retrieved (`get-method'). Objects may + inherit methods from other objects. The object binds to the + environment it was created in, allowing closures to be used to + hide private procedures and data. + +GENERIC-METHOD + A generic-method associates (in terms of `eq?') object's method. + This allows scheme function style to be used for objects. The + calling scheme for using a generic method is `(generic-method + object param1 param2 ...)'. + +METHOD + A method is a procedure that exists in the object. To use a method + get-method must be called to look-up the method. Generic methods + implement the get-method functionality. Methods may be added to an + object associated with any scheme obj in terms of eq? + +GENERIC-PREDICATE + A generic method that returns a boolean value for any scheme obj. + +PREDICATE + A object's method asscociated with a generic-predicate. Returns + `#t'. + +Procedures +---------- + + - Function: make-object ANCESTOR ... + Returns an object. Current object implementation is a tagged + vector. ANCESTORs are optional and must be objects in terms of + object?. ANCESTORs methods are included in the object. Multiple + ANCESTORs might associate the same generic-method with a method. + In this case the method of the ANCESTOR first appearing in the + list is the one returned by `get-method'. + + - Function: object? OBJ + Returns boolean value whether OBJ was created by make-object. + + - Function: make-generic-method EXCEPTION-PROCEDURE + Returns a procedure which be associated with an object's methods. + If EXCEPTION-PROCEDURE is specified then it is used to process + non-objects. + + - Function: make-generic-predicate + Returns a boolean procedure for any scheme object. + + - Function: make-method! OBJECT GENERIC-METHOD METHOD + Associates METHOD to the GENERIC-METHOD in the object. The METHOD + overrides any previous association with the GENERIC-METHOD within + the object. Using `unmake-method!' will restore the object's + previous association with the GENERIC-METHOD. METHOD must be a + procedure. + + - Function: make-predicate! OBJECT GENERIC-PRECIATE + Makes a predicate method associated with the GENERIC-PREDICATE. + + - Function: unmake-method! OBJECT GENERIC-METHOD + Removes an object's association with a GENERIC-METHOD . + + - Function: get-method OBJECT GENERIC-METHOD + Returns the object's method associated (if any) with the + GENERIC-METHOD. If no associated method exists an error is + flagged. + +Examples +-------- + + (require 'object) + + (define instantiate (make-generic-method)) + + (define (make-instance-object . ancestors) + (define self (apply make-object + (map (lambda (obj) (instantiate obj)) ancestors))) + (make-method! self instantiate (lambda (self) self)) + self) + + (define who (make-generic-method)) + (define imigrate! (make-generic-method)) + (define emigrate! (make-generic-method)) + (define describe (make-generic-method)) + (define name (make-generic-method)) + (define address (make-generic-method)) + (define members (make-generic-method)) + + (define society + (let () + (define self (make-instance-object)) + (define population '()) + (make-method! self imigrate! + (lambda (new-person) + (if (not (eq? new-person self)) + (set! population (cons new-person population))))) + (make-method! self emigrate! + (lambda (person) + (if (not (eq? person self)) + (set! population + (comlist:remove-if (lambda (member) + (eq? member person)) + population))))) + (make-method! self describe + (lambda (self) + (map (lambda (person) (describe person)) population))) + (make-method! self who + (lambda (self) (map (lambda (person) (name person)) + population))) + (make-method! self members (lambda (self) population)) + self)) + + (define (make-person %name %address) + (define self (make-instance-object society)) + (make-method! self name (lambda (self) %name)) + (make-method! self address (lambda (self) %address)) + (make-method! self who (lambda (self) (name self))) + (make-method! self instantiate + (lambda (self) + (make-person (string-append (name self) "-son-of") + %address))) + (make-method! self describe + (lambda (self) (list (name self) (address self)))) + (imigrate! self) + self) + +Inverter Documentation +...................... + + Inheritance: + <inverter>::(<number> <description>) + Generic-methods + <inverter>::value => <number>::value + <inverter>::set-value! => <number>::set-value! + <inverter>::describe => <description>::describe + <inverter>::help + <inverter>::invert + <inverter>::inverter? + +Number Documention +.................. + + Inheritance + <number>::() + Slots + <number>::<x> + Generic Methods + <number>::value + <number>::set-value! + +Inverter code +............. + + (require 'object) + + (define value (make-generic-method (lambda (val) val))) + (define set-value! (make-generic-method)) + (define invert (make-generic-method + (lambda (val) + (if (number? val) + (/ 1 val) + (error "Method not supported:" val))))) + (define noop (make-generic-method)) + (define inverter? (make-generic-predicate)) + (define describe (make-generic-method)) + (define help (make-generic-method)) + + (define (make-number x) + (define self (make-object)) + (make-method! self value (lambda (this) x)) + (make-method! self set-value! + (lambda (this new-value) (set! x new-value))) + self) + + (define (make-description str) + (define self (make-object)) + (make-method! self describe (lambda (this) str)) + (make-method! self help (lambda (this) "Help not available")) + self) + + (define (make-inverter) + (let* ((self (make-object + (make-number 1) + (make-description "A number which can be inverted"))) + (<value> (get-method self value))) + (make-method! self invert (lambda (self) (/ 1 (<value> self)))) + (make-predicate! self inverter?) + (unmake-method! self help) + (make-method! self help + (lambda (self) + (display "Inverter Methods:") (newline) + (display " (value inverter) ==> n") (newline))) + self)) + + ;;;; Try it out + + (define invert! (make-generic-method)) + + (define x (make-inverter)) + + (make-method! x invert! (lambda (x) (set-value! x (/ 1 (value x))))) + + (value x) => 1 + (set-value! x 33) => undefined + (invert! x) => undefined + (value x) => 1/33 + + (unmake-method! x invert!) => undefined + + (invert! x) error--> ERROR: Method not supported: x + + +File: slib.info, Node: Priority Queues, Next: Queues, Prev: Object, Up: Data Structures + +Priority Queues +--------------- + + `(require 'priority-queue)' + + - Function: make-heap PRED<? + Returns a binary heap suitable which can be used for priority queue + operations. + + - Function: heap-length HEAP + Returns the number of elements in HEAP. + + - Procedure: heap-insert! HEAP ITEM + Inserts ITEM into HEAP. ITEM can be inserted multiple times. The + value returned is unspecified. + + - Function: heap-extract-max! HEAP + Returns the item which is larger than all others according to the + PRED<? argument to `make-heap'. If there are no items in HEAP, an + error is signaled. + + The algorithm for priority queues was taken from `Introduction to +Algorithms' by T. Cormen, C. Leiserson, R. Rivest. 1989 MIT Press. + + +File: slib.info, Node: Queues, Next: Records, Prev: Priority Queues, Up: Data Structures + +Queues +------ + + `(require 'queue)' + + A "queue" is a list where elements can be added to both the front and +rear, and removed from the front (i.e., they are what are often called +"dequeues"). A queue may also be used like a stack. + + - Function: make-queue + Returns a new, empty queue. + + - Function: queue? OBJ + Returns `#t' if OBJ is a queue. + + - Function: queue-empty? Q + Returns `#t' if the queue Q is empty. + + - Procedure: queue-push! Q DATUM + Adds DATUM to the front of queue Q. + + - Procedure: enquque! Q DATUM + Adds DATUM to the rear of queue Q. + + All of the following functions raise an error if the queue Q is empty. + + - Function: queue-front Q + Returns the datum at the front of the queue Q. + + - Function: queue-rear Q + Returns the datum at the rear of the queue Q. + + - Prcoedure: queue-pop! Q + - Procedure: dequeue! Q + Both of these procedures remove and return the datum at the front + of the queue. `queue-pop!' is used to suggest that the queue is + being used like a stack. + + +File: slib.info, Node: Records, Next: Structures, Prev: Queues, Up: Data Structures + +Records +------- + + `(require 'record)' + + The Record package provides a facility for user to define their own +record data types. + + - Function: make-record-type TYPE-NAME FIELD-NAMES + Returns a "record-type descriptor", a value representing a new data + type disjoint from all others. The TYPE-NAME argument must be a + string, but is only used for debugging purposes (such as the + printed representation of a record of the new type). The + FIELD-NAMES argument is a list of symbols naming the "fields" of a + record of the new type. It is an error if the list contains any + duplicates. It is unspecified how record-type descriptors are + represented. + + - Function: record-constructor RTD [FIELD-NAMES] + Returns a procedure for constructing new members of the type + represented by RTD. The returned procedure accepts exactly as + many arguments as there are symbols in the given list, + FIELD-NAMES; these are used, in order, as the initial values of + those fields in a new record, which is returned by the constructor + procedure. The values of any fields not named in that list are + unspecified. The FIELD-NAMES argument defaults to the list of + field names in the call to `make-record-type' that created the + type represented by RTD; if the FIELD-NAMES argument is provided, + it is an error if it contains any duplicates or any symbols not in + the default list. + + - Function: record-predicate RTD + Returns a procedure for testing membership in the type represented + by RTD. The returned procedure accepts exactly one argument and + returns a true value if the argument is a member of the indicated + record type; it returns a false value otherwise. + + - Function: record-accessor RTD FIELD-NAME + Returns a procedure for reading the value of a particular field of + a member of the type represented by RTD. The returned procedure + accepts exactly one argument which must be a record of the + appropriate type; it returns the current value of the field named + by the symbol FIELD-NAME in that record. The symbol FIELD-NAME + must be a member of the list of field-names in the call to + `make-record-type' that created the type represented by RTD. + + - Function: record-modifier RTD FIELD-NAME + Returns a procedure for writing the value of a particular field of + a member of the type represented by RTD. The returned procedure + accepts exactly two arguments: first, a record of the appropriate + type, and second, an arbitrary Scheme value; it modifies the field + named by the symbol FIELD-NAME in that record to contain the given + value. The returned value of the modifier procedure is + unspecified. The symbol FIELD-NAME must be a member of the list + of field-names in the call to `make-record-type' that created the + type represented by RTD. + + In May of 1996, as a product of discussion on the `rrrs-authors' +mailing list, I rewrote `record.scm' to portably implement type +disjointness for record data types. + + As long as an implementation's procedures are opaque and the `record' +code is loaded before other programs, this will give disjoint record +types which are unforgeable and incorruptible by R4RS procedures. + + As a consequence, the procedures `record?', `record-type-descriptor', +`record-type-name'.and `record-type-field-names' are no longer +supported. + + +File: slib.info, Node: Structures, Prev: Records, Up: Data Structures + +Structures +---------- + + `(require 'struct)' (uses defmacros) + + `defmacro's which implement "records" from the book `Essentials of +Programming Languages' by Daniel P. Friedman, M. Wand and C.T. Haynes. +Copyright 1992 Jeff Alexander, Shinnder Lee, and Lewis Patterson + + Matthew McDonald <mafm@cs.uwa.edu.au> added field setters. + + - Macro: define-record TAG (VAR1 VAR2 ...) + Defines several functions pertaining to record-name TAG: + + - Function: make-TAG VAR1 VAR2 ... + + - Function: TAG? OBJ + + - Function: TAG->VAR1 OBJ + + - Function: TAG->VAR2 OBJ + ... + + - Function: set-TAG-VAR1! OBJ VAL + + - Function: set-TAG-VAR2! OBJ VAL + ... + + Here is an example of its use. + + (define-record term (operator left right)) + => #<unspecified> + (define foo (make-term 'plus 1 2)) + => foo + (term->left foo) + => 1 + (set-term-left! foo 2345) + => #<unspecified> + (term->left foo) + => 2345 + + - Macro: variant-case EXP (TAG (VAR1 VAR2 ...) BODY) ... + executes the following for the matching clause: + + ((lambda (VAR1 VAR ...) BODY) + (TAG->VAR1 EXP) + (TAG->VAR2 EXP) ...) + + +File: slib.info, Node: Procedures, Next: Standards Support, Prev: Data Structures, Up: Other Packages + +Procedures +========== + + Anything that doesn't fall neatly into any of the other categories +winds up here. + +* Menu: + +* Common List Functions:: 'common-list-functions +* Tree Operations:: 'tree +* Chapter Ordering:: 'chapter-order +* Sorting:: 'sort +* Topological Sort:: Keep your socks on. +* String-Case:: 'string-case +* String Ports:: 'string-port +* String Search:: Also Search from a Port. +* Line I/O:: 'line-i/o +* Multi-Processing:: 'process + + +File: slib.info, Node: Common List Functions, Next: Tree Operations, Prev: Procedures, Up: Procedures + +Common List Functions +--------------------- + + `(require 'common-list-functions)' + + The procedures below follow the Common LISP equivalents apart from +optional arguments in some cases. + +* Menu: + +* List construction:: +* Lists as sets:: +* Lists as sequences:: +* Destructive list operations:: +* Non-List functions:: + + +File: slib.info, Node: List construction, Next: Lists as sets, Prev: Common List Functions, Up: Common List Functions + +List construction +................. + + - Function: make-list K . INIT + `make-list' creates and returns a list of K elements. If INIT is + included, all elements in the list are initialized to INIT. + + Example: + (make-list 3) + => (#<unspecified> #<unspecified> #<unspecified>) + (make-list 5 'foo) + => (foo foo foo foo foo) + + - Function: list* X . Y + Works like `list' except that the cdr of the last pair is the last + argument unless there is only one argument, when the result is + just that argument. Sometimes called `cons*'. E.g.: + (list* 1) + => 1 + (list* 1 2 3) + => (1 2 . 3) + (list* 1 2 '(3 4)) + => (1 2 3 4) + (list* ARGS '()) + == (list ARGS) + + - Function: copy-list LST + `copy-list' makes a copy of LST using new pairs and returns it. + Only the top level of the list is copied, i.e., pairs forming + elements of the copied list remain `eq?' to the corresponding + elements of the original; the copy is, however, not `eq?' to the + original, but is `equal?' to it. + + Example: + (copy-list '(foo foo foo)) + => (foo foo foo) + (define q '(foo bar baz bang)) + (define p q) + (eq? p q) + => #t + (define r (copy-list q)) + (eq? q r) + => #f + (equal? q r) + => #t + (define bar '(bar)) + (eq? bar (car (copy-list (list bar 'foo)))) + => #t + + +File: slib.info, Node: Lists as sets, Next: Lists as sequences, Prev: List construction, Up: Common List Functions + +Lists as sets +............. + + `eqv?' is used to test for membership by procedures which treat lists +as sets. + + - Function: adjoin E L + `adjoin' returns the adjoint of the element E and the list L. + That is, if E is in L, `adjoin' returns L, otherwise, it returns + `(cons E L)'. + + Example: + (adjoin 'baz '(bar baz bang)) + => (bar baz bang) + (adjoin 'foo '(bar baz bang)) + => (foo bar baz bang) + + - Function: union L1 L2 + `union' returns the combination of L1 and L2. Duplicates between + L1 and L2 are culled. Duplicates within L1 or within L2 may or + may not be removed. + + Example: + (union '(1 2 3 4) '(5 6 7 8)) + => (4 3 2 1 5 6 7 8) + (union '(1 2 3 4) '(3 4 5 6)) + => (2 1 3 4 5 6) + + - Function: intersection L1 L2 + `intersection' returns all elements that are in both L1 and L2. + + Example: + (intersection '(1 2 3 4) '(3 4 5 6)) + => (3 4) + (intersection '(1 2 3 4) '(5 6 7 8)) + => () + + - Function: set-difference L1 L2 + `set-difference' returns the union of all elements that are in L1 + but not in L2. + + Example: + (set-difference '(1 2 3 4) '(3 4 5 6)) + => (1 2) + (set-difference '(1 2 3 4) '(1 2 3 4 5 6)) + => () + + - Function: member-if PRED LST + `member-if' returns LST if `(PRED ELEMENT)' is `#t' for any + ELEMENT in LST. Returns `#f' if PRED does not apply to any + ELEMENT in LST. + + Example: + (member-if vector? '(1 2 3 4)) + => #f + (member-if number? '(1 2 3 4)) + => (1 2 3 4) + + - Function: some PRED LST . MORE-LSTS + PRED is a boolean function of as many arguments as there are list + arguments to `some' i.e., LST plus any optional arguments. PRED + is applied to successive elements of the list arguments in order. + `some' returns `#t' as soon as one of these applications returns + `#t', and is `#f' if none returns `#t'. All the lists should have + the same length. + + Example: + (some odd? '(1 2 3 4)) + => #t + + (some odd? '(2 4 6 8)) + => #f + + (some > '(2 3) '(1 4)) + => #f + + - Function: every PRED LST . MORE-LSTS + `every' is analogous to `some' except it returns `#t' if every + application of PRED is `#t' and `#f' otherwise. + + Example: + (every even? '(1 2 3 4)) + => #f + + (every even? '(2 4 6 8)) + => #t + + (every > '(2 3) '(1 4)) + => #f + + - Function: notany PRED . LST + `notany' is analogous to `some' but returns `#t' if no application + of PRED returns `#t' or `#f' as soon as any one does. + + - Function: notevery PRED . LST + `notevery' is analogous to `some' but returns `#t' as soon as an + application of PRED returns `#f', and `#f' otherwise. + + Example: + (notevery even? '(1 2 3 4)) + => #t + + (notevery even? '(2 4 6 8)) + => #f + + - Function: find-if PRED LST + `find-if' searches for the first ELEMENT in LST such that `(PRED + ELEMENT)' returns `#t'. If it finds any such ELEMENT in LST, + ELEMENT is returned. Otherwise, `#f' is returned. + + Example: + (find-if number? '(foo 1 bar 2)) + => 1 + + (find-if number? '(foo bar baz bang)) + => #f + + (find-if symbol? '(1 2 foo bar)) + => foo + + - Function: remove ELT LST + `remove' removes all occurrences of ELT from LST using `eqv?' to + test for equality and returns everything that's left. N.B.: other + implementations (Chez, Scheme->C and T, at least) use `equal?' as + the equality test. + + Example: + (remove 1 '(1 2 1 3 1 4 1 5)) + => (2 3 4 5) + + (remove 'foo '(bar baz bang)) + => (bar baz bang) + + - Function: remove-if PRED LST + `remove-if' removes all ELEMENTs from LST where `(PRED ELEMENT)' + is `#t' and returns everything that's left. + + Example: + (remove-if number? '(1 2 3 4)) + => () + + (remove-if even? '(1 2 3 4 5 6 7 8)) + => (1 3 5 7) + + - Function: remove-if-not PRED LST + `remove-if-not' removes all ELEMENTs from LST for which `(PRED + ELEMENT)' is `#f' and returns everything that's left. + + Example: + (remove-if-not number? '(foo bar baz)) + => () + (remove-if-not odd? '(1 2 3 4 5 6 7 8)) + => (1 3 5 7) + + - Function: has-duplicates? LST + returns `#t' if 2 members of LST are `equal?', `#f' otherwise. + + Example: + (has-duplicates? '(1 2 3 4)) + => #f + + (has-duplicates? '(2 4 3 4)) + => #t + + The procedure `remove-duplicates' uses `member' (rather than `memv'). + + - Function: remove-duplicates LST + returns a copy of LST with its duplicate members removed. + Elements are considered duplicate if they are `equal?'. + + Example: + (remove-duplicates '(1 2 3 4)) + => (4 3 2 1) + + (remove-duplicates '(2 4 3 4)) + => (3 4 2) + + +File: slib.info, Node: Lists as sequences, Next: Destructive list operations, Prev: Lists as sets, Up: Common List Functions + +Lists as sequences +.................. + + - Function: position OBJ LST + `position' returns the 0-based position of OBJ in LST, or `#f' if + OBJ does not occur in LST. + + Example: + (position 'foo '(foo bar baz bang)) + => 0 + (position 'baz '(foo bar baz bang)) + => 2 + (position 'oops '(foo bar baz bang)) + => #f + + - Function: reduce P LST + `reduce' combines all the elements of a sequence using a binary + operation (the combination is left-associative). For example, + using `+', one can add up all the elements. `reduce' allows you to + apply a function which accepts only two arguments to more than 2 + objects. Functional programmers usually refer to this as "foldl". + `collect:reduce' (*note Collections::.) provides a version of + `collect' generalized to collections. + + Example: + (reduce + '(1 2 3 4)) + => 10 + (define (bad-sum . l) (reduce + l)) + (bad-sum 1 2 3 4) + == (reduce + (1 2 3 4)) + == (+ (+ (+ 1 2) 3) 4) + => 10 + (bad-sum) + == (reduce + ()) + => () + (reduce string-append '("hello" "cruel" "world")) + == (string-append (string-append "hello" "cruel") "world") + => "hellocruelworld" + (reduce anything '()) + => () + (reduce anything '(x)) + => x + + What follows is a rather non-standard implementation of `reverse' + in terms of `reduce' and a combinator elsewhere called "C". + + ;;; Contributed by Jussi Piitulainen (jpiitula@ling.helsinki.fi) + + (define commute + (lambda (f) + (lambda (x y) + (f y x)))) + + (define reverse + (lambda (args) + (reduce-init (commute cons) '() args))) + + - Function: reduce-init P INIT LST + `reduce-init' is the same as reduce, except that it implicitly + inserts INIT at the start of the list. `reduce-init' is preferred + if you want to handle the null list, the one-element, and lists + with two or more elements consistently. It is common to use the + operator's idempotent as the initializer. Functional programmers + usually call this "foldl". + + Example: + (define (sum . l) (reduce-init + 0 l)) + (sum 1 2 3 4) + == (reduce-init + 0 (1 2 3 4)) + == (+ (+ (+ (+ 0 1) 2) 3) 4) + => 10 + (sum) + == (reduce-init + 0 '()) + => 0 + + (reduce-init string-append "@" '("hello" "cruel" "world")) + == + (string-append (string-append (string-append "@" "hello") + "cruel") + "world") + => "@hellocruelworld" + + Given a differentiation of 2 arguments, `diff', the following will + differentiate by any number of variables. + (define (diff* exp . vars) + (reduce-init diff exp vars)) + + Example: + ;;; Real-world example: Insertion sort using reduce-init. + + (define (insert l item) + (if (null? l) + (list item) + (if (< (car l) item) + (cons (car l) (insert (cdr l) item)) + (cons item l)))) + (define (insertion-sort l) (reduce-init insert '() l)) + + (insertion-sort '(3 1 4 1 5) + == (reduce-init insert () (3 1 4 1 5)) + == (insert (insert (insert (insert (insert () 3) 1) 4) 1) 5) + == (insert (insert (insert (insert (3)) 1) 4) 1) 5) + == (insert (insert (insert (1 3) 4) 1) 5) + == (insert (insert (1 3 4) 1) 5) + == (insert (1 1 3 4) 5) + => (1 1 3 4 5) + + - Function: last LST N + `last' returns the last N elements of LST. N must be a + non-negative integer. + + Example: + (last '(foo bar baz bang) 2) + => (baz bang) + (last '(1 2 3) 0) + => 0 + + - Function: butlast LST N + `butlast' returns all but the last N elements of LST. + + Example: + (butlast '(a b c d) 3) + => (a) + (butlast '(a b c d) 4) + => () + +`last' and `butlast' split a list into two parts when given identical +arugments. + (last '(a b c d e) 2) + => (d e) + (butlast '(a b c d e) 2) + => (a b c) + + - Function: nthcdr N LST + `nthcdr' takes N `cdr's of LST and returns the result. Thus + `(nthcdr 3 LST)' == `(cdddr LST)' + + Example: + (nthcdr 2 '(a b c d)) + => (c d) + (nthcdr 0 '(a b c d)) + => (a b c d) + + - Function: butnthcdr N LST + `butnthcdr' returns all but the nthcdr N elements of LST. + + Example: + (butnthcdr 3 '(a b c d)) + => (a b c) + (butnthcdr 4 '(a b c d)) + => () + +`nthcdr' and `butnthcdr' split a list into two parts when given +identical arugments. + (nthcdr 2 '(a b c d e)) + => (c d e) + (butnthcdr 2 '(a b c d e)) + => (a b) + + +File: slib.info, Node: Destructive list operations, Next: Non-List functions, Prev: Lists as sequences, Up: Common List Functions + +Destructive list operations +........................... + + These procedures may mutate the list they operate on, but any such +mutation is undefined. + + - Procedure: nconc ARGS + `nconc' destructively concatenates its arguments. (Compare this + with `append', which copies arguments rather than destroying them.) + Sometimes called `append!' (*note Rev2 Procedures::.). + + Example: You want to find the subsets of a set. Here's the + obvious way: + + (define (subsets set) + (if (null? set) + '(()) + (append (mapcar (lambda (sub) (cons (car set) sub)) + (subsets (cdr set))) + (subsets (cdr set))))) + But that does way more consing than you need. Instead, you could + replace the `append' with `nconc', since you don't have any need + for all the intermediate results. + + Example: + (define x '(a b c)) + (define y '(d e f)) + (nconc x y) + => (a b c d e f) + x + => (a b c d e f) + + `nconc' is the same as `append!' in `sc2.scm'. + + - Procedure: nreverse LST + `nreverse' reverses the order of elements in LST by mutating + `cdr's of the list. Sometimes called `reverse!'. + + Example: + (define foo '(a b c)) + (nreverse foo) + => (c b a) + foo + => (a) + + Some people have been confused about how to use `nreverse', + thinking that it doesn't return a value. It needs to be pointed + out that + (set! lst (nreverse lst)) + + is the proper usage, not + (nreverse lst) + The example should suffice to show why this is the case. + + - Procedure: delete ELT LST + - Procedure: delete-if PRED LST + - Procedure: delete-if-not PRED LST + Destructive versions of `remove' `remove-if', and `remove-if-not'. + + Example: + (define lst '(foo bar baz bang)) + (delete 'foo lst) + => (bar baz bang) + lst + => (foo bar baz bang) + + (define lst '(1 2 3 4 5 6 7 8 9)) + (delete-if odd? lst) + => (2 4 6 8) + lst + => (1 2 4 6 8) + + Some people have been confused about how to use `delete', + `delete-if', and `delete-if', thinking that they dont' return a + value. It needs to be pointed out that + (set! lst (delete el lst)) + + is the proper usage, not + (delete el lst) + The examples should suffice to show why this is the case. + + +File: slib.info, Node: Non-List functions, Prev: Destructive list operations, Up: Common List Functions + +Non-List functions +.................. + + - Function: and? . ARGS + `and?' checks to see if all its arguments are true. If they are, + `and?' returns `#t', otherwise, `#f'. (In contrast to `and', this + is a function, so all arguments are always evaluated and in an + unspecified order.) + + Example: + (and? 1 2 3) + => #t + (and #f 1 2) + => #f + + - Function: or? . ARGS + `or?' checks to see if any of its arguments are true. If any is + true, `or?' returns `#t', and `#f' otherwise. (To `or' as `and?' + is to `and'.) + + Example: + (or? 1 2 #f) + => #t + (or? #f #f #f) + => #f + + - Function: atom? OBJECT + Returns `#t' if OBJECT is not a pair and `#f' if it is pair. + (Called `atom' in Common LISP.) + (atom? 1) + => #t + (atom? '(1 2)) + => #f + (atom? #(1 2)) ; dubious! + => #t + + - Function: type-of OBJECT + Returns a symbol name for the type of OBJECT. + + - Function: coerce OBJECT RESULT-TYPE + Converts and returns OBJECT of type `char', `number', `string', + `symbol', `list', or `vector' to RESULT-TYPE (which must be one of + these symbols). + + +File: slib.info, Node: Tree Operations, Next: Chapter Ordering, Prev: Common List Functions, Up: Procedures + +Tree operations +--------------- + + `(require 'tree)' + + These are operations that treat lists a representations of trees. + + - Function: subst NEW OLD TREE + - Function: substq NEW OLD TREE + - Function: substv NEW OLD TREE + `subst' makes a copy of TREE, substituting NEW for every subtree + or leaf of TREE which is `equal?' to OLD and returns a modified + tree. The original TREE is unchanged, but may share parts with + the result. + + `substq' and `substv' are similar, but test against OLD using + `eq?' and `eqv?' respectively. + + Examples: + (substq 'tempest 'hurricane '(shakespeare wrote (the hurricane))) + => (shakespeare wrote (the tempest)) + (substq 'foo '() '(shakespeare wrote (twelfth night))) + => (shakespeare wrote (twelfth night . foo) . foo) + (subst '(a . cons) '(old . pair) + '((old . spice) ((old . shoes) old . pair) (old . pair))) + => ((old . spice) ((old . shoes) a . cons) (a . cons)) + + - Function: copy-tree TREE + Makes a copy of the nested list structure TREE using new pairs and + returns it. All levels are copied, so that none of the pairs in + the tree are `eq?' to the original ones - only the leaves are. + + Example: + (define bar '(bar)) + (copy-tree (list bar 'foo)) + => ((bar) foo) + (eq? bar (car (copy-tree (list bar 'foo)))) + => #f + + +File: slib.info, Node: Chapter Ordering, Next: Sorting, Prev: Tree Operations, Up: Procedures + +Chapter Ordering +---------------- + + `(require 'chapter-order)' + + The `chap:' functions deal with strings which are ordered like +chapter numbers (or letters) in a book. Each section of the string +consists of consecutive numeric or consecutive aphabetic characters of +like case. + + - Function: chap:string<? STRING1 STRING2 + Returns #t if the first non-matching run of alphabetic upper-case + or the first non-matching run of alphabetic lower-case or the first + non-matching run of numeric characters of STRING1 is `string<?' + than the corresponding non-matching run of characters of STRING2. + + (chap:string<? "a.9" "a.10") => #t + (chap:string<? "4c" "4aa") => #t + (chap:string<? "Revised^{3.99}" "Revised^{4}") => #t + + - Function: chap:string>? STRING1 STRING2 + - Function: chap:string<=? STRING1 STRING2 + - Function: chap:string>=? STRING1 STRING2 + Implement the corresponding chapter-order predicates. + + - Function: chap:next-string STRING + Returns the next string in the *chapter order*. If STRING has no + alphabetic or numeric characters, `(string-append STRING "0")' is + returnd. The argument to chap:next-string will always be + `chap:string<?' than the result. + + (chap:next-string "a.9") => "a.10" + (chap:next-string "4c") => "4d" + (chap:next-string "4z") => "4aa" + (chap:next-string "Revised^{4}") => "Revised^{5}" + + +File: slib.info, Node: Sorting, Next: Topological Sort, Prev: Chapter Ordering, Up: Procedures + +Sorting +------- + + `(require 'sort)' + + Many Scheme systems provide some kind of sorting functions. They do +not, however, always provide the *same* sorting functions, and those +that I have had the opportunity to test provided inefficient ones (a +common blunder is to use quicksort which does not perform well). + + Because `sort' and `sort!' are not in the standard, there is very +little agreement about what these functions look like. For example, +Dybvig says that Chez Scheme provides + (merge predicate list1 list2) + (merge! predicate list1 list2) + (sort predicate list) + (sort! predicate list) + +while MIT Scheme 7.1, following Common LISP, offers unstable + (sort list predicate) + +TI PC Scheme offers + (sort! list/vector predicate?) + +and Elk offers + (sort list/vector predicate?) + (sort! list/vector predicate?) + + Here is a comprehensive catalogue of the variations I have found. + + 1. Both `sort' and `sort!' may be provided. + + 2. `sort' may be provided without `sort!'. + + 3. `sort!' may be provided without `sort'. + + 4. Neither may be provided. + + 5. The sequence argument may be either a list or a vector. + + 6. The sequence argument may only be a list. + + 7. The sequence argument may only be a vector. + + 8. The comparison function may be expected to behave like `<'. + + 9. The comparison function may be expected to behave like `<='. + + 10. The interface may be `(sort predicate? sequence)'. + + 11. The interface may be `(sort sequence predicate?)'. + + 12. The interface may be `(sort sequence &optional (predicate? <))'. + + 13. The sort may be stable. + + 14. The sort may be unstable. + + All of this variation really does not help anybody. A nice simple +merge sort is both stable and fast (quite a lot faster than *quick* +sort). + + I am providing this source code with no restrictions at all on its use +(but please retain D.H.D.Warren's credit for the original idea). You +may have to rename some of these functions in order to use them in a +system which already provides incompatible or inferior sorts. For each +of the functions, only the top-level define needs to be edited to do +that. + + I could have given these functions names which would not clash with +any Scheme that I know of, but I would like to encourage implementors to +converge on a single interface, and this may serve as a hint. The +argument order for all functions has been chosen to be as close to +Common LISP as made sense, in order to avoid NIH-itis. + + Each of the five functions has a required *last* parameter which is a +comparison function. A comparison function `f' is a function of 2 +arguments which acts like `<'. For example, + + (not (f x x)) + (and (f x y) (f y z)) == (f x z) + + The standard functions `<', `>', `char<?', `char>?', `char-ci<?', +`char-ci>?', `string<?', `string>?', `string-ci<?', and `string-ci>?' +are suitable for use as comparison functions. Think of `(less? x y)' +as saying when `x' must *not* precede `y'. + + - Function: sorted? SEQUENCE LESS? + Returns `#t' when the sequence argument is in non-decreasing order + according to LESS? (that is, there is no adjacent pair `... x y + ...' for which `(less? y x)'). + + Returns `#f' when the sequence contains at least one out-of-order + pair. It is an error if the sequence is neither a list nor a + vector. + + - Function: merge LIST1 LIST2 LESS? + This merges two lists, producing a completely new list as result. + I gave serious consideration to producing a Common-LISP-compatible + version. However, Common LISP's `sort' is our `sort!' (well, in + fact Common LISP's `stable-sort' is our `sort!', merge sort is + *fast* as well as stable!) so adapting CL code to Scheme takes a + bit of work anyway. I did, however, appeal to CL to determine the + *order* of the arguments. + + - Procedure: merge! LIST1 LIST2 LESS? + Merges two lists, re-using the pairs of LIST1 and LIST2 to build + the result. If the code is compiled, and LESS? constructs no new + pairs, no pairs at all will be allocated. The first pair of the + result will be either the first pair of LIST1 or the first pair of + LIST2, but you can't predict which. + + The code of `merge' and `merge!' could have been quite a bit + simpler, but they have been coded to reduce the amount of work + done per iteration. (For example, we only have one `null?' test + per iteration.) + + - Function: sort SEQUENCE LESS? + Accepts either a list or a vector, and returns a new sequence + which is sorted. The new sequence is the same type as the input. + Always `(sorted? (sort sequence less?) less?)'. The original + sequence is not altered in any way. The new sequence shares its + *elements* with the old one; no elements are copied. + + - Procedure: sort! SEQUENCE LESS? + Returns its sorted result in the original boxes. If the original + sequence is a list, no new storage is allocated at all. If the + original sequence is a vector, the sorted elements are put back in + the same vector. + + Some people have been confused about how to use `sort!', thinking + that it doesn't return a value. It needs to be pointed out that + (set! slist (sort! slist <)) + + is the proper usage, not + (sort! slist <) + + Note that these functions do *not* accept a CL-style `:key' argument. +A simple device for obtaining the same expressiveness is to define + (define (keyed less? key) + (lambda (x y) (less? (key x) (key y)))) + +and then, when you would have written + (sort a-sequence #'my-less :key #'my-key) + +in Common LISP, just write + (sort! a-sequence (keyed my-less? my-key)) + +in Scheme. + + +File: slib.info, Node: Topological Sort, Next: String-Case, Prev: Sorting, Up: Procedures + +Topological Sort +---------------- + + `(require 'topological-sort)' or `(require 'tsort)' + +The algorithm is inspired by Cormen, Leiserson and Rivest (1990) +`Introduction to Algorithms', chapter 23. + + - Function: tsort DAG PRED + - Function: topological-sort DAG PRED + where + DAG + is a list of sublists. The car of each sublist is a vertex. + The cdr is the adjacency list of that vertex, i.e. a list of + all vertices to which there exists an edge from the car + vertex. + + PRED + is one of `eq?', `eqv?', `equal?', `=', `char=?', + `char-ci=?', `string=?', or `string-ci=?'. + + Sort the directed acyclic graph DAG so that for every edge from + vertex U to V, U will come before V in the resulting list of + vertices. + + Time complexity: O (|V| + |E|) + + Example (from Cormen): + Prof. Bumstead topologically sorts his clothing when getting + dressed. The first argument to `tsort' describes which + garments he needs to put on before others. (For example, + Prof Bumstead needs to put on his shirt before he puts on his + tie or his belt.) `tsort' gives the correct order of + dressing: + + (require 'tsort) + (tsort '((shirt tie belt) + (tie jacket) + (belt jacket) + (watch) + (pants shoes belt) + (undershorts pants shoes) + (socks shoes)) + eq?) + => + (socks undershorts pants shoes watch shirt belt tie jacket) + + +File: slib.info, Node: String-Case, Next: String Ports, Prev: Topological Sort, Up: Procedures + +String-Case +----------- + + `(require 'string-case)' + + - Procedure: string-upcase STR + - Procedure: string-downcase STR + - Procedure: string-capitalize STR + The obvious string conversion routines. These are non-destructive. + + - Function: string-upcase! STR + - Function: string-downcase! STR + - Function: string-captialize! STR + The destructive versions of the functions above. + + - Function: string-ci->symbol STR + Converts string STR to a symbol having the same case as if the + symbol had been `read'. + + +File: slib.info, Node: String Ports, Next: String Search, Prev: String-Case, Up: Procedures + +String Ports +------------ + + `(require 'string-port)' + + - Procedure: call-with-output-string PROC + PROC must be a procedure of one argument. This procedure calls + PROC with one argument: a (newly created) output port. When the + function returns, the string composed of the characters written + into the port is returned. + + - Procedure: call-with-input-string STRING PROC + PROC must be a procedure of one argument. This procedure calls + PROC with one argument: an (newly created) input port from which + STRING's contents may be read. When PROC returns, the port is + closed and the value yielded by the procedure PROC is returned. + + +File: slib.info, Node: String Search, Next: Line I/O, Prev: String Ports, Up: Procedures + +String Search +------------- + + `(require 'string-search)' + + - Procedure: string-index STRING CHAR + - Procedure: string-index-ci STRING CHAR + Returns the index of the first occurence of CHAR within STRING, or + `#f' if the STRING does not contain a character CHAR. + + - Procedure: string-reverse-index STRING CHAR + - Procedure: string-reverse-index-ci STRING CHAR + Returns the index of the last occurence of CHAR within STRING, or + `#f' if the STRING does not contain a character CHAR. + + - procedure: substring? PATTERN STRING + - procedure: substring-ci? PATTERN STRING + Searches STRING to see if some substring of STRING is equal to + PATTERN. `substring?' returns the index of the first character of + the first substring of STRING that is equal to PATTERN; or `#f' if + STRING does not contain PATTERN. + + (substring? "rat" "pirate") => 2 + (substring? "rat" "outrage") => #f + (substring? "" any-string) => 0 + + - Procedure: find-string-from-port? STR IN-PORT MAX-NO-CHARS + Looks for a string STR within the first MAX-NO-CHARS chars of the + input port IN-PORT. + + - Procedure: find-string-from-port? STR IN-PORT + When called with two arguments, the search span is limited by the + end of the input stream. + + - Procedure: find-string-from-port? STR IN-PORT CHAR + Searches up to the first occurrence of character CHAR in STR. + + - Procedure: find-string-from-port? STR IN-PORT PROC + Searches up to the first occurrence of the procedure PROC + returning non-false when called with a character (from IN-PORT) + argument. + + When the STR is found, `find-string-from-port?' returns the number + of characters it has read from the port, and the port is set to + read the first char after that (that is, after the STR) The + function returns `#f' when the STR isn't found. + + `find-string-from-port?' reads the port *strictly* sequentially, + and does not perform any buffering. So `find-string-from-port?' + can be used even if the IN-PORT is open to a pipe or other + communication channel. + + - Function: string-subst TXT OLD1 NEW1 ... + Returns a copy of string TXT with all occurrences of string OLD1 + in TXT replaced with NEW1, OLD2 replaced with NEW2 .... + + +File: slib.info, Node: Line I/O, Next: Multi-Processing, Prev: String Search, Up: Procedures + +Line I/O +-------- + + `(require 'line-i/o)' + + - Function: read-line + - Function: read-line PORT + Returns a string of the characters up to, but not including a + newline or end of file, updating PORT to point to the character + following the newline. If no characters are available, an end of + file object is returned. The PORT argument may be omitted, in + which case it defaults to the value returned by + `current-input-port'. + + - Function: read-line! STRING + - Function: read-line! STRING PORT + Fills STRING with characters up to, but not including a newline or + end of file, updating the PORT to point to the last character read + or following the newline if it was read. If no characters are + available, an end of file object is returned. If a newline or end + of file was found, the number of characters read is returned. + Otherwise, `#f' is returned. The PORT argument may be omitted, in + which case it defaults to the value returned by + `current-input-port'. + + - Function: write-line STRING + - Function: write-line STRING PORT + Writes STRING followed by a newline to the given PORT and returns + an unspecified value. The PORT argument may be omited, in which + case it defaults to the value returned by `current-input-port'. + + - Function: display-file PATH + - Function: display-file PATH PORT + Displays the contents of the file named by PATH to PORT. The PORT + argument may be ommited, in which case it defaults to the value + returned by `current-output-port'. + + +File: slib.info, Node: Multi-Processing, Prev: Line I/O, Up: Procedures + +Multi-Processing +---------------- + + `(require 'process)' + + This module implements asynchronous (non-polled) time-sliced +multi-processing in the SCM Scheme implementation using procedures +`alarm' and `alarm-interrupt'. Until this is ported to another +implementation, consider it an example of writing schedulers in Scheme. + + - Procedure: add-process! PROC + Adds proc, which must be a procedure (or continuation) capable of + accepting accepting one argument, to the `process:queue'. The + value returned is unspecified. The argument to PROC should be + ignored. If PROC returns, the process is killed. + + - Procedure: process:schedule! + Saves the current process on `process:queue' and runs the next + process from `process:queue'. The value returned is unspecified. + + - Procedure: kill-process! + Kills the current process and runs the next process from + `process:queue'. If there are no more processes on + `process:queue', `(slib:exit)' is called (*note System::.). + + +File: slib.info, Node: Standards Support, Next: Session Support, Prev: Procedures, Up: Other Packages + +Standards Support +================= + +* Menu: + +* With-File:: 'with-file +* Transcripts:: 'transcript +* Rev2 Procedures:: 'rev2-procedures +* Rev4 Optional Procedures:: 'rev4-optional-procedures +* Multi-argument / and -:: 'multiarg/and- +* Multi-argument Apply:: 'multiarg-apply +* Rationalize:: 'rationalize +* Promises:: 'promise +* Dynamic-Wind:: 'dynamic-wind +* Eval:: 'eval +* Values:: 'values + + +File: slib.info, Node: With-File, Next: Transcripts, Prev: Standards Support, Up: Standards Support + +With-File +--------- + + `(require 'with-file)' + + - Function: with-input-from-file FILE THUNK + - Function: with-output-to-file FILE THUNK + Description found in R4RS. + + +File: slib.info, Node: Transcripts, Next: Rev2 Procedures, Prev: With-File, Up: Standards Support + +Transcripts +----------- + + `(require 'transcript)' + + - Function: transcript-on FILENAME + - Function: transcript-off FILENAME + Redefines `read-char', `read', `write-char', `write', `display', + and `newline'. + + +File: slib.info, Node: Rev2 Procedures, Next: Rev4 Optional Procedures, Prev: Transcripts, Up: Standards Support + +Rev2 Procedures +--------------- + + `(require 'rev2-procedures)' + + The procedures below were specified in the `Revised^2 Report on +Scheme'. *N.B.*: The symbols `1+' and `-1+' are not `R4RS' syntax. +Scheme->C, for instance, barfs on this module. + + - Procedure: substring-move-left! STRING1 START1 END1 STRING2 START2 + - Procedure: substring-move-right! STRING1 START1 END1 STRING2 START2 + STRING1 and STRING2 must be a strings, and START1, START2 and END1 + must be exact integers satisfying + + 0 <= START1 <= END1 <= (string-length STRING1) + 0 <= START2 <= END1 - START1 + START2 <= (string-length STRING2) + + `substring-move-left!' and `substring-move-right!' store + characters of STRING1 beginning with index START1 (inclusive) and + ending with index END1 (exclusive) into STRING2 beginning with + index START2 (inclusive). + + `substring-move-left!' stores characters in time order of + increasing indices. `substring-move-right!' stores characters in + time order of increasing indeces. + + - Procedure: substring-fill! STRING START END CHAR + Fills the elements START-END of STRING with the character CHAR. + + - Function: string-null? STR + == `(= 0 (string-length STR))' + + - Procedure: append! . PAIRS + Destructively appends its arguments. Equivalent to `nconc'. + + - Function: 1+ N + Adds 1 to N. + + - Function: -1+ N + Subtracts 1 from N. + + - Function: <? + - Function: <=? + - Function: =? + - Function: >? + - Function: >=? + These are equivalent to the procedures of the same name but + without the trailing `?'. + + +File: slib.info, Node: Rev4 Optional Procedures, Next: Multi-argument / and -, Prev: Rev2 Procedures, Up: Standards Support + +Rev4 Optional Procedures +------------------------ + + `(require 'rev4-optional-procedures)' + + For the specification of these optional procedures, *Note Standard +procedures: (r4rs)Standard procedures. + + - Function: list-tail L P + + - Function: string->list S + + - Function: list->string L + + - Function: string-copy + + - Procedure: string-fill! S OBJ + + - Function: list->vector L + + - Function: vector->list S + + - Procedure: vector-fill! S OBJ + + +File: slib.info, Node: Multi-argument / and -, Next: Multi-argument Apply, Prev: Rev4 Optional Procedures, Up: Standards Support + +Multi-argument / and - +---------------------- + + `(require 'mutliarg/and-)' + + For the specification of these optional forms, *Note Numerical +operations: (r4rs)Numerical operations. The `two-arg:'* forms are only +defined if the implementation does not support the many-argument forms. + + - Function: two-arg:/ N1 N2 + The original two-argument version of `/'. + + - Function: / DIVIDENT . DIVISORS + + - Function: two-arg:- N1 N2 + The original two-argument version of `-'. + + - Function: - MINUEND . SUBTRAHENDS + + +File: slib.info, Node: Multi-argument Apply, Next: Rationalize, Prev: Multi-argument / and -, Up: Standards Support + +Multi-argument Apply +-------------------- + + `(require 'multiarg-apply)' + +For the specification of this optional form, *Note Control features: +(r4rs)Control features. + + - Function: two-arg:apply PROC L + The implementation's native `apply'. Only defined for + implementations which don't support the many-argument version. + + - Function: apply PROC . ARGS + + +File: slib.info, Node: Rationalize, Next: Promises, Prev: Multi-argument Apply, Up: Standards Support + +Rationalize +----------- + + `(require 'rationalize)' + + The procedure rationalize is interesting because most programming +languages do not provide anything analogous to it. For simplicity, we +present an algorithm which computes the correct result for exact +arguments (provided the implementation supports exact rational numbers +of unlimited precision), and produces a reasonable answer for inexact +arguments when inexact arithmetic is implemented using floating-point. +We thank Alan Bawden for contributing this algorithm. + + - Function: rationalize X E + + +File: slib.info, Node: Promises, Next: Dynamic-Wind, Prev: Rationalize, Up: Standards Support + +Promises +-------- + + `(require 'promise)' + + - Function: make-promise PROC + + Change occurrences of `(delay EXPRESSION)' to `(make-promise (lambda +() EXPRESSION))' and `(define force promise:force)' to implement +promises if your implementation doesn't support them (*note Control +features: (r4rs)Control features.). + + +File: slib.info, Node: Dynamic-Wind, Next: Eval, Prev: Promises, Up: Standards Support + +Dynamic-Wind +------------ + + `(require 'dynamic-wind)' + + This facility is a generalization of Common LISP `unwind-protect', +designed to take into account the fact that continuations produced by +`call-with-current-continuation' may be reentered. + + - Procedure: dynamic-wind THUNK1 THUNK2 THUNK3 + The arguments THUNK1, THUNK2, and THUNK3 must all be procedures of + no arguments (thunks). + + `dynamic-wind' calls THUNK1, THUNK2, and then THUNK3. The value + returned by THUNK2 is returned as the result of `dynamic-wind'. + THUNK3 is also called just before control leaves the dynamic + context of THUNK2 by calling a continuation created outside that + context. Furthermore, THUNK1 is called before reentering the + dynamic context of THUNK2 by calling a continuation created inside + that context. (Control is inside the context of THUNK2 if THUNK2 + is on the current return stack). + + *Warning:* There is no provision for dealing with errors or + interrupts. If an error or interrupt occurs while using + `dynamic-wind', the dynamic environment will be that in effect at + the time of the error or interrupt. + + +File: slib.info, Node: Eval, Next: Values, Prev: Dynamic-Wind, Up: Standards Support + +Eval +---- + + `(require 'eval)' + + - Function: eval EXPRESSION ENVIRONMENT-SPECIFIER + Evaluates EXPRESSION in the specified environment and returns its + value. EXPRESSION must be a valid Scheme expression represented + as data, and ENVIRONMENT-SPECIFIER must be a value returned by one + of the three procedures described below. Implementations may + extend `eval' to allow non-expression programs (definitions) as + the first argument and to allow other values as environments, with + the restriction that `eval' is not allowed to create new bindings + in the environments associated with `null-environment' or + `scheme-report-environment'. + + (eval '(* 7 3) (scheme-report-environment 5)) + => 21 + + (let ((f (eval '(lambda (f x) (f x x)) + (null-environment)))) + (f + 10)) + => 20 + + - Function: scheme-report-environment VERSION + - Function: null-environment VERSION + - Function: null-environment + VERSION must be an exact non-negative integer N corresponding to a + version of one of the Revised^N Reports on Scheme. + `Scheme-report-environment' returns a specifier for an environment + that contains the set of bindings specified in the corresponding + report that the implementation supports. `Null-environment' + returns a specifier for an environment that contains only the + (syntactic) bindings for all the syntactic keywords defined in the + given version of the report. + + Not all versions may be available in all implementations at all + times. However, an implementation that conforms to version N of + the Revised^N Reports on Scheme must accept version N. An error + is signalled if the specified version is not available. + + The effect of assigning (through the use of `eval') a variable + bound in a `scheme-report-environment' (for example `car') is + unspecified. Thus the environments specified by + `scheme-report-environment' may be immutable. + + + - Function: interaction-environment + This optional procedure returns a specifier for the environment + that contains implementation-defined bindings, typically a + superset of those listed in the report. The intent is that this + procedure will return the environment in which the implementation + would evaluate expressions dynamically typed by the user. + +Here are some more `eval' examples: + + (require 'eval) + => #<unspecified> + (define car 'volvo) + => #<unspecified> + car + => volvo + (eval 'car (interaction-environment)) + => volvo + (eval 'car (scheme-report-environment 5)) + => #<primitive-procedure car> + (eval '(eval 'car (interaction-environment)) + (scheme-report-environment 5)) + => volvo + (eval '(eval '(set! car 'buick) (interaction-environment)) + (scheme-report-environment 5)) + => #<unspecified> + car + => buick + (eval 'car (scheme-report-environment 5)) + => #<primitive-procedure car> + (eval '(eval 'car (interaction-environment)) + (scheme-report-environment 5)) + => buick + + +File: slib.info, Node: Values, Prev: Eval, Up: Standards Support + +Values +------ + + `(require 'values)' + + - Function: values OBJ ... + `values' takes any number of arguments, and passes (returns) them + to its continuation. + + - Function: call-with-values THUNK PROC + THUNK must be a procedure of no arguments, and PROC must be a + procedure. `call-with-values' calls THUNK with a continuation + that, when passed some values, calls PROC with those values as + arguments. + + Except for continuations created by the `call-with-values' + procedure, all continuations take exactly one value, as now; the + effect of passing no value or more than one value to continuations + that were not created by the `call-with-values' procedure is + unspecified. + + +File: slib.info, Node: Session Support, Next: Extra-SLIB Packages, Prev: Standards Support, Up: Other Packages + +Session Support +=============== + +* Menu: + +* Repl:: Macros at top-level +* Quick Print:: Loop-safe Output +* Debug:: To err is human ... +* Breakpoints:: Pause execution +* Trace:: 'trace +* System Interface:: 'system, 'getenv, and 'net-clients + + +File: slib.info, Node: Repl, Next: Quick Print, Prev: Session Support, Up: Session Support + +Repl +---- + + `(require 'repl)' + + Here is a read-eval-print-loop which, given an eval, evaluates forms. + + - Procedure: repl:top-level REPL:EVAL + `read's, `repl:eval's and `write's expressions from + `(current-input-port)' to `(current-output-port)' until an + end-of-file is encountered. `load', `slib:eval', `slib:error', + and `repl:quit' dynamically bound during `repl:top-level'. + + - Procedure: repl:quit + Exits from the invocation of `repl:top-level'. + + The `repl:' procedures establish, as much as is possible to do +portably, a top level environment supporting macros. `repl:top-level' +uses `dynamic-wind' to catch error conditions and interrupts. If your +implementation supports this you are all set. + + Otherwise, if there is some way your implementation can catch error +conditions and interrupts, then have them call `slib:error'. It will +display its arguments and reenter `repl:top-level'. `slib:error' +dynamically bound by `repl:top-level'. + + To have your top level loop always use macros, add any interrupt +catching lines and the following lines to your Scheme init file: + (require 'macro) + (require 'repl) + (repl:top-level macro:eval) + + +File: slib.info, Node: Quick Print, Next: Debug, Prev: Repl, Up: Session Support + +Quick Print +----------- + + `(require 'qp)' + +When displaying error messages and warnings, it is paramount that the +output generated for circular lists and large data structures be +limited. This section supplies a procedure to do this. It could be +much improved. + + Notice that the neccessity for truncating output eliminates + Common-Lisp's *Note Format:: from consideration; even when + variables `*print-level*' and `*print-level*' are set, huge + strings and bit-vectors are *not* limited. + + - Procedure: qp ARG1 ... + - Procedure: qpn ARG1 ... + - Procedure: qpr ARG1 ... + `qp' writes its arguments, separated by spaces, to + `(current-output-port)'. `qp' compresses printing by substituting + `...' for substructure it does not have sufficient room to print. + `qpn' is like `qp' but outputs a newline before returning. `qpr' + is like `qpn' except that it returns its last argument. + + - Variable: *qp-width* + `*qp-width*' is the largest number of characters that `qp' should + use. + + +File: slib.info, Node: Debug, Next: Breakpoints, Prev: Quick Print, Up: Session Support + +Debug +----- + + `(require 'debug)' + +Requiring `debug' automatically requires `trace' and `break'. + +An application with its own datatypes may want to substitute its own +printer for `qp'. This example shows how to do this: + + (define qpn (lambda args) ...) + (provide 'qp) + (require 'debug) + + - Procedure: trace-all FILE + Traces (*note Trace::.) all procedures `define'd at top-level in + file `file'. + + - Procedure: break-all FILE + Breakpoints (*note Breakpoints::.) all procedures `define'd at + top-level in file `file'. + + +File: slib.info, Node: Breakpoints, Next: Trace, Prev: Debug, Up: Session Support + +Breakpoints +----------- + + `(require 'break)' + + - Function: init-debug + If your Scheme implementation does not support `break' or `abort', + a message will appear when you `(require 'break)' or `(require + 'debug)' telling you to type `(init-debug)'. This is in order to + establish a top-level continuation. Typing `(init-debug)' at top + level sets up a continuation for `break'. + + - Function: breakpoint ARG1 ... + Returns from the top level continuation and pushes the + continuation from which it was called on a continuation stack. + + - Function: continue + Pops the topmost continuation off of the continuation stack and + returns an unspecified value to it. + + - Function: continue ARG1 ... + Pops the topmost continuation off of the continuation stack and + returns ARG1 ... to it. + + - Macro: break PROC1 ... + Redefines the top-level named procedures given as arguments so that + `breakpoint' is called before calling PROC1 .... + + - Macro: break + With no arguments, makes sure that all the currently broken + identifiers are broken (even if those identifiers have been + redefined) and returns a list of the broken identifiers. + + - Macro: unbreak PROC1 ... + Turns breakpoints off for its arguments. + + - Macro: unbreak + With no arguments, unbreaks all currently broken identifiers and + returns a list of these formerly broken identifiers. + + The following routines are the procedures which actually do the +tracing when this module is supplied by SLIB, rather than natively. If +defmacros are not natively supported by your implementation, these might +be more convenient to use. + + - Function: breakf PROC + - Function: breakf PROC NAME + - Function: debug:breakf PROC + - Function: debug:breakf PROC NAME + To break, type + (set! SYMBOL (breakf SYMBOL)) + + or + (set! SYMBOL (breakf SYMBOL 'SYMBOL)) + + or + (define SYMBOL (breakf FUNCTION)) + + or + (define SYMBOL (breakf FUNCTION 'SYMBOL)) + + - Function: unbreakf PROC + - Function: debug:unbreakf PROC + To unbreak, type + (set! SYMBOL (unbreakf SYMBOL)) + + +File: slib.info, Node: Trace, Next: System Interface, Prev: Breakpoints, Up: Session Support + +Tracing +------- + + `(require 'trace)' + + - Macro: trace PROC1 ... + Traces the top-level named procedures given as arguments. + + - Macro: trace + With no arguments, makes sure that all the currently traced + identifiers are traced (even if those identifiers have been + redefined) and returns a list of the traced identifiers. + + - Macro: untrace PROC1 ... + Turns tracing off for its arguments. + + - Macro: untrace + With no arguments, untraces all currently traced identifiers and + returns a list of these formerly traced identifiers. + + The following routines are the procedures which actually do the +tracing when this module is supplied by SLIB, rather than natively. If +defmacros are not natively supported by your implementation, these might +be more convenient to use. + + - Function: tracef PROC + - Function: tracef PROC NAME + - Function: debug:tracef PROC + - Function: debug:tracef PROC NAME + To trace, type + (set! SYMBOL (tracef SYMBOL)) + + or + (set! SYMBOL (tracef SYMBOL 'SYMBOL)) + + or + (define SYMBOL (tracef FUNCTION)) + + or + (define SYMBOL (tracef FUNCTION 'SYMBOL)) + + - Function: untracef PROC + - Function: debug:untracef PROC + To untrace, type + (set! SYMBOL (untracef SYMBOL)) + + +File: slib.info, Node: System Interface, Prev: Trace, Up: Session Support + +System Interface +---------------- + +If `(provided? 'getenv)': + + - Function: getenv NAME + Looks up NAME, a string, in the program environment. If NAME is + found a string of its value is returned. Otherwise, `#f' is + returned. + +If `(provided? 'system)': + + - Function: system COMMAND-STRING + Executes the COMMAND-STRING on the computer and returns the + integer status code. + +If `system' is provided by the Scheme implementation, the "net-clients" +package provides interfaces to common network client programs like FTP, +mail, and Netscape. + + `(require 'net-clients)' + + - Function: call-with-tmpnam PROC + - Function: call-with-tmpnam PROC K + Calls PROC with K arguments, strings returned by successive calls + to `tmpnam'. If PROC returns, then any files named by the + arguments to PROC are deleted automatically and the value(s) + yielded by the PROC is(are) returned. K may be ommited, in which + case it defaults to `1'. + + - Function: user-email-address + `user-email-address' returns a string of the form + `username@hostname'. If this e-mail address cannot be obtained, + #f is returned. + + - Function: current-directory + `current-directory' returns a string containing the absolute file + name representing the current working directory. If this string + cannot be obtained, #f is returned. + + If `current-directory' cannot be supported by the platform, the + value of `current-directory' is #f. + + - Function: make-directory NAME + Creates a sub-directory NAME of the current-directory. If + successful, `make-directory' returns #t; otherwise #f. + + - Function: null-directory? FILE-NAME + Returns #t if changing directory to FILE-NAME makes the current + working directory the same as it is before changing directory; + otherwise returns #f. + + - Function: absolute-path? FILE-NAME + Returns #t if FILE-NAME is a fully specified pathname (does not + depend on the current working directory); otherwise returns #f. + + - Function: glob-pattern? STR + Returns #t if the string STR contains characters used for + specifying glob patterns, namely `*', `?', or `['. + + - Function: parse-ftp-address URL + Returns a list of the decoded FTP URL; or #f if indecipherable. + FTP "Uniform Resource Locator", "ange-ftp", and "getit" formats + are handled. The returned list has four elements which are + strings or #f: + + 0. username + + 1. password + + 2. remote-site + + 3. remote-directory + + - Function: ftp-upload PATHS USER PASSWORD REMOTE-SITE REMOTE-DIR + PASSWORD must be a non-empty string or #f. PATHS must be a + non-empty list of pathnames or Glob patterns (*note Filenames::.) + matching files to transfer. + + `ftp-upload' puts the files specified by PATHS into the REMOTE-DIR + directory of FTP REMOTE-SITE using name USER with (optional) + PASSWORD. + + If PASSWORD is #f and USER is not `ftp' or `anonymous', then USER + is ignored; FTP takes the username and password from the `.netrc' + or equivalent file. + + - Function: path->url PATH + Returns a URL-string for PATH on the local host. + + - Function: browse-url-netscape URL + If a `netscape' browser is running, `browse-url-netscape' causes + the browser to display the page specified by string URL and + returns #t. + + If the browser is not running, `browse-url-netscape' runs + `netscape' with the argument URL. If the browser starts as a | + background job, `browse-url-netscape' returns #t immediately; if | + the browser starts as a foreground job, then `browse-url-netscape' | + returns #t when the browser exits; otherwise it returns #f. | + + +File: slib.info, Node: Extra-SLIB Packages, Prev: Session Support, Up: Other Packages + +Extra-SLIB Packages +=================== + + Several Scheme packages have been written using SLIB. There are +several reasons why a package might not be included in the SLIB +distribution: + * Because it requires special hardware or software which is not + universal. + + * Because it is large and of limited interest to most Scheme users. + + * Because it has copying terms different enough from the other SLIB + packages that its inclusion would cause confusion. + + * Because it is an application program, rather than a library module. + + * Because I have been too busy to integrate it. + + Once an optional package is installed (and an entry added to +`*catalog*', the `require' mechanism allows it to be called up and used +as easily as any other SLIB package. Some optional packages (for which +`*catalog*' already has entries) available from SLIB sites are: + +SLIB-PSD is a portable debugger for Scheme (requires emacs editor). + http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz | + ftp.gnu.org:pub/gnu/jacal/slib-psd1-3.tar.gz + ftp.maths.tcd.ie:pub/bosullvn/jacal/slib-psd1-3.tar.gz + ftp.cs.indiana.edu:/pub/scheme-repository/utl/slib-psd1-3.tar.gz + + With PSD, you can run a Scheme program in an Emacs buffer, set + breakpoints, single step evaluation and access and modify the + program's variables. It works by instrumenting the original source + code, so it should run with any R4RS compliant Scheme. It has been + tested with SCM, Elk 1.5, and the sci interpreter in the Scheme->C + system, but should work with other Schemes with a minimal amount + of porting, if at all. Includes documentation and user's manual. + Written by Pertti Kellom\"aki, pk@cs.tut.fi. The Lisp Pointers + article describing PSD (Lisp Pointers VI(1):15-23, January-March + 1993) is available as + `http://www.cs.tut.fi/staff/pk/scheme/psd/article/article.html' + +SCHELOG is an embedding of Prolog in Scheme. + `http://www.cs.rice.edu/CS/PLT/packages/schelog/' + + +File: slib.info, Node: About SLIB, Next: Index, Prev: Other Packages, Up: Top + +About SLIB +********** + +More people than I can name have contributed to SLIB. Thanks to all of | +you! | + | + SLIB 2c7, released December 1999. | + Aubrey Jaffer <jaffer @ ai.mit.edu> | + Hyperactive Software - The Maniac Inside! | + `http://swissnet.ai.mit.edu/~jaffer/SLIB.html' | + | +* Menu: + +* Installation:: How to install SLIB on your system. +* Porting:: SLIB to new platforms. +* Coding Standards:: How to write modules for SLIB. +* Copyrights:: Intellectual propery issues. + | + +File: slib.info, Node: Installation, Next: Porting, Prev: About SLIB, Up: About SLIB + +Installation +============ + + Check the manifest in `README' to find a configuration file for your +Scheme implementation. Initialization files for most IEEE P1178 +compliant Scheme Implementations are included with this distribution. + + If the Scheme implementation supports `getenv', then the value of the +shell environment variable SCHEME_LIBRARY_PATH will be used for +`(library-vicinity)' if it is defined. Currently, Chez, Elk, +MITScheme, scheme->c, VSCM, and SCM support `getenv'. Scheme48 +supports `getenv' but does not use it for determining +`library-vicinity'. (That is done from the Makefile.) + + You should check the definitions of `software-type', +`scheme-implementation-version', `implementation-vicinity', and +`library-vicinity' in the initialization file. There are comments in +the file for how to configure it. + + Once this is done you can modify the startup file for your Scheme +implementation to `load' this initialization file. SLIB is then +installed. + + Multiple implementations of Scheme can all use the same SLIB +directory. Simply configure each implementation's initialization file +as outlined above. + + The SCM implementation does not require any initialization file as +SLIB support is already built in to SCM. See the documentation with +SCM for installation instructions. + + SLIB includes methods to create heap images for the VSCM and Scheme48 +implementations. The instructions for creating a VSCM image are in +comments in `vscm.init'. To make a Scheme48 image for an installation +under `<prefix>', `cd' to the SLIB directory and type `make +prefix=<prefix> slib48'. To install the image, type `make +prefix=<prefix> install48'. This will also create a shell script with +the name `slib48' which will invoke the saved image. + + +File: slib.info, Node: Porting, Next: Coding Standards, Prev: Installation, Up: About SLIB + +Porting +======= + + If there is no initialization file for your Scheme implementation, you +will have to create one. Your Scheme implementation must be largely +compliant with `IEEE Std 1178-1990', `Revised^4 Report on the +Algorithmic Language Scheme', or `Revised^5 Report on the Algorithmic +Language Scheme' in order to support SLIB. (1) + + `Template.scm' is an example configuration file. The comments inside +will direct you on how to customize it to reflect your system. Give +your new initialization file the implementation's name with `.init' +appended. For instance, if you were porting `foo-scheme' then the +initialization file might be called `foo.init'. + + Your customized version should then be loaded as part of your scheme +implementation's initialization. It will load `require.scm' from the +library; this will allow the use of `provide', `provided?', and +`require' along with the "vicinity" functions (these functions are +documented in the section *Note Require::). The rest of the library +will then be accessible in a system independent fashion. + + Please mail new working configuration files to `jaffer @ ai.mit.edu' +so that they can be included in the SLIB distribution. + + ---------- Footnotes ---------- + + (1) If you are porting a `Revised^3 Report on the Algorithmic +Language Scheme' implementation, then you will need to finish writing +`sc4sc3.scm' and `load' it from your initialization file. + + +File: slib.info, Node: Coding Standards, Next: Copyrights, Prev: Porting, Up: About SLIB + +Coding Standards +================ + + All library packages are written in IEEE P1178 Scheme and assume that +a configuration file and `require.scm' package have already been +loaded. Other versions of Scheme can be supported in library packages +as well by using, for example, `(provided? 'rev3-report)' or `(require +'rev3-report)' (*note Require::.). + + The module name and `:' should prefix each symbol defined in the +package. Definitions for external use should then be exported by having +`(define foo module-name:foo)'. + + Code submitted for inclusion in SLIB should not duplicate routines +already in SLIB files. Use `require' to force those library routines +to be used by your package. Care should be taken that there are no +circularities in the `require's and `load's between the library +packages. + + Documentation should be provided in Emacs Texinfo format if possible, +But documentation must be provided. + + Your package will be released sooner with SLIB if you send me a file +which tests your code. Please run this test *before* you send me the +code! + +Modifications +------------- + + Please document your changes. A line or two for `ChangeLog' is +sufficient for simple fixes or extensions. Look at the format of +`ChangeLog' to see what information is desired. Please send me `diff' +files from the latest SLIB distribution (remember to send `diff's of +`slib.texi' and `ChangeLog'). This makes for less email traffic and +makes it easier for me to integrate when more than one person is +changing a file (this happens a lot with `slib.texi' and `*.init' +files). + + If someone else wrote a package you want to significantly modify, +please try to contact the author, who may be working on a new version. +This will insure against wasting effort on obsolete versions. + + Please *do not* reformat the source code with your favorite +beautifier, make 10 fixes, and send me the resulting source code. I do +not have the time to fish through 10000 diffs to find your 10 real +fixes. + + +File: slib.info, Node: Copyrights, Prev: Coding Standards, Up: About SLIB + +Copyrights +========== + + This section has instructions for SLIB authors regarding copyrights. + + Each package in SLIB must either be in the public domain, or come +with a statement of terms permitting users to copy, redistribute and +modify it. The comments at the beginning of `require.scm' and +`macwork.scm' illustrate copyright and appropriate terms. + + If your code or changes amount to less than about 10 lines, you do not +need to add your copyright or send a disclaimer. + +Putting code into the Public Domain +----------------------------------- + + In order to put code in the public domain you should sign a copyright +disclaimer and send it to the SLIB maintainer. Contact jaffer @ +ai.mit.edu for the address to mail the disclaimer to. + + I, NAME, hereby affirm that I have placed the software package + NAME in the public domain. + + I affirm that I am the sole author and sole copyright holder for + the software package, that I have the right to place this software + package in the public domain, and that I will do nothing to + undermine this status in the future. + + SIGNATURE AND DATE + + This wording assumes that you are the sole author. If you are not the +sole author, the wording needs to be different. If you don't want to be +bothered with sending a letter every time you release or modify a +module, make your letter say that it also applies to your future +revisions of that module. + + Make sure no employer has any claim to the copyright on the work you +are submitting. If there is any doubt, create a copyright disclaimer +and have your employer sign it. Mail the signed disclaimer to the SLIB +maintainer. Contact jaffer @ ai.mit.edu for the address to mail the +disclaimer to. An example disclaimer follows. + +Explicit copying terms +---------------------- + +If you submit more than about 10 lines of code which you are not placing +into the Public Domain (by sending me a disclaimer) you need to: + + * Arrange that your name appears in a copyright line for the + appropriate year. Multiple copyright lines are acceptable. + + * With your copyright line, specify any terms you require to be + different from those already in the file. + + * Make sure no employer has any claim to the copyright on the work + you are submitting. If there is any doubt, create a copyright + disclaimer and have your employer sign it. Mail the signed + disclaim to the SLIB maintainer. Contact jaffer @ ai.mit.edu for + the address to mail the disclaimer to. + +Example: Company Copyright Disclaimer +------------------------------------- + + This disclaimer should be signed by a vice president or general +manager of the company. If you can't get at them, anyone else +authorized to license out software produced there will do. Here is a +sample wording: + + EMPLOYER Corporation hereby disclaims all copyright interest in + the program PROGRAM written by NAME. + + EMPLOYER Corporation affirms that it has no other intellectual + property interest that would undermine this release, and will do + nothing to undermine it in the future. + + SIGNATURE AND DATE, + NAME, TITLE, EMPLOYER Corporation + + +File: slib.info, Node: Index, Prev: About SLIB, Up: Top + +Procedure and Macro Index +************************* + + This is an alphabetical list of all the procedures and macros in SLIB. + +* Menu: + +* -: Multi-argument / and -. +* -1+: Rev2 Procedures. +* /: Multi-argument / and -. +* 1+: Rev2 Procedures. +* <=?: Rev2 Procedures. +* <?: Rev2 Procedures. +* =?: Rev2 Procedures. +* >=?: Rev2 Procedures. +* >?: Rev2 Procedures. +* absolute-path?: System Interface. +* add-domain: Database Utilities. +* add-process!: Multi-Processing. +* add-setter: Setters. +* adjoin: Lists as sets. +* adjoin-parameters!: Parameter lists. +* alarm: Multi-Processing. +* alarm-interrupt: Multi-Processing. +* alist->wt-tree: Construction of Weight-Balanced Trees. +* alist-associator: Association Lists. +* alist-for-each: Association Lists. +* alist-inquirer: Association Lists. +* alist-map: Association Lists. +* alist-remover: Association Lists. +* and?: Non-List functions. +* any?: Collections. +* append!: Rev2 Procedures. +* apply: Multi-argument Apply. +* array-1d-ref: Arrays. +* array-1d-set!: Arrays. +* array-2d-ref: Arrays. +* array-2d-set!: Arrays. +* array-3d-ref: Arrays. +* array-3d-set!: Arrays. +* array-copy!: Array Mapping. +* array-dimensions: Arrays. +* array-for-each: Array Mapping. +* array-in-bounds?: Arrays. +* array-index-map!: Array Mapping. +* array-indexes: Array Mapping. +* array-map!: Array Mapping. +* array-rank: Arrays. +* array-ref: Arrays. +* array-set!: Arrays. +* array-shape: Arrays. +* array?: Arrays. +* asctime: Posix Time. +* ash: Bit-Twiddling. +* atom?: Non-List functions. | +* batch:call-with-output-script: Batch. +* batch:command: Batch. | +* batch:comment: Batch. +* batch:delete-file: Batch. +* batch:initialize!: Batch. +* batch:lines->file: Batch. +* batch:rename-file: Batch. +* batch:run-script: Batch. +* batch:try-chopped-command: Batch. | +* batch:try-command: Batch. | +* bit-extract: Bit-Twiddling. +* bit-field: Bit-Twiddling. +* bitwise-if: Bit-Twiddling. +* break: Breakpoints. +* break-all: Debug. +* breakf: Breakpoints. +* breakpoint: Breakpoints. +* browse: Database Browser. +* browse-url-netscape: System Interface. +* butlast: Lists as sequences. +* butnthcdr: Lists as sequences. +* byte-ref: Byte. +* byte-set!: Byte. +* bytes: Byte. +* bytes->list: Byte. +* bytes-length: Byte. +* call-with-dynamic-binding: Dynamic Data Type. +* call-with-input-string: String Ports. +* call-with-output-string: String Ports. +* call-with-tmpnam: System Interface. +* call-with-values: Values. +* capture-syntactic-environment: Syntactic Closures. +* cart-prod-tables: Relational Database Operations. +* catalog->html: HTML HTTP and CGI. +* catalog->page: HTML HTTP and CGI. +* cgi:read-query-string: HTML HTTP and CGI. +* cgi:serve-command: HTML HTTP and CGI. +* chap:next-string: Chapter Ordering. +* chap:string<=?: Chapter Ordering. +* chap:string<?: Chapter Ordering. +* chap:string>=?: Chapter Ordering. +* chap:string>?: Chapter Ordering. +* check-parameters: Parameter lists. +* close-base: Base Table. +* close-database: Relational Database Operations. +* close-table: Table Operations. +* coerce: Non-List functions. +* collection?: Collections. +* combined-rulesets: Commutative Rings. +* command->html: HTML HTTP and CGI. +* continue: Breakpoints. +* copy-bit: Bit-Twiddling. +* copy-bit-field: Bit-Twiddling. +* copy-list: List construction. +* copy-random-state: Random Numbers. +* copy-tree: Tree Operations. +* create-database <1>: Database Utilities. +* create-database: Creating and Opening Relational Databases. +* create-report: Database Reports. +* create-table: Relational Database Operations. +* create-view: Relational Database Operations. +* cring:define-rule: Commutative Rings. +* ctime: Posix Time. +* current-directory: System Interface. +* current-error-port: Input/Output. +* current-input-port <1>: Byte. +* current-input-port: Ruleset Definition and Use. +* current-output-port: Byte. +* current-time: Time and Date. +* debug:breakf: Breakpoints. +* debug:tracef: Trace. +* debug:unbreakf: Breakpoints. +* debug:untracef: Trace. +* decode-universal-time: Common-Lisp Time. +* define-access-operation: Setters. +* define-operation: Yasos interface. +* define-predicate: Yasos interface. +* define-record: Structures. +* define-syntax: Macro by Example. +* define-tables: Database Utilities. +* defmacro: Defmacro. +* defmacro:eval: Defmacro. +* defmacro:expand*: Defmacro. +* defmacro:load: Defmacro. +* defmacro?: Defmacro. +* delete <1>: Destructive list operations. +* delete: Base Table. +* delete*: Base Table. +* delete-domain: Database Utilities. +* delete-file: Input/Output. +* delete-if: Destructive list operations. +* delete-if-not: Destructive list operations. +* delete-table: Relational Database Operations. +* dequeue!: Queues. +* difftime: Time and Date. +* display-file: Line I/O. +* do-elts: Collections. +* do-keys: Collections. +* domain-checker: Database Utilities. +* dynamic-ref: Dynamic Data Type. +* dynamic-set!: Dynamic Data Type. +* dynamic-wind: Dynamic-Wind. +* dynamic?: Dynamic Data Type. +* empty?: Collections. +* encode-universal-time: Common-Lisp Time. +* enquque!: Queues. +* equal?: Byte. +* eval: Eval. +* every: Lists as sets. +* every?: Collections. +* extended-euclid: Modular Arithmetic. +* factor: Prime Numbers. +* fft: Fast Fourier Transform. +* fft-1: Fast Fourier Transform. +* file-exists?: Input/Output. +* filename:match-ci??: Filenames. +* filename:match??: Filenames. +* filename:substitute-ci??: Filenames. +* filename:substitute??: Filenames. +* fill-empty-parameters: Parameter lists. +* find-if: Lists as sets. +* find-string-from-port?: String Search. +* fluid-let: Fluid-Let. +* for-each-elt: Collections. +* for-each-key <1>: Collections. +* for-each-key: Base Table. +* for-each-row: Table Operations. +* force-output: Input/Output. +* format: Format Interface. +* fprintf: Standard Formatted Output. +* fscanf: Standard Formatted Input. +* ftp-upload: System Interface. +* generic-write: Generic-Write. +* gentemp: Defmacro. +* get: Table Operations. +* get*: Table Operations. +* get-decoded-time: Common-Lisp Time. +* get-method: Object. +* get-universal-time: Common-Lisp Time. +* getenv: System Interface. +* getopt: Getopt. +* getopt--: Getopt. +* getopt->arglist: Getopt Parameter lists. +* getopt->parameter-list: Getopt Parameter lists. +* glob-pattern?: System Interface. +* gmktime: Posix Time. +* gmtime: Posix Time. +* gtime: Posix Time. +* has-duplicates?: Lists as sets. +* hash: Hashing. +* hash-associator: Hash Tables. +* hash-for-each: Hash Tables. +* hash-inquirer: Hash Tables. +* hash-map: Hash Tables. +* hash-remover: Hash Tables. +* hashq: Hashing. +* hashv: Hashing. +* heap-extract-max!: Priority Queues. +* heap-insert!: Priority Queues. +* heap-length: Priority Queues. +* home-vicinity: Vicinity. +* html:comment: HTML HTTP and CGI. +* html:end-form: HTML HTTP and CGI. +* html:end-page: HTML HTTP and CGI. +* html:end-table: HTML HTTP and CGI. +* html:heading: HTML HTTP and CGI. +* html:href-heading: HTML HTTP and CGI. +* html:pre: HTML HTTP and CGI. +* html:start-form: HTML HTTP and CGI. +* html:start-page: HTML HTTP and CGI. +* html:start-table: HTML HTTP and CGI. +* http:read-request-line: HTML HTTP and CGI. +* http:serve-query: HTML HTTP and CGI. +* identifier=?: Syntactic Closures. +* identifier?: Syntactic Closures. +* identity: Legacy. +* implementation-vicinity: Vicinity. +* in-vicinity: Vicinity. +* init-debug: Breakpoints. +* integer-expt: Bit-Twiddling. +* integer-length: Bit-Twiddling. +* integer-sqrt: Root Finding. +* interaction-environment: Eval. +* intersection: Lists as sets. +* jacobi-symbol: Prime Numbers. +* kill-process!: Multi-Processing. +* kill-table: Base Table. +* laguerre:find-polynomial-root: Root Finding. +* laguerre:find-root: Root Finding. +* last: Lists as sequences. +* last-pair: Legacy. +* library-vicinity: Vicinity. +* list*: List construction. +* list->bytes: Byte. +* list->string: Rev4 Optional Procedures. +* list->vector: Rev4 Optional Procedures. +* list-tail: Rev4 Optional Procedures. +* load-option: Weight-Balanced Trees. +* localtime: Posix Time. +* logand: Bit-Twiddling. +* logbit?: Bit-Twiddling. +* logcount: Bit-Twiddling. +* logior: Bit-Twiddling. +* lognot: Bit-Twiddling. +* logtest: Bit-Twiddling. +* logxor: Bit-Twiddling. +* macro:eval <1>: Syntax-Case Macros. +* macro:eval <2>: Syntactic Closures. +* macro:eval <3>: Macros That Work. +* macro:eval: R4RS Macros. +* macro:expand <1>: Syntax-Case Macros. +* macro:expand <2>: Syntactic Closures. +* macro:expand <3>: Macros That Work. +* macro:expand: R4RS Macros. +* macro:load <1>: Syntax-Case Macros. +* macro:load <2>: Syntactic Closures. +* macro:load <3>: Macros That Work. +* macro:load: R4RS Macros. +* macroexpand: Defmacro. +* macroexpand-1: Defmacro. +* macwork:eval: Macros That Work. +* macwork:expand: Macros That Work. +* macwork:load: Macros That Work. +* make-: Structures. +* make-array: Arrays. +* make-atval: HTML HTTP and CGI. +* make-base: Base Table. +* make-bytes: Byte. +* make-command-server: Database Utilities. +* make-directory: System Interface. +* make-dynamic: Dynamic Data Type. +* make-generic-method: Object. +* make-generic-predicate: Object. +* make-getter: Base Table. +* make-hash-table: Hash Tables. +* make-heap: Priority Queues. +* make-key->list: Base Table. +* make-key-extractor: Base Table. +* make-keyifier-1: Base Table. +* make-list: List construction. +* make-list-keyifier: Base Table. +* make-method!: Object. +* make-object: Object. +* make-parameter-list: Parameter lists. +* make-plain: HTML HTTP and CGI. +* make-port-crc: Cyclic Checksum. +* make-predicate!: Object. +* make-promise: Promises. +* make-putter: Base Table. +* make-queue: Queues. +* make-random-state: Random Numbers. +* make-record-type: Records. +* make-relational-system: Creating and Opening Relational Databases. +* make-row-converter: HTML HTTP and CGI. +* make-ruleset: Commutative Rings. +* make-shared-array: Arrays. +* make-sierpinski-indexer: Hashing. +* make-syntactic-closure: Syntactic Closures. +* make-table: Base Table. +* make-vicinity: Vicinity. +* make-wt-tree: Construction of Weight-Balanced Trees. +* make-wt-tree-type: Construction of Weight-Balanced Trees. +* map-elts: Collections. +* map-key: Base Table. +* map-keys: Collections. +* member-if: Lists as sets. +* merge: Sorting. +* merge!: Sorting. +* mktime: Posix Time. +* modular:: Modular Arithmetic. +* modular:*: Modular Arithmetic. +* modular:+: Modular Arithmetic. +* modular:expt: Modular Arithmetic. +* modular:invert: Modular Arithmetic. +* modular:invertable?: Modular Arithmetic. +* modular:negate: Modular Arithmetic. +* modular:normalize: Modular Arithmetic. +* modulus->integer: Modular Arithmetic. +* must-be-first: Batch. +* must-be-last: Batch. +* nconc: Destructive list operations. +* newton:find-root: Root Finding. +* newtown:find-integer-root: Root Finding. +* notany: Lists as sets. +* notevery: Lists as sets. +* nreverse: Destructive list operations. +* nthcdr: Lists as sequences. +* null-directory?: System Interface. +* null-environment: Eval. +* object: Yasos interface. +* object->limited-string: Object-To-String. +* object->string: Object-To-String. +* object-with-ancestors: Yasos interface. +* object?: Object. +* offset-time: Time and Date. +* open-base: Base Table. +* open-database <1>: Database Utilities. +* open-database: Creating and Opening Relational Databases. +* open-database!: Database Utilities. +* open-table <1>: Relational Database Operations. +* open-table: Base Table. +* operate-as: Yasos interface. +* or?: Non-List functions. +* ordered-for-each-key: Base Table. +* os->batch-dialect: Batch. +* output-port-height: Input/Output. +* output-port-width: Input/Output. +* parameter-list->arglist: Parameter lists. +* parameter-list-expand: Parameter lists. +* parameter-list-ref: Parameter lists. +* parse-ftp-address: System Interface. +* path->url: System Interface. +* plot!: Plotting. +* position: Lists as sequences. +* pprint-file: Pretty-Print. +* pprint-filter-file: Pretty-Print. +* prec:commentfix: Grammar Rule Definition. +* prec:define-grammar: Ruleset Definition and Use. +* prec:delim: Grammar Rule Definition. +* prec:infix: Grammar Rule Definition. +* prec:inmatchfix: Grammar Rule Definition. +* prec:make-led: Nud and Led Definition. +* prec:make-nud: Nud and Led Definition. +* prec:matchfix: Grammar Rule Definition. +* prec:nary: Grammar Rule Definition. +* prec:nofix: Grammar Rule Definition. +* prec:parse: Ruleset Definition and Use. +* prec:postfix: Grammar Rule Definition. +* prec:prefix: Grammar Rule Definition. +* prec:prestfix: Grammar Rule Definition. +* predicate->asso: Association Lists. +* predicate->hash: Hash Tables. +* predicate->hash-asso: Hash Tables. +* present?: Base Table. +* pretty-print: Pretty-Print. +* prime?: Prime Numbers. +* primes<: Prime Numbers. +* primes>: Prime Numbers. +* print: Yasos interface. +* printf: Standard Formatted Output. +* process:schedule!: Multi-Processing. +* program-vicinity: Vicinity. +* project-table: Relational Database Operations. +* provide <1>: Require. +* provide: Feature. +* provided? <1>: Require. +* provided?: Feature. +* qp: Quick Print. +* qpn: Quick Print. +* qpr: Quick Print. +* queue-empty?: Queues. +* queue-front: Queues. +* queue-pop!: Queues. +* queue-push!: Queues. +* queue-rear: Queues. +* queue?: Queues. +* random: Random Numbers. +* random:exp: Random Numbers. +* random:hollow-sphere!: Random Numbers. +* random:normal: Random Numbers. +* random:normal-vector!: Random Numbers. +* random:solid-sphere!: Random Numbers. +* random:uniform: Random Numbers. +* rationalize: Rationalize. +* read-byte: Byte. +* read-command: Command Line. +* read-line: Line I/O. +* read-line!: Line I/O. +* read-options-file: Command Line. +* record-accessor: Records. +* record-constructor: Records. +* record-modifier: Records. +* record-predicate: Records. +* reduce <1>: Lists as sequences. +* reduce: Collections. +* reduce-init: Lists as sequences. +* remove: Lists as sets. +* remove-duplicates: Lists as sets. +* remove-if: Lists as sets. +* remove-if-not: Lists as sets. +* remove-setter-for: Setters. +* repl:quit: Repl. +* repl:top-level: Repl. +* replace-suffix: Filenames. +* require <1>: Require. +* require <2>: Catalog Compilation. +* require: Requesting Features. +* require:feature->path <1>: Require. +* require:feature->path: Requesting Features. +* restrict-table: Relational Database Operations. +* row:delete: Table Operations. +* row:delete*: Table Operations. +* row:insert: Table Operations. +* row:insert*: Table Operations. +* row:remove: Table Operations. +* row:remove*: Table Operations. +* row:retrieve: Table Operations. +* row:retrieve*: Table Operations. +* row:update: Table Operations. +* row:update*: Table Operations. +* scanf: Standard Formatted Input. +* scanf-read-list: Standard Formatted Input. +* scheme-report-environment: Eval. +* schmooz: Schmooz. +* secant:find-bracketed-root: Root Finding. +* secant:find-root: Root Finding. +* seed->random-state: Random Numbers. +* serve-urlencoded-command: HTML HTTP and CGI. +* set: Setters. +* set-: Structures. +* set-difference: Lists as sets. +* Setter: Collections. +* setter: Setters. +* singleton-wt-tree: Construction of Weight-Balanced Trees. +* size <1>: Collections. +* size: Yasos interface. +* slib:error: System. +* slib:eval: System. +* slib:eval-load: System. +* slib:exit: System. +* slib:load: System. +* slib:load-compiled: System. +* slib:load-source: System. +* slib:report: Configuration. +* slib:report-version: Configuration. +* slib:warn: System. +* software-type: Configuration. +* some: Lists as sets. +* sort: Sorting. +* sort!: Sorting. +* sorted?: Sorting. +* soundex: Hashing. +* sprintf: Standard Formatted Output. +* sscanf: Standard Formatted Input. +* string->list: Rev4 Optional Procedures. +* string-capitalize: String-Case. +* string-captialize!: String-Case. +* string-ci->symbol: String-Case. +* string-copy: Rev4 Optional Procedures. +* string-downcase: String-Case. +* string-downcase!: String-Case. +* string-fill!: Rev4 Optional Procedures. +* string-index: String Search. +* string-index-ci: String Search. +* string-join: Batch. +* string-null?: Rev2 Procedures. +* string-reverse-index: String Search. +* string-reverse-index-ci: String Search. +* string-subst: String Search. +* string-upcase: String-Case. +* string-upcase!: String-Case. +* sub-vicinity: Vicinity. +* subst: Tree Operations. +* substq: Tree Operations. +* substring-ci?: String Search. +* substring-fill!: Rev2 Procedures. +* substring-move-left!: Rev2 Procedures. +* substring-move-right!: Rev2 Procedures. +* substring?: String Search. +* substv: Tree Operations. +* supported-key-type?: Base Table. +* supported-type?: Base Table. +* symmetric:modulus: Modular Arithmetic. +* sync-base: Base Table. +* syncase:eval: Syntax-Case Macros. +* syncase:expand: Syntax-Case Macros. +* syncase:load: Syntax-Case Macros. +* synclo:eval: Syntactic Closures. +* synclo:expand: Syntactic Closures. +* synclo:load: Syntactic Closures. +* syntax-rules: Macro by Example. +* system: System Interface. +* table->html: HTML HTTP and CGI. +* table->page: HTML HTTP and CGI. +* table-exists?: Relational Database Operations. +* table-name->filename: HTML HTTP and CGI. +* TAG: Structures. +* tek40:draw: Tektronix Graphics Support. +* tek40:graphics: Tektronix Graphics Support. +* tek40:init: Tektronix Graphics Support. +* tek40:linetype: Tektronix Graphics Support. +* tek40:move: Tektronix Graphics Support. +* tek40:put-text: Tektronix Graphics Support. +* tek40:reset: Tektronix Graphics Support. +* tek40:text: Tektronix Graphics Support. +* tek41:draw: Tektronix Graphics Support. +* tek41:encode-int: Tektronix Graphics Support. +* tek41:encode-x-y: Tektronix Graphics Support. +* tek41:graphics: Tektronix Graphics Support. +* tek41:init: Tektronix Graphics Support. +* tek41:move: Tektronix Graphics Support. +* tek41:point: Tektronix Graphics Support. +* tek41:reset: Tektronix Graphics Support. +* time-zone: Time Zone. +* tmpnam: Input/Output. +* tok:char-group: Token definition. +* topological-sort: Topological Sort. +* trace: Trace. +* trace-all: Debug. +* tracef: Trace. +* transcript-off: Transcripts. +* transcript-on: Transcripts. +* transformer: Syntactic Closures. +* truncate-up-to: Batch. +* tsort: Topological Sort. +* two-arg:-: Multi-argument / and -. +* two-arg:/: Multi-argument / and -. +* two-arg:apply: Multi-argument Apply. +* type-of: Non-List functions. +* tz:params: Time Zone. +* tzset: Time Zone. +* unbreak: Breakpoints. +* unbreakf: Breakpoints. +* union: Lists as sets. +* unmake-method!: Object. +* untrace: Trace. +* untracef: Trace. +* user-email-address: System Interface. +* user-vicinity: Vicinity. +* values: Values. +* variant-case: Structures. +* vector->list: Rev4 Optional Procedures. +* vector-fill!: Rev4 Optional Procedures. +* with-input-from-file: With-File. +* with-output-to-file: With-File. +* write-base: Base Table. +* write-byte: Byte. +* write-database: Relational Database Operations. +* write-line: Line I/O. +* wt-tree/add: Basic Operations on Weight-Balanced Trees. +* wt-tree/add!: Basic Operations on Weight-Balanced Trees. +* wt-tree/delete: Basic Operations on Weight-Balanced Trees. +* wt-tree/delete!: Basic Operations on Weight-Balanced Trees. +* wt-tree/delete-min: Indexing Operations on Weight-Balanced Trees. +* wt-tree/delete-min!: Indexing Operations on Weight-Balanced Trees. +* wt-tree/difference: Advanced Operations on Weight-Balanced Trees. +* wt-tree/empty?: Basic Operations on Weight-Balanced Trees. +* wt-tree/fold: Advanced Operations on Weight-Balanced Trees. +* wt-tree/for-each: Advanced Operations on Weight-Balanced Trees. +* wt-tree/index: Indexing Operations on Weight-Balanced Trees. +* wt-tree/index-datum: Indexing Operations on Weight-Balanced Trees. +* wt-tree/index-pair: Indexing Operations on Weight-Balanced Trees. +* wt-tree/intersection: Advanced Operations on Weight-Balanced Trees. +* wt-tree/lookup: Basic Operations on Weight-Balanced Trees. +* wt-tree/member?: Basic Operations on Weight-Balanced Trees. +* wt-tree/min: Indexing Operations on Weight-Balanced Trees. +* wt-tree/min-datum: Indexing Operations on Weight-Balanced Trees. +* wt-tree/min-pair: Indexing Operations on Weight-Balanced Trees. +* wt-tree/rank: Indexing Operations on Weight-Balanced Trees. +* wt-tree/set-equal?: Advanced Operations on Weight-Balanced Trees. +* wt-tree/size: Basic Operations on Weight-Balanced Trees. +* wt-tree/split<: Advanced Operations on Weight-Balanced Trees. +* wt-tree/split>: Advanced Operations on Weight-Balanced Trees. +* wt-tree/subset?: Advanced Operations on Weight-Balanced Trees. +* wt-tree/union: Advanced Operations on Weight-Balanced Trees. +* wt-tree?: Basic Operations on Weight-Balanced Trees. + +Variable Index +************** + + This is an alphabetical list of all the global variables in SLIB. + +* Menu: + +* *catalog*: Require. +* *features*: Require. +* *html:output-port*: HTML HTTP and CGI. +* *modules*: Require. +* *optarg*: Getopt. +* *optind*: Getopt. +* *qp-width*: Quick Print. +* *random-state*: Random Numbers. +* *ruleset*: Commutative Rings. +* *syn-defs*: Ruleset Definition and Use. +* *syn-ignore-whitespace*: Ruleset Definition and Use. +* *timezone*: Time Zone. +* batch:platform: Batch. +* catalog-id: Base Table. +* char-code-limit: Configuration. +* charplot:height: Plotting. +* charplot:width: Plotting. +* column-domains: Table Operations. +* column-foreigns: Table Operations. +* column-names: Table Operations. +* column-types: Table Operations. +* daylight?: Time Zone. +* distribute*: Commutative Rings. +* distribute/: Commutative Rings. +* most-positive-fixnum: Configuration. +* nil: Legacy. +* number-wt-type: Construction of Weight-Balanced Trees. +* primary-limit: Table Operations. +* prime:prngs: Prime Numbers. +* prime:trials: Prime Numbers. +* slib:form-feed: Configuration. +* slib:tab: Configuration. +* stderr: Standard Formatted I/O. +* stdin: Standard Formatted I/O. +* stdout: Standard Formatted I/O. +* string-wt-type: Construction of Weight-Balanced Trees. +* t: Legacy. +* tok:decimal-digits: Token definition. +* tok:lower-case: Token definition. +* tok:upper-case: Token definition. +* tok:whitespaces: Token definition. +* tzname: Time Zone. + +Concept and Feature Index +************************* + +* Menu: + +* alist: Association Lists. +* alist-table <1>: Creating and Opening Relational Databases. +* alist-table: Base Table. +* ange-ftp: System Interface. +* array: Arrays. +* array-for-each: Array Mapping. +* attribute-value: HTML HTTP and CGI. +* balanced binary trees: Weight-Balanced Trees. +* batch: Batch. +* binary trees: Weight-Balanced Trees. +* binary trees, as discrete maps: Weight-Balanced Trees. +* binary trees, as sets: Weight-Balanced Trees. +* break: Breakpoints. +* byte: Byte. +* calendar time <1>: Posix Time. +* calendar time: Time and Date. +* Calendar-Time: Posix Time. +* caltime: Posix Time. +* careful: Commutative Rings. +* catalog: Requesting Features. +* Catalog File: Library Catalogs. +* chapter-order: Chapter Ordering. +* charplot: Plotting. +* collect: Collections. +* command line: Command Line. +* commentfix: Precedence Parsing Overview. +* common-list-functions <1>: Common List Functions. +* common-list-functions: Collections. +* commutative-ring: Commutative Rings. +* Coordinated Universal Time: Posix Time. +* database-utilities <1>: Database Utilities. +* database-utilities: Batch. +* debug <1>: Breakpoints. +* debug: Debug. +* defmacroexpand <1>: Pretty-Print. +* defmacroexpand: Defmacro. +* delim: Precedence Parsing Overview. +* discrete maps, using binary trees: Weight-Balanced Trees. +* dynamic: Dynamic Data Type. +* dynamic-wind: Dynamic-Wind. +* Euclidean Domain: Commutative Rings. +* factor: Prime Numbers. +* feature <1>: About this manual. +* feature <2>: Requesting Features. +* feature: Feature. +* fft: Fast Fourier Transform. +* fluid-let <1>: Database Utilities. +* fluid-let: Fluid-Let. +* form: HTML HTTP and CGI. +* format: Format. +* generic-write: Generic-Write. +* getit: System Interface. +* getopt <1>: Database Utilities. +* getopt: Getopt. +* glob <1>: Batch. +* glob: Filenames. +* hash: Hashing. +* hash-table: Hash Tables. +* HOME <1>: Vicinity. +* HOME: Library Catalogs. +* homecat: Catalog Compilation. +* implcat: Catalog Compilation. +* infix: Precedence Parsing Overview. +* inmatchfix: Precedence Parsing Overview. +* Left Denotation, led: Nud and Led Definition. +* line-i: Line I/O. +* logical: Bit-Twiddling. +* macro <1>: Repl. +* macro: R4RS Macros. +* macro-by-example: Macro by Example. +* macros-that-work: Macros That Work. +* make-crc: Cyclic Checksum. +* match: Base Table. +* match-key: Base Table. +* match-keys: Table Operations. +* matchfix: Precedence Parsing Overview. +* minimum field width (printf): Standard Formatted Output. +* mkimpcat.scm: Catalog Compilation. +* mklibcat.scm: Catalog Compilation. +* modular: Modular Arithmetic. +* multiarg-apply: Multi-argument Apply. +* mutliarg: Multi-argument / and -. +* nary: Precedence Parsing Overview. +* net-clients: System Interface. +* nofix: Precedence Parsing Overview. +* Null Denotation, nud: Nud and Led Definition. +* object: Object. +* object->string: Object-To-String. +* oop: Yasos. +* option, run-time-loadable: Weight-Balanced Trees. +* options file: Command Line. | +* parameters <1>: Database Utilities. +* parameters <2>: Batch. +* parameters: Parameter lists. +* parse: Precedence Parsing. +* plain-text: HTML HTTP and CGI. +* posix-time: Posix Time. +* postfix: Precedence Parsing Overview. +* pprint-file: Pretty-Print. +* PRE: HTML HTTP and CGI. +* precedence: Precedence Parsing. +* precision (printf): Standard Formatted Output. +* prefix: Precedence Parsing Overview. +* prestfix: Precedence Parsing Overview. +* pretty-print: Pretty-Print. +* primes: Prime Numbers. +* printf: Standard Formatted Output. +* priority-queue: Priority Queues. +* PRNG: Random Numbers. +* process: Multi-Processing. +* promise: Promises. +* qp <1>: Quick Print. +* qp: Getopt. +* query-string: HTML HTTP and CGI. +* queue: Queues. +* random: Random Numbers. +* rationalize: Rationalize. +* read-command: Command Line. +* record: Records. +* relational-database: Relational Database. +* repl <1>: Repl. +* repl: Syntax-Case Macros. +* rev2-procedures: Rev2 Procedures. +* rev3-report: Coding Standards. +* rev4-optional-procedures: Rev4 Optional Procedures. +* ring, commutative: Commutative Rings. +* RNG: Random Numbers. +* root: Root Finding. +* run-time-loadable option: Weight-Balanced Trees. +* scanf: Standard Formatted Input. | +* schmooz: Schmooz. +* session: Feature. +* sets, using binary trees: Weight-Balanced Trees. +* sierpinski: Hashing. +* sitecat: Catalog Compilation. | +* slibcat: Catalog Compilation. +* sort: Sorting. +* soundex: Hashing. +* stdio: Standard Formatted I/O. +* string-case: String-Case. +* string-port: String Ports. +* string-search: String Search. +* struct: Structures. +* syntactic-closures: Syntactic Closures. +* syntax-case: Syntax-Case Macros. +* time: Time and Date. +* time-zone: Time Zone. +* topological-sort: Topological Sort. +* trace: Trace. +* transcript: Transcripts. +* tree: Tree Operations. +* trees, balanced binary: Weight-Balanced Trees. +* tsort: Topological Sort. +* TZ-string: Time Zone. +* Uniform Resource Locator: System Interface. +* Unique Factorization: Commutative Rings. +* usercat: Catalog Compilation. +* UTC: Posix Time. +* values: Values. +* weight-balanced binary trees: Weight-Balanced Trees. +* wild-card: Base Table. +* with-file: With-File. +* wt-tree: Weight-Balanced Trees. +* yasos: Yasos. + + + +Tag Table: +Node: Top1057 +Node: The Library System1870 +Node: Feature2184 +Node: Requesting Features3134 +Node: Library Catalogs4493 +Node: Catalog Compilation6945 +Node: Built-in Support9755 +Node: Require10386 +Node: Vicinity12879 +Node: Configuration15846 +Node: Input/Output18787 +Node: Legacy20386 +Node: System21228 +Node: About this manual23720 +Node: Scheme Syntax Extension Packages24277 +Node: Defmacro24962 +Node: R4RS Macros26912 +Node: Macro by Example28167 +Node: Macros That Work31043 +Node: Syntactic Closures37101 +Node: Syntax-Case Macros54534 +Node: Fluid-Let58661 +Node: Yasos59602 +Node: Yasos terms60395 +Node: Yasos interface61419 +Node: Setters63496 +Node: Yasos examples66138 +Node: Textual Conversion Packages69132 +Node: Precedence Parsing69708 +Node: Precedence Parsing Overview70371 +Node: Ruleset Definition and Use72572 +Node: Token definition74953 +Node: Nud and Led Definition77222 +Node: Grammar Rule Definition79671 +Node: Format87245 +Node: Format Interface87493 +Node: Format Specification89230 +Node: Standard Formatted I/O99287 +Node: Standard Formatted Output99853 +Node: Standard Formatted Input108913 +Node: Programs and Arguments115572 +Node: Getopt116085 +Node: Command Line121927 +Node: Parameter lists125116 +Node: Getopt Parameter lists128753 +Node: Filenames130948 +Node: Batch134178 +Node: HTML HTTP and CGI142791 +Node: Printing Scheme149960 +Node: Generic-Write150283 +Node: Object-To-String151686 +Node: Pretty-Print152090 +Node: Time and Date154036 +Node: Time Zone155063 +Node: Posix Time159625 +Node: Common-Lisp Time161761 +Node: Vector Graphics163340 +Node: Tektronix Graphics Support163529 +Node: Schmooz164903 +Node: Mathematical Packages169129 +Node: Bit-Twiddling169721 +Node: Modular Arithmetic174312 +Node: Prime Numbers176446 +Node: Random Numbers178453 +Node: Fast Fourier Transform183166 +Node: Cyclic Checksum184084 +Node: Plotting185802 +Node: Root Finding188377 +Node: Commutative Rings192371 +Node: Determinant203757 +Node: Database Packages204055 +Node: Base Table204319 +Node: Relational Database214477 +Node: Motivations215261 +Node: Creating and Opening Relational Databases220308 +Node: Relational Database Operations222740 +Node: Table Operations225537 +Node: Catalog Representation233415 +Node: Unresolved Issues236313 +Node: Database Utilities239264 +Node: Database Reports254919 +Node: Database Browser257674 +Node: Weight-Balanced Trees258735 +Node: Construction of Weight-Balanced Trees262605 +Node: Basic Operations on Weight-Balanced Trees266055 +Node: Advanced Operations on Weight-Balanced Trees269020 +Node: Indexing Operations on Weight-Balanced Trees275042 +Node: Other Packages278956 +Node: Data Structures279355 +Node: Arrays280074 +Node: Array Mapping283028 +Node: Association Lists284945 +Node: Byte287196 +Node: Collections289427 +Node: Dynamic Data Type295534 +Node: Hash Tables296795 +Node: Hashing298912 +Node: Object303687 +Node: Priority Queues311924 +Node: Queues312767 +Node: Records313893 +Node: Structures317404 +Node: Procedures318704 +Node: Common List Functions319391 +Node: List construction319815 +Node: Lists as sets321478 +Node: Lists as sequences326850 +Node: Destructive list operations332096 +Node: Non-List functions334760 +Node: Tree Operations336108 +Node: Chapter Ordering337654 +Node: Sorting339274 +Node: Topological Sort345051 +Node: String-Case346738 +Node: String Ports347359 +Node: String Search348123 +Node: Line I/O350490 +Node: Multi-Processing352139 +Node: Standards Support353223 +Node: With-File353878 +Node: Transcripts354154 +Node: Rev2 Procedures354475 +Node: Rev4 Optional Procedures356182 +Node: Multi-argument / and -356752 +Node: Multi-argument Apply357403 +Node: Rationalize357889 +Node: Promises358552 +Node: Dynamic-Wind358969 +Node: Eval360223 +Node: Values363560 +Node: Session Support364347 +Node: Repl364815 +Node: Quick Print366098 +Node: Debug367211 +Node: Breakpoints367853 +Node: Trace370071 +Node: System Interface371445 +Node: Extra-SLIB Packages375246 +Node: About SLIB377378 +Node: Installation378462 +Node: Porting380312 +Node: Coding Standards381829 +Node: Copyrights383908 +Node: Index387192 + +End Tag Table @@ -2,6 +2,7 @@ @c %**start of header @setfilename slib.info @settitle SLIB +@include version.txi @setchapternewpage on @c Choices for setchapternewpage are {on,off,odd}. @paragraphindent 2 @@ -26,7 +27,7 @@ This file documents SLIB, the portable Scheme library. Copyright (C) 1993 Todd R. Eigenschink@* -Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998 Aubrey Jaffer +Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999 Aubrey Jaffer Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -50,16 +51,43 @@ except that this permission notice may be stated in a translation approved by the author. @end ifinfo +@node Top, The Library System, (dir), (dir) + @titlepage @title SLIB @subtitle The Portable Scheme Library -@subtitle Version 2c3 +@subtitle Version @value{SLIBVERSION} @author by Aubrey Jaffer - @page + +@noindent +@dfn{SLIB} is a portable library for the programming language +@dfn{Scheme}. It provides a platform independent framework for using +@dfn{packages} of Scheme procedures and syntax. As distributed, SLIB +contains useful packages for all Scheme implementations. Its catalog +can be transparently extended to accomodate packages specific to a site, +implementation, user, or directory. + +@noindent +More people than I can name have contributed to SLIB. Thanks to all of +you! +@sp 1 +@quotation +SLIB @value{SLIBVERSION}, released @value{SLIBDATE}.@* +Aubrey Jaffer <jaffer @@ ai.mit.edu>@* +@ifset html +<A HREF="http://swissnet.ai.mit.edu/~jaffer/SLIB.html"> +@end ifset +@url{http://swissnet.ai.mit.edu/~jaffer/SLIB.html} +@ifset html +</A> +@end ifset +@end quotation + +@ifclear html @vskip 0pt plus 1filll Copyright @copyright{} 1993 Todd R. Eigenschink@* -Copyright @copyright{} 1993, 1994, 1995, 1996, 1997, 1998 Aubrey Jaffer +Copyright @copyright{} 1993, 1994, 1995, 1996, 1997, 1998, 1999 Aubrey Jaffer Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -74,28 +102,17 @@ Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the author. +@end ifclear @end titlepage - -@node Top, The Library System, (dir), (dir) - @ifinfo -@cindex SLIB +@noindent @dfn{SLIB} is a portable library for the programming language -@cindex Scheme @dfn{Scheme}. It provides a platform independent framework for using -@dfn{packages} of Scheme procedures and syntax. -@cindex packages -@cindex package -As distributed, SLIB contains useful packages for all implementations. -Its catalog can be transparently extended to accomodate packages -specific to a site, implementation, user, or directory. - -@quotation -Aubrey Jaffer <jaffer@@ai.mit.edu>@* -@i{Hyperactive Software} -- The Maniac Inside!@* -@url{http://swissnet.ai.mit.edu/~jaffer/SLIB.html} -@end quotation +@dfn{packages} of Scheme procedures and syntax. As distributed, SLIB +contains useful packages for all Scheme implementations. Its catalog +can be transparently extended to accomodate packages specific to a site, +implementation, user, or directory. @end ifinfo @menu @@ -112,28 +129,6 @@ Aubrey Jaffer <jaffer@@ai.mit.edu>@* @node The Library System, Scheme Syntax Extension Packages, Top, Top @chapter The Library System -@iftex -@section Introduction - -@noindent -@cindex SLIB -@dfn{SLIB} is a portable library for the programming language -@cindex Scheme -@dfn{Scheme}. It provides a platform independent framework for using -@dfn{packages} of Scheme procedures and syntax. -@cindex packages -@cindex package -As distributed, SLIB contains useful packages for all implementations. -Its catalog can be transparently extended to accomodate packages -specific to a site, implementation, user, or directory. - -@quotation -Aubrey Jaffer <jaffer@@ai.mit.edu>@* -@i{Hyperactive Software} -- The Maniac Inside!@* -@url{http://swissnet.ai.mit.edu/~jaffer/SLIB.html} -@end quotation -@end iftex - @menu * Feature:: SLIB names. * Requesting Features:: @@ -608,7 +603,14 @@ An integer 1 larger that the largest value which can be returned by @end defvr @defvr Constant most-positive-fixnum -The immediate integer closest to positive infinity. +In implementations which support integers of practically unlimited size, +@var{most-positive-fixnum} is a large exact integer within the range of +exact integers that may result from computing the length of a list, +vector, or string. + +In implementations which do not support integers of practically +unlimited size, @var{most-positive-fixnum} is the largest exact integer +that may result from computing the length of a list, vector, or string. @end defvr @defvr Constant slib:tab @@ -630,7 +632,7 @@ Displays the versions of SLIB and the underlying Scheme implementation and the name of the operating system. An unspecified value is returned. @example -(slib:report-version) @result{} slib "2c3" on scm "5b1" on unix +(slib:report-version) @result{} slib "@value{SLIBVERSION}" on scm "5b1" on unix @end example @end defun @@ -648,7 +650,7 @@ Writes the report to file @file{filename}. @example (slib:report) @result{} -slib "2c3" on scm "5b1" on unix +slib "@value{SLIBVERSION}" on scm "5b1" on unix (implementation-vicinity) is "/home/jaffer/scm/" (library-vicinity) is "/home/jaffer/slib/" (scheme-file-suffix) is ".scm" @@ -1763,7 +1765,7 @@ In order to use syntax-case from an interactive top level, execute: @ftindex repl (repl:top-level macro:eval) @end lisp -See the section Repl (@xref{Repl}) for more information. +See the section Repl (@pxref{Repl}) for more information. To check operation of syntax-case get @file{cs.indiana.edu:/pub/scheme/syntax-case}, and type @@ -1951,7 +1953,7 @@ identity. Also known as ``send-to-super''.@refill @deffn Procedure print obj port A default @code{print} operation is provided which is just @code{(format -@var{port} @var{obj})} (@xref{Format}) for non-instances and prints +@var{port} @var{obj})} (@pxref{Format}) for non-instances and prints @var{obj} preceded by @samp{#<INSTANCE>} for instances. @end deffn @@ -1959,7 +1961,7 @@ A default @code{print} operation is provided which is just @code{(format The default method returns the number of elements in @var{obj} if it is a vector, string or list, @code{2} for a pair, @code{1} for a character and by default id an error otherwise. Objects such as collections -(@xref{Collections}) may override the default in an obvious way.@refill +(@pxref{Collections}) may override the default in an obvious way.@refill @end defun @@ -1975,7 +1977,7 @@ retrieves a value from a generalized location and the corresponding setter operation stores a value into the location. Only the getter is named -- the setter is specified by a procedure call as below. (Dylan uses special syntax.) Typically, but not necessarily, getters are -access operations to extract values from Yasos objects (@xref{Yasos}). +access operations to extract values from Yasos objects (@pxref{Yasos}). Several setters are predefined, corresponding to getters @code{car}, @code{cdr}, @code{string-ref} and @code{vector-ref} e.g., @code{(setter car)} is equivalent to @code{set-car!}. @@ -2038,7 +2040,8 @@ value is unspecified. @subsection Examples @lisp -;;; These definitions for PRINT and SIZE are already supplied by +;;; These definitions for PRINT and SIZE are +;;; already supplied by (require 'yasos) (define-operation (print obj port) @@ -2075,11 +2078,12 @@ value is unspecified. (format #t "Discarding ~s~%" value)) (define (make-filtered-cell value filter) - (object-with-ancestors ((cell (make-cell value))) - ((store! self newValue) - (if (filter newValue) - (store! cell newValue) - (discard self newValue))))) + (object-with-ancestors + ((cell (make-cell value))) + ((store! self newValue) + (if (filter newValue) + (store! cell newValue) + (discard self newValue))))) (define-predicate array?) (define-operation (array-ref array index)) @@ -2090,9 +2094,12 @@ value is unspecified. (object ((array? self) #t) ((size self) num-slots) - ((array-ref self index) (vector-ref anArray index)) - ((array-set! self index newValue) (vector-set! anArray index newValue)) - ((print self port) (format port "#<Array ~s>" (size self)))))) + ((array-ref self index) + (vector-ref anArray index)) + ((array-set! self index newValue) + (vector-set! anArray index newValue)) + ((print self port) + (format port "#<Array ~s>" (size self)))))) (define-operation (position obj)) (define-operation (discarded-value obj)) @@ -2112,7 +2119,8 @@ value is unspecified. (set! most-recent-discard value)) ((discarded-value self) most-recent-discard) ((print self port) - (format port "#<Cell-with-history ~s>" (fetch self)))))) + (format port "#<Cell-with-history ~s>" + (fetch self)))))) (define-access-operation fetch) (add-setter fetch store!) @@ -2199,7 +2207,7 @@ missing input. @noindent Here are the higher-level syntax types and an example of each. -Precedence considerations are omitted for clarity. @xref{Grammar +Precedence considerations are omitted for clarity. See @ref{Grammar Rule Definition} for full details. @deftp Grammar nofix bye exit @example @@ -2885,7 +2893,7 @@ Print a floating-point number in exponential notation. @samp{%e} prints between mantissa and exponont. @item @samp{g}, @samp{G} -Print a floating-point number in either normal or exponential notation, +Print a floating-point number in either fixed or exponential notation, whichever is more appropriate for its magnitude. Unless an @samp{#} flag has been supplied trailing zeros after a decimal point will be stripped off. @samp{%g} prints @samp{e} between mantissa and exponont. @@ -2917,7 +2925,7 @@ are output. @c Print the value of a pointer. @c @item @samp{n} -@c Get the number of characters printed so far. @xref{Other Output Conversions}. +@c Get the number of characters printed so far. See @ref{Other Output Conversions}. @c Note that this conversion specification never produces any output. @c @item @samp{m} @@ -3526,8 +3534,9 @@ ERROR: getopt->parameter-list "unrecognized option" "-?" @defun filename:match?? pattern @defunx filename:match-ci?? pattern -Returns a predicate which returns true if its string argument matches -(the string) @var{pattern}, false otherwise. Filename matching is like +Returns a predicate which returns a non-false value if its string argument +matches (the string) @var{pattern}, false otherwise. Filename matching +is like @cindex glob @dfn{glob} expansion described the bash manpage, except that names beginning with @samp{.} are matched and @samp{/} characters are not @@ -3551,8 +3560,39 @@ matched by including it as the first or last character in the set. @example @end example +@end defun +@defun filename:substitute?? pattern template +@defunx filename:substitute-ci?? pattern template +Returns a function transforming a single string argument according to +glob patterns @var{pattern} and @var{template}. @var{pattern} and +@var{template} must have the same number of wildcard specifications, +which need not be identical. @var{pattern} and @var{template} may have +a different number of literal sections. If an argument to the function +matches @var{pattern} in the sense of @code{filename:match??} then it +returns a copy of @var{template} in which each wildcard specification is +replaced by the part of the argument matched by the corresponding +wildcard specification in @var{pattern}. A @code{*} wildcard matches +the longest leftmost string possible. If the argument does not match +@var{pattern} then false is returned. + +@var{template} may be a function accepting the same number of string +arguments as there are wildcard specifications in @var{pattern}. In +the case of a match the result of applying @var{template} to a list +of the substrings matched by wildcard specifications will be returned, +otherwise @var{template} will not be called and @code{#f} will be returned. +@example +((filename:substitute?? "scm_[0-9]*.html" "scm5c4_??.htm") + "scm_10.html") +@result{} "scm5c4_10.htm" +((filename:substitute?? "??" "beg?mid?end") "AZ") +@result{} "begAmidZend" +((filename:substitute?? "*na*" "?NA?") "banana") +@result{} "banaNA" +((filename:substitute?? "?*?" (lambda (s1 s2 s3) (string-append s3 s1))) "ABZ") +@result{} "ZA" +@end example @end defun @defun replace-suffix str old new @@ -3594,6 +3634,8 @@ dos @item vms @item +amigados +@item system @item *unknown* @@ -3630,16 +3672,6 @@ only argument. If @var{file} is a string, result of @code{(current-output-port)} as its third argument. @end defun -@defun batch:apply-chop-to-fit proc arg1 arg2 @dots{} list -The procedure @var{proc} must accept at least one argument and return -@code{#t} if successful, @code{#f} if not. -@code{batch:apply-chop-to-fit} calls @var{proc} with @var{arg1}, -@var{arg2}, @dots{}, and @var{chunk}, where @var{chunk} is a subset of -@var{list}. @code{batch:apply-chop-to-fit} tries @var{proc} with -successively smaller subsets of @var{list} until either @var{proc} -returns non-false, or the @var{chunk}s become empty. -@end defun - @noindent The rest of the @code{batch:} procedures write (or execute if @code{batch-dialect} is @code{system}) commands to the batch port which @@ -3650,9 +3682,9 @@ code: (adjoin-parameters! @var{parms} (list 'batch-port @var{port})) @end example -@defun batch:system parms string1 string2 @dots{} -Calls @code{batch:try-system} (below) with arguments, but signals an -error if @code{batch:try-system} returns @code{#f}. +@defun batch:command parms string1 string2 @dots{} +Calls @code{batch:try-command} (below) with arguments, but signals an +error if @code{batch:try-command} returns @code{#f}. @end defun @noindent @@ -3661,17 +3693,32 @@ translated into the batch dialect and @code{#f} if not. In the case of the @code{system} dialect, the value is non-false if the operation suceeded. -@defun batch:try-system parms string1 string2 @dots{} +@defun batch:try-command parms string1 string2 @dots{} Writes a command to the @code{batch-port} in @var{parms} which executes the program named @var{string1} with arguments @var{string2} @dots{}. @end defun +@defun batch:try-chopped-command parms arg1 arg2 @dots{} list +breaks the last argument @var{list} into chunks small enough so that the +command: + +@example +@var{arg1} @var{arg2} @dots{} @var{chunk} +@end example + +fits withing the platform's maximum command-line length. + +@code{batch:try-chopped-command} calls @code{batch:try-command} with the +command and returns non-false only if the commands all fit and +@code{batch:try-command} of each command line returned non-false. +@end defun + @defun batch:run-script parms string1 string2 @dots{} Writes a command to the @code{batch-port} in @var{parms} which executes the batch script named @var{string1} with arguments @var{string2} @dots{}. -@emph{Note:} @code{batch:run-script} and @code{batch:try-system} are not the +@emph{Note:} @code{batch:run-script} and @code{batch:try-command} are not the same for some operating systems (VMS). @end defun @@ -3775,10 +3822,10 @@ Here is an example of the use of most of batch's procedures: " printf(\"hello world\\n\");" " return 0;" "@}" ) - (batch:system my-parameters "cc" "-c" "hello.c") - (batch:system my-parameters "cc" "-o" "hello" + (batch:command my-parameters "cc" "-c" "hello.c") + (batch:command my-parameters "cc" "-o" "hello" (replace-suffix "hello.c" ".c" ".o")) - (batch:system my-parameters "hello") + (batch:command my-parameters "hello") (batch:delete-file my-parameters "hello") (batch:delete-file my-parameters "hello.c") (batch:delete-file my-parameters "hello.o") @@ -3791,7 +3838,7 @@ Produces the file @file{my-batch}: @example #!/bin/sh -# "my-batch" build script created Sat Jun 10 21:20:37 1995 +# "my-batch" script created by SLIB/batch Sun Oct 31 18:24:10 1999 # ================ Write file with C program. mv -f hello.c hello.c~ rm -f hello.c @@ -3964,12 +4011,168 @@ thus can reduce loading time. The following will write into @section Time and Date @menu +* Time Zone:: * Posix Time:: 'posix-time * Common-Lisp Time:: 'common-lisp-time @end menu +@noindent +If @code{(provided? 'current-time)}: + +@noindent +The procedures @code{current-time}, @code{difftime}, and +@code{offset-time} deal with a @dfn{calendar time} datatype +@cindex time +@cindex calendar time +which may or may not be disjoint from other Scheme datatypes. + +@defun current-time +Returns the time since 00:00:00 GMT, January 1, 1970, measured in +seconds. Note that the reference time is different from the reference +time for @code{get-universal-time} in @ref{Common-Lisp Time}. +@end defun + +@defun difftime caltime1 caltime0 +Returns the difference (number of seconds) between twe calendar times: +@var{caltime1} - @var{caltime0}. @var{caltime0} may also be a number. +@end defun + +@defun offset-time caltime offset +Returns the calendar time of @var{caltime} offset by @var{offset} number +of seconds @code{(+ caltime offset)}. +@end defun + +@node Time Zone, Posix Time, Time and Date, Time and Date +@subsection Time Zone + +(require 'time-zone) + +@deftp {Data Format} TZ-string + +POSIX standards specify several formats for encoding time-zone rules. + +@table @t +@item :@i{<pathname>} +If the first character of @i{<pathname>} is @samp{/}, then +@i{<pathname>} specifies the absolute pathname of a tzfile(5) format +time-zone file. Otherwise, @i{<pathname>} is interpreted as a pathname +within @var{tzfile:vicinity} (/usr/lib/zoneinfo/) naming a tzfile(5) +format time-zone file. +@item @i{<std>}@i{<offset>} +The string @i{<std>} consists of 3 or more alphabetic characters. +@i{<offset>} specifies the time difference from GMT. The @i{<offset>} +is positive if the local time zone is west of the Prime Meridian and +negative if it is east. @i{<offset>} can be the number of hours or +hours and minutes (and optionally seconds) separated by @samp{:}. For +example, @code{-4:30}. +@item @i{<std>}@i{<offset>}@i{<dst>} +@i{<dst>} is the at least 3 alphabetic characters naming the local +daylight-savings-time. +@item @i{<std>}@i{<offset>}@i{<dst>}@i{<doffset>} +@i{<doffset>} specifies the offset from the Prime Meridian when +daylight-savings-time is in effect. +@end table + +The non-tzfile formats can optionally be followed by transition times +specifying the day and time when a zone changes from standard to +daylight-savings and back again. + +@table @t +@item ,@i{<date>}/@i{<time>},@i{<date>}/@i{<time>} +The @i{<time>}s are specified like the @i{<offset>}s above, except that +leading @samp{+} and @samp{-} are not allowed. + +Each @i{<date>} has one of the formats: + +@table @t +@item J@i{<day>} +specifies the Julian day with @i{<day>} between 1 and 365. February 29 +is never counted and cannot be referenced. +@item @i{<day>} +This specifies the Julian day with n between 0 and 365. February 29 is +counted in leap years and can be specified. +@item M@i{<month>}.@i{<week>}.@i{<day>} +This specifies day @i{<day>} (0 <= @i{<day>} <= 6) of week @i{<week>} (1 +<= @i{<week>} <= 5) of month @i{<month>} (1 <= @i{<month>} <= 12). Week +1 is the first week in which day d occurs and week 5 is the last week in +which day @i{<day>} occurs. Day 0 is a Sunday. +@end table +@end table + +@end deftp + +@deftp {Data Type} time-zone +is a datatype encoding how many hours from Greenwich Mean Time the local +time is, and the @dfn{Daylight Savings Time} rules for changing it. +@end deftp + +@defun time-zone TZ-string +Creates and returns a time-zone object specified by the string +@var{TZ-string}. If @code{time-zone} cannot interpret @var{TZ-string}, +@code{#f} is returned. +@end defun + +@defun tz:params caltime tz +@var{tz} is a time-zone object. @code{tz:params} returns a list of +three items: +@enumerate 0 +@item +An integer. 0 if standard time is in effect for timezone @var{tz} at +@var{caltime}; 1 if daylight savings time is in effect for timezone +@var{tz} at @var{caltime}. +@item +The number of seconds west of the Prime Meridian timezone @var{tz} is at +@var{caltime}. +@item +The name for timezone @var{tz} at @var{caltime}. +@end enumerate + +@code{tz:params} is unaffected by the default timezone; inquiries can be +made of any timezone at any calendar time. + +@end defun + +@noindent +The rest of these procedures and variables are provided for POSIX +compatability. Because of shared state they are not thread-safe. + +@defun tzset +Returns the default time-zone. + +@defunx tzset tz +Sets (and returns) the default time-zone to @var{tz}. + +@defunx tzset TZ-string +Sets (and returns) the default time-zone to that specified by +@var{TZ-string}. + +@code{tzset} also sets the variables @var{*timezone*}, @var{daylight?}, +and @var{tzname}. This function is automatically called by the time +conversion procedures which depend on the time zone (@pxref{Time and +Date}). +@end defun + +@defvar *timezone* +Contains the difference, in seconds, between Greenwich Mean Time and +local standard time (for example, in the U.S. Eastern time zone (EST), +timezone is 5*60*60). @code{*timezone*} is initialized by @code{tzset}. +@end defvar + +@defvar daylight? +is @code{#t} if the default timezone has rules for @dfn{Daylight Savings +Time}. @emph{Note:} @var{daylight?} does not tell you when Daylight +Savings Time is in effect, just that the default zone sometimes has +Daylight Savings Time. +@end defvar -@node Posix Time, Common-Lisp Time, Time and Date, Time and Date +@defvar tzname +is a vector of strings. Index 0 has the abbreviation for the standard +timezone; If @var{daylight?}, then index 1 has the abbreviation for the +Daylight Savings timezone. +@end defvar + + +@node Posix Time, Common-Lisp Time, Time Zone, Time and Date @subsection Posix Time @example @@ -4297,14 +4500,14 @@ in schmooz comments. @menu * Bit-Twiddling:: 'logical * Modular Arithmetic:: 'modular -* Prime Testing and Generation:: 'primes -* Prime Factorization:: 'factor +* Prime Numbers:: 'factor * Random Numbers:: 'random +* Fast Fourier Transform:: 'fft * Cyclic Checksum:: 'make-crc * Plotting:: 'charplot * Root Finding:: 'root * Commutative Rings:: 'commutative-ring -* Determinant:: +* Determinant:: 'determinant @end menu @@ -4502,7 +4705,7 @@ Example: @end lisp @end defun -@node Modular Arithmetic, Prime Testing and Generation, Bit-Twiddling, Mathematical Packages +@node Modular Arithmetic, Prime Numbers, Bit-Twiddling, Mathematical Packages @section Modular Arithmetic @code{(require 'modular)} @@ -4584,184 +4787,18 @@ Returns (@var{k2} ^ @var{k3}) mod @var{modulus}. @end defun -@node Prime Testing and Generation, Prime Factorization, Modular Arithmetic, Mathematical Packages -@section Prime Testing and Generation - -@code{(require 'primes)} -@ftindex primes - -This package tests and generates prime numbers. The strategy used is -as follows: - -@itemize @bullet -@item -First, use trial division by small primes (primes less than 1000) to -quickly weed out composites with small factors. As a side benefit, this -makes the test precise for numbers up to one million. -@item -Second, apply the Miller-Rabin primality test to detect (with high -probability) any remaining composites. -@end itemize - -The Miller-Rabin test is a Monte-Carlo test---in other words, it's fast -and it gets the right answer with high probability. For a candidate -that @emph{is} prime, the Miller-Rabin test is certain to report -"prime"; it will never report "composite". However, for a candidate -that is composite, there is a (small) probability that the Miller-Rabin -test will erroneously report "prime". This probability can be made -arbitarily small by adjusting the number of iterations of the -Miller-Rabin test. - -@defun probably-prime? candidate -@defunx probably-prime? candidate iter -Returns @code{#t} if @code{candidate} is probably prime. The optional -parameter @code{iter} controls the number of iterations of the -Miller-Rabin test. The probability of a composite candidate being -mistaken for a prime is at most @code{(1/4)^iter}. The default value of -@code{iter} is 15, which makes the probability less than 1 in 10^9. - -@end defun - -@defun primes< start count -@defunx primes< start count iter -@defunx primes> start count -@defunx primes> start count iter -Returns a list of the first @code{count} odd probable primes less (more) -than or equal to @code{start}. The optional parameter @code{iter} -controls the number of iterations of the Miller-Rabin test for each -candidate. The probability of a composite candidate being mistaken for -a prime is at most @code{(1/4)^iter}. The default value of @code{iter} -is 15, which makes the probability less than 1 in 10^9. - -@end defun -@menu -* The Miller-Rabin Test:: How the Miller-Rabin test works -@end menu - -@node The Miller-Rabin Test, , Prime Testing and Generation, Prime Testing and Generation -@subsection Theory - -Rabin and Miller's result can be summarized as follows. Let @code{p} -(the candidate prime) be any odd integer greater than 2. Let @code{b} -(the "base") be an integer in the range @code{2 ... p-1}. There is a -fairly simple Boolean function---call it @code{C}, for -"Composite"---with the following properties: -@itemize @bullet - -@item -If @code{p} is prime, @code{C(p, b)} is false for all @code{b} in the range -@code{2 ... p-1}. - -@item -If @code{p} is composite, @code{C(p, b)} is false for at most 1/4 of all -@code{b} in the range @code{ 2 ... p-1}. (If the test fails for base -@code{b}, @code{p} is called a @emph{strong pseudo-prime to base -@code{b}}.) - -@end itemize -For details of @code{C}, and why it fails for at most 1/4 of the -potential bases, please consult a book on number theory or cryptography -such as "A Course in Number Theory and Cryptography" by Neal Koblitz, -published by Springer-Verlag 1994. - -There is nothing probablistic about this result. It's true for all -@code{p}. If we had time to test @code{(1/4)p + 1} different bases, we -could definitively determine the primality of @code{p}. For large -candidates, that would take much too long---much longer than the simple -approach of dividing by all numbers up to @code{sqrt(p)}. This is -where probability enters the picture. - -Suppose we have some candidate prime @code{p}. Pick a random integer -@code{b} in the range @code{2 ... p-1}. Compute @code{C(p,b)}. If -@code{p} is prime, the result will certainly be false. If @code{p} is -composite, the probability is at most 1/4 that the result will be false -(demonstrating that @code{p} is a strong pseudoprime to base @code{b}). -The test can be repeated with other random bases. If @code{p} is prime, -each test is certain to return false. If @code{p} is composite, the -probability of @code{C(p,b)} returning false is at most 1/4 for each -test. Since the @code{b} are chosen at random, the tests outcomes are -independent. So if @code{p} is composite and the test is repeated, say, -15 times, the probability of it returning false all fifteen times is at -most (1/4)^15, or about 10^-9. If the test is repeated 30 times, the -probability of failure drops to at most 8.3e-25. - -Rabin and Miller's result holds for @emph{all} candidates @code{p}. -However, if the candidate @code{p} is picked at random, the probability -of the Miller-Rabin test failing is much less than the computed bound. -This is because, for @emph{most} composite numbers, the fraction of -bases that cause the test to fail is much less than 1/4. For example, -if you pick a random odd number less than 1000 and apply the -Miller-Rabin test with only 3 random bases, the computed failure bound -is (1/4)^3, or about 1.6e-2. However, the actual probability of failure -is much less---about 7.2e-5. If you accidentally pick 703 to test for -primality, the probability of failure is (161/703)^3, or about 1.2e-2, -which is almost as high as the computed bound. This is because 703 is a -strong pseudoprime to 161 bases. But if you pick at random there is -only a small chance of picking 703, and no other number less than 1000 -has that high a percentage of pseudoprime bases. - -The Miller-Rabin test is sometimes used in a slightly different fashion, -where it can, at least in principle, cause problems. The weaker version -uses small prime bases instead of random bases. If you are picking -candidates at random and testing for primality, this works well since -very few composites are strong pseudo-primes to small prime bases. (For -example, there is only one composite less than 2.5e10 that is a strong -pseudo-prime to the bases 2, 3, 5, and 7.) The problem with this -approach is that once a candidate has been picked, the test is -deterministic. This distinction is subtle, but real. With the -randomized test, for @emph{any} candidate you pick---even if your -candidate-picking procedure is strongly biased towards troublesome -numbers, the test will work with high probability. With the -deterministic version, for any particular candidate, the test will -either work (with probability 1), or fail (with probability 1). It -won't fail for very many candidates, but that won't be much consolation -if your candidate-picking procedure is somehow biased toward troublesome -numbers. - - -@node Prime Factorization, Random Numbers, Prime Testing and Generation, Mathematical Packages -@section Prime Factorization +@node Prime Numbers, Random Numbers, Modular Arithmetic, Mathematical Packages +@section Prime Numbers @code{(require 'factor)} @ftindex factor +@ftindex primes - -@defun factor k -Returns a list of the prime factors of @var{k}. The order of the -factors is unspecified. In order to obtain a sorted list do -@code{(sort! (factor k) <)}.@refill -@end defun - -@emph{Note:} The rest of these procedures implement the Solovay-Strassen -primality test. This test has been superseeded by the faster -@xref{Prime Testing and Generation, probably-prime?}. However these are -left here as they take up little space and may be of use to an -implementation without bignums. - -See Robert Solovay and Volker Strassen, @cite{A Fast Monte-Carlo Test -for Primality}, SIAM Journal on Computing, 1977, pp 84-85. - -@defun jacobi-symbol p q -Returns the value (+1, @minus{}1, or 0) of the Jacobi-Symbol of exact -non-negative integer @var{p} and exact positive odd integer -@var{q}.@refill -@end defun - -@defun prime? p -Returns @code{#f} if @var{p} is composite; @code{#t} if @var{p} is -prime. There is a slight chance @code{(expt 2 (- prime:trials))} that a -composite will return @code{#t}.@refill -@end defun - -@defun prime:trials -Is the maxinum number of iterations of Solovay-Strassen that will be -done to test a number for primality. -@end defun - +@c @include factor.txi -@node Random Numbers, Cyclic Checksum, Prime Factorization, Mathematical Packages +@node Random Numbers, Fast Fourier Transform, Prime Numbers, Mathematical Packages @section Random Numbers @code{(require 'random)} @@ -4773,7 +4810,7 @@ A pseudo-random number generator is only as good as the tests it passes. George Marsaglia of Florida State University developed a battery of tests named @dfn{DIEHARD} (@url{http://stat.fsu.edu/~geo/diehard.html}). @file{diehard.c} has a bug which the patch -@url{ftp://swissnet.ai.mit.edu/pub/users/jaffer/diehard.c.pat} corrects. +@url{http://swissnet.ai.mit.edu/ftpdir/users/jaffer/diehard.c.pat} corrects. SLIB's new PRNG generates 8 bits at a time. With the degenerate seed @samp{0}, the numbers generated pass DIEHARD; but when bits are combined @@ -4781,87 +4818,49 @@ from sequential bytes, tests fail. With the seed @samp{http://swissnet.ai.mit.edu/~jaffer/SLIB.html}, all of those tests pass. -It would be better if there were no bad seeds. For now, use seeds of at -least 30 bytes. +@c @include random.txi -@deffn Procedure random n -@deffnx Procedure random n state -Accepts a positive integer or real @var{n} and returns a number of the -same type between zero (inclusive) and @var{n} (exclusive). The values -returned have a uniform distribution.@refill -The optional argument @var{state} must be of the type produced by -@code{(make-random-state)}. It defaults to the value of the variable -@code{*random-state*}. This object is used to maintain the state of the -pseudo-random-number generator and is altered as a side effect of the -@code{random} operation.@refill -@end deffn +If inexact numbers are supported by the Scheme implementation, +@file{randinex.scm} will be loaded as well. @file{randinex.scm} +contains procedures for generating inexact distributions. -@defvar *random-state* -Holds a data structure that encodes the internal state of the -random-number generator that @code{random} uses by default. The nature -of this data structure is implementation-dependent. It may be printed -out and successfully read back in, but may or may not function correctly -as a random-number state object in another implementation.@refill -@end defvar +@c @include randinex.txi -@deffn Procedure make-random-state -@deffnx Procedure make-random-state state -Returns a new object of type suitable for use as the value of the -variable @code{*random-state*} and as a second argument to -@code{random}. If argument @var{state} is given, a copy of it is -returned. Otherwise a copy of @code{*random-state*} is returned.@refill -@end deffn -If inexact numbers are supported by the Scheme implementation, -@file{randinex.scm} will be loaded as well. @file{randinex.scm} -contains procedures for generating inexact distributions.@refill +@node Fast Fourier Transform, Cyclic Checksum, Random Numbers, Mathematical Packages +@section Fast Fourier Transform -@deffn Procedure random:uniform state -Returns an uniformly distributed inexact real random number in the -range between 0 and 1. -@end deffn +@code{(require 'fft)} +@ftindex fft -@deffn Procedure random:solid-sphere! vect -@deffnx Procedure random:solid-sphere! vect state -Fills @var{vect} with inexact real random numbers the sum of whose -squares is less than 1.0. Thinking of @var{vect} as coordinates in -space of dimension @var{n} = @code{(vector-length @var{vect})}, the -coordinates are uniformly distributed within the unit @var{n}-shere. -The sum of the squares of the numbers is returned.@refill -@end deffn +@defun fft array +@var{array} is an array of @code{(expt 2 n)} numbers. @code{fft} +returns an array of complex numbers comprising the @dfn{Discrete Fourier +Transform} of @var{array}. -@deffn Procedure random:hollow-sphere! vect -@deffnx Procedure random:hollow-sphere! vect state -Fills @var{vect} with inexact real random numbers the sum of whose -squares is equal to 1.0. Thinking of @var{vect} as coordinates in space -of dimension n = @code{(vector-length @var{vect})}, the coordinates are -uniformly distributed over the surface of the unit n-shere.@refill -@end deffn +@defunx fft-1 array +@code{fft-1} returns an array of complex numbers comprising the inverse +Discrete Fourier Transform of @var{array}. +@end defun -@deffn Procedure random:normal -@deffnx Procedure random:normal state -Returns an inexact real in a normal distribution with mean 0 and -standard deviation 1. For a normal distribution with mean @var{m} and -standard deviation @var{d} use @code{(+ @var{m} (* @var{d} -(random:normal)))}.@refill -@end deffn +@code{(fft-1 (fft @var{array}))} will return an array of values close to +@var{array}. -@deffn Procedure random:normal-vector! vect -@deffnx Procedure random:normal-vector! vect state -Fills @var{vect} with inexact real random numbers which are independent -and standard normally distributed (i.e., with mean 0 and variance 1). -@end deffn +@example +(fft '#(1 0+i -1 0-i 1 0+i -1 0-i)) @result{} -@deffn Procedure random:exp -@deffnx Procedure random:exp state -Returns an inexact real in an exponential distribution with mean 1. For -an exponential distribution with mean @var{u} use (* @var{u} -(random:exp)).@refill -@end deffn +#(0.0 0.0 0.0+628.0783185208527e-18i 0.0 + 0.0 0.0 8.0-628.0783185208527e-18i 0.0) + +(fft-1 '#(0 0 0 0 0 0 8 0)) @result{} + +#(1.0 -61.23031769111886e-18+1.0i -1.0 61.23031769111886e-18-1.0i + 1.0 -61.23031769111886e-18+1.0i -1.0 61.23031769111886e-18-1.0i) +@end example -@node Cyclic Checksum, Plotting, Random Numbers, Mathematical Packages +@node Cyclic Checksum, Plotting, Fast Fourier Transform, Mathematical Packages @section Cyclic Checksum @code{(require 'make-crc)} @@ -5016,7 +5015,7 @@ non-zero, and positive real number @var{prec}, returns a real @var{x} for which @code{abs}(@var{f}(@var{x})) is less than @var{prec}; or returns @code{#f} if such a real can't be found. -If @code{prec} is instead a negative integer, @code{newton:find-root} +If @var{prec} is instead a negative integer, @code{newton:find-root} returns the result of -@var{prec} iterations. @end defun @@ -5040,7 +5039,7 @@ real number @var{prec}, returns a complex number @var{z} for which @code{magnitude}(@var{f}(@var{z})) is less than @var{prec}; or returns @code{#f} if such a number can't be found. -If @code{prec} is instead a negative integer, @code{laguerre:find-root} +If @var{prec} is instead a negative integer, @code{laguerre:find-root} returns the result of -@var{prec} iterations. @end defun @@ -5052,38 +5051,89 @@ positive real number @var{prec}, returns a complex number @var{z} for which @code{magnitude}(@var{f}(@var{z})) is less than @var{prec}; or returns @code{#f} if such a number can't be found. -If @code{prec} is instead a negative integer, +If @var{prec} is instead a negative integer, @code{laguerre:find-polynomial-root} returns the result of -@var{prec} iterations. @end defun +@defun secant:find-root f x0 x1 prec +@defunx secant:find-bracketed-root f x0 x1 prec +Given a real valued procedure @var{f} and two real valued starting +points @var{x0} and @var{x1}, returns a real @var{x} for which +@code{(abs (f x))} is less than @var{prec}; or returns +@code{#f} if such a real can't be found. + +If @var{x0} and @var{x1} are chosen such that they bracket a root, that is +@example +(or (< (f x0) 0 (f x1)) + (< (f x1) 0 (f x0))) +@end example +then the root returned will be between @var{x0} and @var{x1}, and +@var{f} will not be passed an argument outside of that interval. + +@code{secant:find-bracketed-root} will return @code{#f} unless @var{x0} +and @var{x1} bracket a root. + +The secant method is used until a bracketing interval is found, at which point +a modified @i{regula falsi} method is used. + +If @var{prec} is instead a negative integer, @code{secant:find-root} +returns the result of -@var{prec} iterations. + +If @var{prec} is a procedure it should accept 5 arguments: @var{x0} +@var{f0} @var{x1} @var{f1} and @var{count}, where @var{f0} will be +@code{(f x0)}, @var{f1} @code{(f x1)}, and @var{count} the number of +iterations performed so far. @var{prec} should return non-false +if the iteration should be stopped. +@end defun + @node Commutative Rings, Determinant, Root Finding, Mathematical Packages @section Commutative Rings Scheme provides a consistent and capable set of numeric functions. Inexacts implement a field; integers a commutative ring (and Euclidean -domain). This package allows the user to use basic Scheme numeric -functions with symbols and non-numeric elements of commutative rings. +domain). This package allows one to use basic Scheme numeric functions +with symbols and non-numeric elements of commutative rings. @code{(require 'commutative-ring)} @ftindex commutative-ring @cindex ring, commutative -The @dfn{commutative-ring} package makes @code{+}, @code{-}, @code{*}, -@code{/}, and @code{^} @dfn{careful} in the sense that any non-numeric +The @dfn{commutative-ring} package makes the procedures @code{+}, +@code{-}, @code{*}, @code{/}, and @code{^} @dfn{careful} in the sense @cindex careful -arguments which it cannot reduce appear in the expression output. In -order to see what working with this package is like, self-set all the -single letter identifiers (to their corresponding symbols). +that any non-numeric arguments they do not reduce appear in the +expression output. In order to see what working with this package is +like, self-set all the single letter identifiers (to their corresponding +symbols). @example (define a 'a) @dots{} (define z 'z) @end example -Or just @code{(require 'self-set)}. Now for some sample expressions: + +Or just @code{(require 'self-set)}. Now try some sample expressions: @example +(+ (+ a b) (- a b)) @result{} (* a 2) +(* (+ a b) (+ a b)) @result{} (^ (+ a b) 2) +(* (+ a b) (- a b)) @result{} (* (+ a b) (- a b)) +(* (- a b) (- a b)) @result{} (^ (- a b) 2) +(* (- a b) (+ a b)) @result{} (* (+ a b) (- a b)) +(/ (+ a b) (+ c d)) @result{} (/ (+ a b) (+ c d)) +(^ (+ a b) 3) @result{} (^ (+ a b) 3) +(^ (+ a 2) 3) @result{} (^ (+ 2 a) 3) +@end example + +Associative rules have been applied and repeated addition and +multiplication converted to multiplication and exponentiation. + +We can enable distributive rules, thus expanding to sum of products +form: +@example +(set! *ruleset* (combined-rulesets distribute* distribute/)) + (* (+ a b) (+ a b)) @result{} (+ (* 2 a b) (^ a 2) (^ b 2)) (* (+ a b) (- a b)) @result{} (- (^ a 2) (^ b 2)) (* (- a b) (- a b)) @result{} (- (+ (^ a 2) (^ b 2)) (* 2 a b)) @@ -5093,7 +5143,7 @@ Or just @code{(require 'self-set)}. Now for some sample expressions: (/ (- a b) (- c d)) @result{} (- (/ a (- c d)) (/ b (- c d))) (/ (- a b) (+ c d)) @result{} (- (/ a (+ c d)) (/ b (+ c d))) (^ (+ a b) 3) @result{} (+ (* 3 a (^ b 2)) (* 3 b (^ a 2)) (^ a 3) (^ b 3)) -(^ (+ a 2) 3) @result{} (+ 8 (* a 12) (* (^ a 2) 6) (^ a 3)) +(^ (+ a 2) 3) @result{} (+ 8 (* a 12) (* (^ a 2) 6) (^ a 3)) @end example Use of this package is not restricted to simple arithmetic expressions: @@ -5105,13 +5155,6 @@ Use of this package is not restricted to simple arithmetic expressions: (- (+ (* a e i) (* b f g) (* c d h)) (* a f h) (* b d i) (* c e g)) @end example -The @dfn{commutative-ring} package differs from other extension -mechanisms in that it automatically, using properties true of all -commutative rings, simplifies sum and product expressions containing -non-numeric elements. One need only specify behavior for @code{+} or -@code{*} for cases where expressions involving objects reduce to numbers -or to expressions involving different non-numeric elements. - Currently, only @code{+}, @code{-}, @code{*}, @code{/}, and @code{^} support non-numeric elements. Expressions with @code{-} are converted to equivalent expressions without @code{-}, so behavior for @code{-} is @@ -5123,6 +5166,55 @@ the more restrictive Euclidean (Unique Factorization) Domain. @cindex Unique Factorization @cindex Euclidean Domain +@heading Rules and Rulesets + +The @dfn{commutative-ring} package allows control of ring properties +through the use of @dfn{rulesets}. + +@defvar *ruleset* +Contains the set of rules currently in effect. Rules defined by +@code{cring:define-rule} are stored within the value of *ruleset* at the +time @code{cring:define-rule} is called. If @var{*ruleset*} is +@code{#f}, then no rules apply. +@end defvar + +@defun make-ruleset rule1 @dots{} +@defunx make-ruleset name rule1 @dots{} +Returns a new ruleset containing the rules formed by applying +@code{cring:define-rule} to each 4-element list argument @var{rule}. If +the first argument to @code{make-ruleset} is a symbol, then the database +table created for the new ruleset will be named @var{name}. Calling +@code{make-ruleset} with no rule arguments creates an empty ruleset. +@end defun + +@defun combined-rulesets ruleset1 @dots{} +@defunx combined-rulesets name ruleset1 @dots{} +Returns a new ruleset containing the rules contained in each ruleset +argument @var{ruleset}. If the first argument to +@code{combined-ruleset} is a symbol, then the database table created for +the new ruleset will be named @var{name}. Calling +@code{combined-ruleset} with no ruleset arguments creates an empty +ruleset. +@end defun + +Two rulesets are defined by this package. + +@defvr Constant distribute* +Contain the ruleset to distribute multiplication over addition and +subtraction. +@defvrx Constant distribute/ +Contain the ruleset to distribute division over addition and +subtraction. + +Take care when using both @var{distribute*} and @var{distribute/} +simultaneously. It is possible to put @code{/} into an infinite loop. +@end defvr + +You can specify how sum and product expressions containing non-numeric +elements simplify by specifying the rules for @code{+} or @code{*} for +cases where expressions involving objects reduce to numbers or to +expressions involving different non-numeric elements. + @defun cring:define-rule op sub-op1 sub-op2 reduction Defines a rule for the case when the operation represented by symbol @var{op} is applied to lists whose @code{car}s are @var{sub-op1} and @@ -5144,8 +5236,8 @@ that value will replace the two arguments in arithmetic (@code{+}, The operations @code{+} and @code{*} are assumed commutative; hence both orders of arguments to @var{reduction} will be tried if necessary. -The following rule is the built-in definition for distributing @code{*} -over @code{+}. +The following rule is the definition for distributing @code{*} over +@code{+}. @example (cring:define-rule @@ -5749,7 +5841,7 @@ to. If @var{filename} is @code{#f} a temporary, non-disk based database will be created if such can be supported by the underlying base table implelentation. If the database cannot be created as specified @code{#f} is returned. For the fields and layout of descriptor tables, -@xref{Catalog Representation} +@ref{Catalog Representation} @end defun @defun open-database filename mutable? @@ -6676,6 +6768,31 @@ The table is created as ascii text and written to the file named by @var{destination} is the primary key for a row in the table named *printers*. @end table +The report is prepared as follows: + +@itemize @bullet +@item +@code{Format} (@pxref{Format}) is called with the @code{header} field +and the (list of) @code{column-names} of the table. +@item +@code{Format} is called with the @code{reporter} field and (on +successive calls) each record in the natural order for the table. A +count is kept of the number of newlines output by format. When the +number of newlines to be output exceeds the number of lines per page, +the set of lines will be broken if there are more than +@code{minimum-break} left on this page and the number of lines for this +row is larger or equal to twice @code{minimum-break}. +@item +@code{Format} is called with the @code{footer} field and the (list of) +@code{column-names} of the table. The footer field should not output a +newline. +@item +A new page is output. +@item +This entire process repeats until all the rows are output. +@end itemize +@end deffn + Each row in the table *reports* has the fields: @table @asis @@ -6705,30 +6822,6 @@ The printer name. The procedure to call to actually print. @end table -The report is prepared as follows: - -@itemize @bullet -@item -@code{Format} (@pxref{Format}) is called with the @code{header} field -and the (list of) @code{column-names} of the table. -@item -@code{Format} is called with the @code{reporter} field and (on -successive calls) each record in the natural order for the table. A -count is kept of the number of newlines output by format. When the -number of newlines to be output exceeds the number of lines per page, -the set of lines will be broken if there are more than -@code{minimum-break} left on this page and the number of lines for this -row is larger or equal to twice @code{minimum-break}. -@item -@code{Format} is called with the @code{footer} field and the (list of) -@code{column-names} of the table. The footer field should not output a -newline. -@item -A new page is output. -@item -This entire process repeats until all the rows are output. -@end itemize -@end deffn @node Database Browser, , Database Reports, Relational Database @@ -7304,6 +7397,7 @@ operation is equivalent to * Dynamic Data Type:: 'dynamic * Hash Tables:: 'hash-table * Hashing:: 'hash, 'sierpinski, 'soundex +* Object:: 'object * Priority Queues:: 'priority-queue * Queues:: 'queue * Records:: 'record @@ -7637,7 +7731,7 @@ Dylan(TM) language, but with a different interface. They have @dfn{elements} indexed by corresponding @dfn{keys}, although the keys may be implicit (as with lists).@refill -New types of collections may be defined as YASOS objects (@xref{Yasos}). +New types of collections may be defined as YASOS objects (@pxref{Yasos}). They must support the following operations: @itemize @bullet @item @@ -7709,10 +7803,10 @@ collection; they are potentially more efficient. @defun reduce proc seed . collections A generalization of the list-based @code{comlist:reduce-init} -(@xref{Lists as sequences}) to collections which will shadow the +(@pxref{Lists as sequences}) to collections which will shadow the list-based version if @code{(require 'collect)} follows @ftindex collect -@code{(require 'common-list-functions)} (@xref{Common List +@code{(require 'common-list-functions)} (@pxref{Common List Functions}).@refill @ftindex common-list-functions @@ -7726,7 +7820,7 @@ Examples: @end defun @defun any? pred . collections -A generalization of the list-based @code{some} (@xref{Lists as +A generalization of the list-based @code{some} (@pxref{Lists as sequences}) to collections.@refill Example: @@ -7737,7 +7831,7 @@ Example: @end defun @defun every? pred . collections -A generalization of the list-based @code{every} (@xref{Lists as +A generalization of the list-based @code{every} (@pxref{Lists as sequences}) to collections.@refill Example: @@ -7758,7 +7852,7 @@ Returns the number of elements in @var{collection}. @end defun @defun Setter list-ref -See @xref{Setters} for a definition of @dfn{setter}. N.B. +See @ref{Setters} for a definition of @dfn{setter}. N.B. @code{(setter list-ref)} doesn't work properly for element 0 of a list.@refill @end defun @@ -7939,7 +8033,7 @@ unspecified. -@node Hashing, Priority Queues, Hash Tables, Data Structures +@node Hashing, Object, Hash Tables, Data Structures @subsection Hashing @code{(require 'hash)} @@ -8076,7 +8170,12 @@ Some cases in which the algorithm fails (Knuth): @end defun -@node Priority Queues, Queues, Hashing, Data Structures +@node Object, Priority Queues, Hashing, Data Structures +@subsection Macroless Object System +@include objdoc.txi + + +@node Priority Queues, Queues, Object, Data Structures @subsection Priority Queues @code{(require 'priority-queue)} @@ -8454,8 +8553,8 @@ Example: @node Lists as sets, Lists as sequences, List construction, Common List Functions @subsubsection Lists as sets -@code{eq?} is used to test for membership by all the procedures below -which treat lists as sets.@refill +@code{eqv?} is used to test for membership by procedures which treat +lists as sets. @defun adjoin e l @code{adjoin} returns the adjoint of the element @var{e} and the list @@ -8653,6 +8752,7 @@ Example: @defun has-duplicates? lst returns @code{#t} if 2 members of @var{lst} are @code{equal?}, @code{#f} otherwise. + Example: @lisp (has-duplicates? '(1 2 3 4)) @@ -8663,6 +8763,23 @@ Example: @end lisp @end defun +The procedure @code{remove-duplicates} uses @code{member} (rather than +@code{memv}). + +@defun remove-duplicates lst +returns a copy of @var{lst} with its duplicate members removed. +Elements are considered duplicate if they are @code{equal?}. + +Example: +@lisp +(remove-duplicates '(1 2 3 4)) + @result{} (4 3 2 1) + +(remove-duplicates '(2 4 3 4)) + @result{} (3 4 2) +@end lisp +@end defun + @node Lists as sequences, Destructive list operations, Lists as sets, Common List Functions @subsubsection Lists as sequences @@ -8688,7 +8805,7 @@ operation (the combination is left-associative). For example, using @code{+}, one can add up all the elements. @code{reduce} allows you to apply a function which accepts only two arguments to more than 2 objects. Functional programmers usually refer to this as @dfn{foldl}. -@code{collect:reduce} (@xref{Collections}) provides a version of +@code{collect:reduce} (@pxref{Collections}) provides a version of @code{collect} generalized to collections.@refill Example: @@ -8871,7 +8988,7 @@ mutation is undefined. @deffn Procedure nconc args @code{nconc} destructively concatenates its arguments. (Compare this with @code{append}, which copies arguments rather than destroying them.) -Sometimes called @code{append!} (@xref{Rev2 Procedures}).@refill +Sometimes called @code{append!} (@pxref{Rev2 Procedures}).@refill Example: You want to find the subsets of a set. Here's the obvious way: @@ -9471,34 +9588,7 @@ with @var{new2} @dots{}. @code{(require 'line-i/o)} @ftindex line-i -@defun read-line -@defunx read-line port -Returns a string of the characters up to, but not including a newline or -end of file, updating @var{port} to point to the character following the -newline. If no characters are available, an end of file object is -returned. @var{port} may be omitted, in which case it defaults to the -value returned by @code{current-input-port}.@refill -@end defun - -@defun read-line! string -@defunx read-line! string port -Fills @var{string} with characters up to, but not including a newline or -end of file, updating the port to point to the last character read or -following the newline if it was read. If no characters are available, -an end of file object is returned. If a newline or end of file was -found, the number of characters read is returned. Otherwise, @code{#f} -is returned. @var{port} may be omitted, in which case it defaults to -the value returned by @code{current-input-port}.@refill -@end defun - -@defun write-line string -@defunx write-line string port -Writes @var{string} followed by a newline to the given port and returns -an unspecified value. Port may be omited, in which case it defaults to -the value returned by @code{current-input-port}.@refill -@end defun - - +@c @include lineio.txi @node Multi-Processing, , Line I/O, Procedures @@ -9531,7 +9621,7 @@ unspecified.@refill @deffn Procedure kill-process! Kills the current process and runs the next process from @code{process:queue}. If there are no more processes on -@code{process:queue}, @code{(slib:exit)} is called (@xref{System}). +@code{process:queue}, @code{(slib:exit)} is called (@pxref{System}). @end deffn @@ -9929,8 +10019,7 @@ unspecified.@refill * Debug:: To err is human ... * Breakpoints:: Pause execution * Trace:: 'trace -* System Interface:: 'system and 'getenv -* Time Zone:: +* System Interface:: 'system, 'getenv, and 'net-clients @end menu @@ -9988,7 +10077,7 @@ much improved. @quotation Notice that the neccessity for truncating output eliminates -Common-Lisp's @xref{Format} from consideration; even when variables +Common-Lisp's @ref{Format} from consideration; even when variables @code{*print-level*} and @code{*print-level*} are set, huge strings and bit-vectors are @emph{not} limited. @end quotation @@ -10185,7 +10274,7 @@ To untrace, type @end defun -@node System Interface, Time Zone, Trace, Session Support +@node System Interface, , Trace, Session Support @subsection System Interface @noindent @@ -10205,159 +10294,14 @@ integer status code. @end defun @noindent -If @code{(provided? 'current-time)}: - -@noindent -The procedures @code{current-time}, @code{difftime}, and -@code{offset-time} deal with a @dfn{calendar time} datatype -@cindex time -@cindex calendar time -which may or may not be disjoint from other Scheme datatypes. - -@defun current-time -Returns the time since 00:00:00 GMT, January 1, 1970, measured in -seconds. Note that the reference time is different from the reference -time for @code{get-universal-time} in @ref{Common-Lisp Time}. -@end defun - -@defun difftime caltime1 caltime0 -Returns the difference (number of seconds) between twe calendar times: -@var{caltime1} - @var{caltime0}. @var{caltime0} may also be a number. -@end defun - -@defun offset-time caltime offset -Returns the calendar time of @var{caltime} offset by @var{offset} number -of seconds @code{(+ caltime offset)}. -@end defun - -@node Time Zone, , System Interface, Session Support -@subsection Time Zone - -(require 'time-zone) - -@deftp {Data Format} TZ-string - -POSIX standards specify several formats for encoding time-zone rules. - -@table @t -@item :@i{<pathname>} -If the first character of @i{<pathname>} is @samp{/}, then -@i{<pathname>} specifies the absolute pathname of a tzfile(5) format -time-zone file. Otherwise, @i{<pathname>} is interpreted as a pathname -within @var{tzfile:vicinity} (/usr/lib/zoneinfo/) naming a tzfile(5) -format time-zone file. -@item @i{<std>}@i{<offset>} -The string @i{<std>} consists of 3 or more alphabetic characters. -@i{<offset>} specifies the time difference from GMT. The @i{<offset>} -is positive if the local time zone is west of the Prime Meridian and -negative if it is east. @i{<offset>} can be the number of hours or -hours and minutes (and optionally seconds) separated by @samp{:}. For -example, @code{-4:30}. -@item @i{<std>}@i{<offset>}@i{<dst>} -@i{<dst>} is the at least 3 alphabetic characters naming the local -daylight-savings-time. -@item @i{<std>}@i{<offset>}@i{<dst>}@i{<doffset>} -@i{<doffset>} specifies the offset from the Prime Meridian when -daylight-savings-time is in effect. -@end table - -The non-tzfile formats can optionally be followed by transition times -specifying the day and time when a zone changes from standard to -daylight-savings and back again. - -@table @t -@item ,@i{<date>}/@i{<time>},@i{<date>}/@i{<time>} -The @i{<time>}s are specified like the @i{<offset>}s above, except that -leading @samp{+} and @samp{-} are not allowed. - -Each @i{<date>} has one of the formats: - -@table @t -@item J@i{<day>} -specifies the Julian day with @i{<day>} between 1 and 365. February 29 -is never counted and cannot be referenced. -@item @i{<day>} -This specifies the Julian day with n between 0 and 365. February 29 is -counted in leap years and can be specified. -@item M@i{<month>}.@i{<week>}.@i{<day>} -This specifies day @i{<day>} (0 <= @i{<day>} <= 6) of week @i{<week>} (1 -<= @i{<week>} <= 5) of month @i{<month>} (1 <= @i{<month>} <= 12). Week -1 is the first week in which day d occurs and week 5 is the last week in -which day @i{<day>} occurs. Day 0 is a Sunday. -@end table -@end table - -@end deftp - -@deftp {Data Type} time-zone -is a datatype encoding how many hours from Greenwich Mean Time the local -time is, and the @dfn{Daylight Savings Time} rules for changing it. -@end deftp - -@defun time-zone TZ-string -Creates and returns a time-zone object specified by the string -@var{TZ-string}. If @code{time-zone} cannot interpret @var{TZ-string}, -@code{#f} is returned. -@end defun - -@defun tz:params caltime tz -@var{tz} is a time-zone object. @code{tz:params} returns a list of -three items: -@enumerate 0 -@item -An integer. 0 if standard time is in effect for timezone @var{tz} at -@var{caltime}; 1 if daylight savings time is in effect for timezone -@var{tz} at @var{caltime}. -@item -The number of seconds west of the Prime Meridian timezone @var{tz} is at -@var{caltime}. -@item -The name for timezone @var{tz} at @var{caltime}. -@end enumerate - -@code{tz:params} is unaffected by the default timezone; inquiries can be -made of any timezone at any calendar time. - -@end defun - -@noindent -The rest of these procedures and variables are provided for POSIX -compatability. Because of shared state they are not thread-safe. - -@defun tzset -Returns the default time-zone. - -@defunx tzset tz -Sets (and returns) the default time-zone to @var{tz}. - -@defunx tzset TZ-string -Sets (and returns) the default time-zone to that specified by -@var{TZ-string}. +If @code{system} is provided by the Scheme implementation, the +@dfn{net-clients} package provides interfaces to common network client +programs like FTP, mail, and Netscape. -@code{tzset} also sets the variables @var{*timezone*}, @var{daylight?}, -and @var{tzname}. This function is automatically called by the time -conversion procedures which depend on the time zone (@pxref{Time and -Date}). -@end defun +@code{(require 'net-clients)} +@ftindex net-clients -@defvar *timezone* -Contains the difference, in seconds, between Greenwich Mean Time and -local standard time (for example, in the U.S. Eastern time zone (EST), -timezone is 5*60*60). @code{*timezone*} is initialized by @code{tzset}. -@end defvar - -@defvar daylight? -is @code{#t} if the default timezone has rules for @dfn{Daylight Savings -Time}. @emph{Note:} @var{daylight?} does not tell you when Daylight -Savings Time is in effect, just that the default zone sometimes has -Daylight Savings Time. -@end defvar - -@defvar tzname -is a vector of strings. Index 0 has the abbreviation for the standard -timezone; If @var{daylight?}, then index 1 has the abbreviation for the -Daylight Savings timezone. -@end defvar +@c @include nclients.txi @node Extra-SLIB Packages, , Session Support, Other Packages @@ -10388,8 +10332,8 @@ sites are: @table @asis @item SLIB-PSD is a portable debugger for Scheme (requires emacs editor). @lisp -swissnet.ai.mit.edu:pub/scm/slib-psd1-3.tar.gz -prep.ai.mit.edu:pub/gnu/jacal/slib-psd1-3.tar.gz +http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz +ftp.gnu.org:pub/gnu/jacal/slib-psd1-3.tar.gz ftp.maths.tcd.ie:pub/bosullvn/jacal/slib-psd1-3.tar.gz ftp.cs.indiana.edu:/pub/scheme-repository/utl/slib-psd1-3.tar.gz @end lisp @@ -10412,6 +10356,19 @@ Kellom\"aki, pk@@cs.tut.fi. The Lisp Pointers article describing PSD @node About SLIB, Index, Other Packages, Top @chapter About SLIB +@ifinfo +@noindent +More people than I can name have contributed to SLIB. Thanks to all of +you! + +@quotation +SLIB @value{SLIBVERSION}, released @value{SLIBDATE}.@* +Aubrey Jaffer <jaffer @@ ai.mit.edu>@* +@i{Hyperactive Software} -- The Maniac Inside!@* +@url{http://swissnet.ai.mit.edu/~jaffer/SLIB.html} +@end quotation +@end ifinfo + @menu * Installation:: How to install SLIB on your system. * Porting:: SLIB to new platforms. @@ -10419,14 +10376,18 @@ Kellom\"aki, pk@@cs.tut.fi. The Lisp Pointers article describing PSD * Copyrights:: Intellectual propery issues. @end menu -@noindent -More people than I can name have contributed to SLIB. Thanks to all of -you. - @node Installation, Porting, About SLIB, About SLIB @section Installation + +@ifset html +<A NAME="Installation"> +@end ifset +@ifset html +</A> +@end ifset + Check the manifest in @file{README} to find a configuration file for your Scheme implementation. Initialization files for most IEEE P1178 compliant Scheme Implementations are included with this distribution. @@ -10490,11 +10451,11 @@ Your customized version should then be loaded as part of your scheme implementation's initialization. It will load @file{require.scm} from the library; this will allow the use of @code{provide}, @code{provided?}, and @code{require} along with the @dfn{vicinity} -functions (these functions are documented in the section -@xref{Require}). The rest of the library will then be accessible in a -system independent fashion.@refill +functions (these functions are documented in the section @ref{Require}). +The rest of the library will then be accessible in a system independent +fashion.@refill -Please mail new working configuration files to @code{jaffer@@ai.mit.edu} +Please mail new working configuration files to @code{jaffer @@ ai.mit.edu} so that they can be included in the SLIB distribution.@refill @@ -10505,7 +10466,7 @@ All library packages are written in IEEE P1178 Scheme and assume that a configuration file and @file{require.scm} package have already been loaded. Other versions of Scheme can be supported in library packages as well by using, for example, @code{(provided? 'rev3-report)} or -@code{(require 'rev3-report)} (@xref{Require}).@refill +@code{(require 'rev3-report)} (@pxref{Require}).@refill @ftindex rev3-report The module name and @samp{:} should prefix each symbol defined in the @@ -10547,6 +10508,13 @@ not have the time to fish through 10000 diffs to find your 10 real fixes. @node Copyrights, , Coding Standards, About SLIB @section Copyrights +@ifset html +<A NAME="Copyrights"> +@end ifset +@ifset html +</A> +@end ifset + This section has instructions for SLIB authors regarding copyrights. Each package in SLIB must either be in the public domain, or come with a @@ -10561,7 +10529,7 @@ need to add your copyright or send a disclaimer. In order to put code in the public domain you should sign a copyright disclaimer and send it to the SLIB maintainer. Contact -jaffer@@ai.mit.edu for the address to mail the disclaimer to. +jaffer @@ ai.mit.edu for the address to mail the disclaimer to. @quotation I, @var{name}, hereby affirm that I have placed the software package @@ -10586,7 +10554,7 @@ revisions of that module. Make sure no employer has any claim to the copyright on the work you are submitting. If there is any doubt, create a copyright disclaimer and have your employer sign it. Mail the signed disclaimer to the SLIB -maintainer. Contact jaffer@@ai.mit.edu for the address to mail the +maintainer. Contact jaffer @@ ai.mit.edu for the address to mail the disclaimer to. An example disclaimer follows. @subheading Explicit copying terms @@ -10606,7 +10574,7 @@ from those already in the file. Make sure no employer has any claim to the copyright on the work you are submitting. If there is any doubt, create a copyright disclaimer and have your employer sign it. Mail the signed disclaim to the SLIB -maintainer. Contact jaffer@@ai.mit.edu for the address to mail the +maintainer. Contact jaffer @@ ai.mit.edu for the address to mail the disclaimer to. @end itemize @@ -23,7 +23,7 @@ (do ((i 1 (+ i 1))) ((or (= i n) (less? (vector-ref seq i) - (vector-ref seq (- i 1)))) + (vector-ref seq (- i 1)))) (= i n)) )) )) (else (let loop ((last (car seq)) (next (cdr seq))) diff --git a/strcase.scm b/strcase.scm index f2c8331..b46b223 100644 --- a/strcase.scm +++ b/strcase.scm @@ -18,7 +18,7 @@ (define (string-upcase str) (string-upcase! (string-copy str))) - + (define (string-downcase! str) (do ((i (- (string-length str) 1) (- i 1))) ((< i 0) str) diff --git a/strsrch.scm b/strsrch.scm index 68bcf0e..a6ab7e1 100644 --- a/strsrch.scm +++ b/strsrch.scm @@ -5,7 +5,7 @@ ; This code is in the public domain. ;;; Return the index of the first occurence of a-char in str, or #f -(define (string-index str a-char) +(define (strsrch:string-index str a-char) (let loop ((pos 0)) (cond ;; whole string has been searched, in vain @@ -40,7 +40,7 @@ (c2 (if (<= pat-len 1) #f (string-ref pattern 1)))) (cond ((not c1) 0) ; empty pattern, matches upfront - ((not c2) (string-index str c1)) ; one-char pattern + ((not c2) (strsrch:string-index str c1)) ; one-char pattern (else ; matching pattern of > two chars (let outer ((pos 0)) (cond @@ -66,16 +66,19 @@ (set! max-no-char (if (null? max-no-char) #f (car max-no-char))) (letrec ((no-chars-read 0) + (peeked? #f) (my-peek-char ; Return a peeked char or #f (lambda () (and (or (not (number? max-no-char)) (< no-chars-read max-no-char)) (let ((c (peek-char <input-port>))) - (and (not (eof-object? c)) - (if (procedure? max-no-char) - (not (max-no-char c)) - (not (eqv? max-no-char c))) - c))))) - (next-char (lambda () (read-char <input-port>) + (cond (peeked? c) + ((eof-object? c) #f) + ((procedure? max-no-char) + (set! peeked? #t) + (if (max-no-char c) #f c)) + ((eqv? max-no-char c) #f) + (else c)))))) + (next-char (lambda () (set! peeked? #f) (read-char <input-port>) (set! no-chars-read (+ 1 no-chars-read)))) (match-1st-char ; of the string str (lambda () @@ -100,17 +100,17 @@ (map (lambda (field) (string->symbol - (string-append + (string-append "set-" name "-" (symbol->string field) "!"))) (cadr x)))) (k (car x) make-name name? field-accessors field-setters)))) (else (slib:error "define-record: invalid syntax" x))))) - + (define check-variant-case-syntax (let ((make-clause (lambda (clause) - (if (eq? (car clause) 'else) + (if (eq? (car clause) 'else) clause (let ((name (symbol->string (car clause)))) (let ((name? (string->symbol (string-append name "?"))) @@ -1,23 +1,7 @@ -;"t3.init" Initialization file for SLIB for T3.1. -*-scheme-*- -;Copyright (C) 1991, 1992 David Carlton & Stephen Bevan -;Copyright 1993 F. Javier Thayer. -;Copyright (C) 1991, 1992, 1993, 1994, 1997 Aubrey Jaffer. -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; "t3.init" Initialization file for SLIB for T3.1. -*-scheme-*- +;;; Authors: David Carlton, Stephen Bevan, F. Javier Thayer, and Aubrey Jaffer. +;;; +;;; This code is in the public domain. ;;; File has T syntax, and should be compiled in standard-env. ;;; Compiled file has .so suffix. @@ -32,6 +16,13 @@ (define (scheme-implementation-version) "3.1") +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "ftp://ftp.cs.indiana.edu:21/pub/scheme-repository/imp/t/README") + ;;; (implementation-vicinity) should be defined to be the pathname of ;;; the directory where any auxillary files to your Scheme ;;; implementation reside. It is settable. diff --git a/timezone.scm b/timezone.scm index 2890c39..a9149e3 100644 --- a/timezone.scm +++ b/timezone.scm @@ -19,14 +19,14 @@ ;; The C-library support for time in general and time-zones in particular ;; stands as a fine example of how *not* to create interfaces. -;; +;; ;; Functions are not consistently named. Support for GMT is offered in one ;; direction only; The localtime function returns some timezone data in the ;; structure which it returns, and some data in shared global variables. ;; The structure which localtime returns is overwritten with each ;; invocation. There is no way to find local time in zones other than GMT ;; and the local timezone. -;; +;; ;; The tzfile(5) format encodes only a single timezone per file. There is ;; no dispatch on zone names, so multiple copies of a timezone file exist ;; under different names. The TZ `:' specification is unix filesystem @@ -35,14 +35,14 @@ ;; ASCII bytes, it is incompatible with different character sizes. The ;; binary format makes it impossible to easily inspect a file for ;; corruption. -;; +;; ;; I have corrected most of the failings of the C-library time interface in ;; SLIB while maintaining compatablility. I wrote support for Linux ;; timezone files because on a system where TZ is not set, there is no ;; other way to reveal this information. HP-UX appears to have a more ;; sensible arrangement; I invite you to add support for it and other ;; platforms. -;; +;; ;; Writing this was a long, tedious, and unenlightening process. I hope it ;; is useful. ;; @@ -60,7 +60,10 @@ ;;; This definition is here so that READ-TZFILE can verify the ;;; existence of these files before loading tzfile.scm to actually ;;; read them. -(define tzfile:vicinity (make-vicinity "/usr/lib/zoneinfo/")) +(define tzfile:vicinity (make-vicinity + (if (file-exists? "/usr/share/zoneinfo/.") + "/usr/share/zoneinfo/" + "/usr/lib/zoneinfo/"))) (define (read-tzfile path) (let ((realpath @@ -133,6 +133,6 @@ (vector-ref mode-table 0) (if (negative? trans-idx) (tzfile:get-std-spec mode-table) - (vector-ref mode-table + (vector-ref mode-table (vector-ref transition-types trans-idx)))))) (cdr (vector->list zone)))) diff --git a/umbscheme.init b/umbscheme.init new file mode 100644 index 0000000..4532735 --- /dev/null +++ b/umbscheme.init @@ -0,0 +1,263 @@ +;;; "umbscheme.init" Initialization for SLIB for umb-scheme -*-scheme-*- +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. + +; MODIFIED BY Bill Campbell for UMB Scheme. + +; Further modified by Radey Shouman, for inclusion in SLIB. + +;;; (software-type) should be set to the generic operating system type. +;;; UNIX, VMS, MACOS, AMIGA and MS-DOS are supported. + +(define (software-type) 'UNIX) + +;;; (scheme-implementation-type) should return the name of the scheme +;;; implementation loading this file. + +(define (scheme-implementation-type) 'umb-scheme) + +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "ftp://ftp.cs.umb.edu:/pub/scheme/") + +;;; (scheme-implementation-version) should return a string describing +;;; the version the scheme implementation loading this file. + +(define (scheme-implementation-version) "3.2") + +;;; (implementation-vicinity) should be defined to be the pathname of +;;; the directory where any auxillary files to your Scheme +;;; implementation reside. + +(define (implementation-vicinity) + (case (software-type) + ((UNIX) "/usr/lib/umb-scheme/") + ((VMS) "scheme$src:") + ((MS-DOS) "C:\\scheme\\"))) + +;;; (library-vicinity) should be defined to be the pathname of the +;;; directory where files of Scheme library functions reside. + +(define library-vicinity + (let ((library-path + (or + ;; Use this getenv if your implementation supports it. + ;;(getenv "SCHEME_LIBRARY_PATH") + ;; Use this path if your scheme does not support GETENV + ;; or if SCHEME_LIBRARY_PATH is not set. + (case (software-type) + ((UNIX) "/usr/lib/umb-scheme/slib/") + ((VMS) "lib$scheme:") + ((MS-DOS) "C:\\SLIB\\") + (else ""))))) + (lambda () library-path))) + +;;; (home-vicinity) should return the vicinity of the user's HOME +;;; directory, the directory which typically contains files which +;;; customize a computer environment for a user. + +(define (home-vicinity) "") + +;;; *FEATURES* should be set to a list of symbols describing features +;;; of this implementation. Suggestions for features are: + +(define *features* + '( + source ;can load scheme source files + ;(slib:load-source "filename") +; compiled ;can load compiled files + ;(slib:load-compiled "filename") +; rev4-report ;conforms to +; rev3-report ;conforms to + ieee-p1178 ;conforms to +; sicp ;runs code from Structure and + ;Interpretation of Computer + ;Programs by Abelson and Sussman. + rev4-optional-procedures ;LIST-TAIL, STRING->LIST, + ;LIST->STRING, STRING-COPY, + ;STRING-FILL!, LIST->VECTOR, + ;VECTOR->LIST, and VECTOR-FILL! +; rev2-procedures ;SUBSTRING-MOVE-LEFT!, + ;SUBSTRING-MOVE-RIGHT!, + ;SUBSTRING-FILL!, + ;STRING-NULL?, APPEND!, 1+, + ;-1+, <?, <=?, =?, >?, >=? + multiarg/and- ;/ and - can take more than 2 args. + multiarg-apply ;APPLY can take more than 2 args. + rationalize + delay ;has DELAY and FORCE + with-file ;has WITH-INPUT-FROM-FILE and + ;WITH-OUTPUT-FROM-FILE +; string-port ;has CALL-WITH-INPUT-STRING and + ;CALL-WITH-OUTPUT-STRING + transcript ;TRANSCRIPT-ON and TRANSCRIPT-OFF + char-ready? +; macro ;has R4RS high level macros + defmacro ;has Common Lisp DEFMACRO +; eval ;SLIB:EVAL is single argument eval +; record ;has user defined data structures +; values ;proposed multiple values +; dynamic-wind ;proposed dynamic-wind +; ieee-floating-point ;conforms to + full-continuation ;can return multiple times +; object-hash ;has OBJECT-HASH + +; sort +; queue ;queues +; pretty-print +; object->string +; format +; trace ;has macros: TRACE and UNTRACE +; compiler ;has (COMPILER) +; ed ;(ED) is editor + system ;posix (system <string>) +; getenv ;posix (getenv <string>) +; program-arguments ;returns list of strings (argv) +; Xwindows ;X support +; curses ;screen management package +; termcap ;terminal description package +; terminfo ;sysV terminal description +; current-time ;returns time in seconds since 1/1/1970 + )) + +;;; (OUTPUT-PORT-WIDTH <port>) +(define (output-port-width . arg) 79) + +;;; (OUTPUT-PORT-HEIGHT <port>) +(define (output-port-height . arg) 24) + +;;; (CURRENT-ERROR-PORT) +(define current-error-port + (let ((port (current-output-port))) + (lambda () port))) + +;;; (TMPNAM) makes a temporary file name. +(define tmpnam (let ((cntr 100)) + (lambda () (set! cntr (+ 1 cntr)) + (string-append "slib_" (number->string cntr))))) + +;;; (FILE-EXISTS? <string>) +;;(define (file-exists? f) #f) +(define file-exists? + (case (software-type) + ((UNIX) + (lambda (f) + (zero? (system (string-append "test -r " f))))) + (else + (lambda (f) #f)))) + +;;; (DELETE-FILE <string>) +;;(define (delete-file f) #f) +(define delete-file + (case (software-type) + ((UNIX) + (lambda (f) + (zero? (system (string-append "rm " f))))) + (else + (lambda (f) #f)))) + + +;;; FORCE-OUTPUT flushes any pending output on optional arg output port +;;; use this definition if your system doesn't have such a procedure. +(define (force-output . arg) #t) + +;;; CALL-WITH-INPUT-STRING and CALL-WITH-OUTPUT-STRING are the string +;;; port versions of CALL-WITH-*PUT-FILE. + +;;; CHAR-CODE-LIMIT is one greater than the largest integer which can +;;; be returned by CHAR->INTEGER. +(define char-code-limit 256) + +;;; MOST-POSITIVE-FIXNUM is used in modular.scm +(define most-positive-fixnum #x08000) + +;;; Return argument +(define (identity x) x) + +;;; If your implementation provides eval SLIB:EVAL is single argument +;;; eval using the top-level (user) environment. +(define slib:eval eval) + +(define gentemp + (let ((*gensym-counter* -1)) + (lambda () + (set! *gensym-counter* (+ *gensym-counter* 1)) + (string->symbol + (string-append "slib:G" (number->string *gensym-counter*)))))) + +(define defmacro:eval slib:eval) +(define defmacro:load load) + +(define (defmacro:load <pathname>) + (slib:eval-load <pathname> defmacro:eval)) + +(define (slib:eval-load <pathname> evl) + (if (not (file-exists? <pathname>)) + (set! <pathname> (string-append <pathname> (scheme-file-suffix)))) + (call-with-input-file <pathname> + (lambda (port) + (let ((old-load-pathname *load-pathname*)) + (set! *load-pathname* <pathname>) + (do ((o (read port) (read port))) + ((eof-object? o)) + (evl o)) + (set! *load-pathname* old-load-pathname))))) + +(define slib:warn + (lambda args + (let ((port (current-error-port))) + (display "Warn: " port) + (for-each (lambda (x) (display x port)) args)))) + +;;; define an error procedure for the library +(define slib:error error) + +;;; define these as appropriate for your system. +(define slib:tab (integer->char 9)) +(define slib:form-feed (integer->char 12)) + +;;; Support for older versions of Scheme. Not enough code for its own file. +(define (last-pair l) (if (pair? (cdr l)) (last-pair (cdr l)) l)) +(define t #t) +(define nil #f) + +;;; Define these if your implementation's syntax can support it and if +;;; they are not already defined. + +;(define (1+ n) (+ n 1)) +;(define (-1+ n) (+ n -1)) +;(define 1- -1+) + +(define in-vicinity string-append) + +;;; Define SLIB:EXIT to be the implementation procedure to exit or +;;; return if exitting not supported. +(define slib:exit (lambda args #f)) + +;;; Here for backward compatability +(define scheme-file-suffix + (let ((suffix (case (software-type) + ((NOSVE) "_scm") + (else ".scm")))) + (lambda () suffix))) + +;;; (SLIB:LOAD-SOURCE "foo") should load "foo.scm" or with whatever +;;; suffix all the module files in SLIB have. See feature 'SOURCE. + +(define (slib:load-source f) (load (string-append f ".scm"))) + +;;; (SLIB:LOAD-COMPILED "foo") should load the file that was produced +;;; by compiling "foo.scm" if this implementation can compile files. +;;; See feature 'COMPILED. + +(define slib:load-compiled load) + +;;; At this point SLIB:LOAD must be able to load SLIB files. + +(define slib:load slib:load-source) + +(slib:load (in-vicinity (library-vicinity) "require")) diff --git a/version.txi b/version.txi new file mode 100644 index 0000000..7766bb1 --- /dev/null +++ b/version.txi @@ -0,0 +1,2 @@ +@set SLIBVERSION 2c5 +@set SLIBDATE January 1999 @@ -1,21 +1,7 @@ -;;;"vscm.init" Configuration of *features* for VSCM -*-scheme-*- -;Copyright (C) 1994, 1996, 1997 Aubrey Jaffer -; -;Permission to copy this software, to redistribute it, and to use it -;for any purpose is granted, subject to the following restrictions and -;understandings. -; -;1. Any copy made of this software must include this copyright notice -;in full. -; -;2. I have made no warrantee or representation that the operation of -;this software will be error-free, and I am under no obligation to -;provide any services, by way of maintenance, update, or otherwise. -; -;3. In conjunction with products arising from the use of this -;material, there shall be no use of my name in any advertising, -;promotional, or sales literature without prior written consent in -;each case. +;;; "vscm.init" Configuration of *features* for VSCM -*-scheme-*- +;;; Author: Aubrey Jaffer +;;; +;;; This code is in the public domain. ;;; From: Matthias Blume <blume@cs.Princeton.EDU> ;;; Date: Tue, 1 Mar 1994 11:42:31 -0500 @@ -58,6 +44,13 @@ (define (scheme-implementation-type) 'Vscm) +;;; (scheme-implementation-home-page) should return a (string) URL +;;; (Uniform Resource Locator) for this scheme implementation's home +;;; page; or false if there isn't one. + +(define (scheme-implementation-home-page) + "http://www.cs.princeton.edu/~blume/vscm/vscm.html") + ;;; (scheme-implementation-version) should return a string describing the ;;; version the scheme implementation loading this file. @@ -1,7 +1,7 @@ ;; "wttree.scm" Weight balanced trees -*-Scheme-*- ;; Copyright (c) 1993-1994 Stephen Adams ;; -;; $Id: wttree.scm,v 1.2 1998/02/09 23:13:10 jaffer Exp $ +;; $Id: wttree.scm,v 1.3 1999/10/11 03:36:29 jaffer Exp $ ;; ;; References: ;; @@ -44,7 +44,7 @@ ;; ;; Weight Balanced Binary Trees ;; -;; +;; ;; ;; This file has been modified from the MIT-Scheme library version to ;; make it more standard. The main changes are @@ -169,18 +169,18 @@ (define tag:tree-type (string->symbol "#[(runtime wttree)tree-type]")) - (define (%make-tree-type key<? alist->tree - add insert! - delete delete! - member? lookup - split-lt split-gt - union intersection - difference subset? + (define (%make-tree-type key<? alist->tree + add insert! + delete delete! + member? lookup + split-lt split-gt + union intersection + difference subset? rank ) (vector tag:tree-type - key<? alist->tree add insert! - delete delete! member? lookup - split-lt split-gt union intersection + key<? alist->tree add insert! + delete delete! member? lookup + split-lt split-gt union intersection difference subset? rank )) (define (tree-type? tt) @@ -401,11 +401,11 @@ (define (node/rank k node rank) (cond ((empty? node) #f) ((key<? k (node/k node)) (node/rank k (node/l node) rank)) - ((key>? k (node/k node)) + ((key>? k (node/k node)) (node/rank k (node/r node) (fix:+ 1 (fix:+ rank (node/size (node/l node)))))) (else (fix:+ rank (node/size (node/l node)))))) - + (define (node/add node k v) (if (empty? node) (node/singleton k v) @@ -463,7 +463,7 @@ ((key<? (node/k node) x) (node/split-gt (node/r node) x)) ((key<? x (node/k node)) - (node/concat3 (node/k node) (node/v node) + (node/concat3 (node/k node) (node/v node) (node/split-gt (node/l node) x) (node/r node))) (else (node/r node)))) @@ -566,7 +566,7 @@ (cond ((null? alist) node) ((pair? alist) (loop (cdr alist) (node/add node (caar alist) (cdar alist)))) - (else + (else (error:wrong-type-argument alist "alist" 'alist->tree)))) (%make-wt-tree my-type (loop alist empty))) diff --git a/yasos.scm b/yasos.scm deleted file mode 100644 index cceea92..0000000 --- a/yasos.scm +++ /dev/null @@ -1,299 +0,0 @@ -; "YASOS.scm" Yet Another Scheme Object System -; COPYRIGHT (c) Kenneth Dickey 1992 -; -; This software may be used for any purpose whatever -; without warrantee of any kind. -; DATE 1992 March 1 -; LAST UPDATED 1992 September 1 -- misc optimizations -; 1992 May 22 -- added SET and SETTER - -;; REQUIRES R^4RS Syntax System - -;; NOTES: A simple object system for Scheme based on the paper by -;; Norman Adams and Jonathan Rees: "Object Oriented Programming in -;; Scheme", Proceedings of the 1988 ACM Conference on LISP and Functional -;; Programming, July 1988 [ACM #552880]. -; -;; Setters use space for speed {extra conses for O(1) lookup}. - - -;; -;; INTERFACE: -;; -;; (DEFINE-OPERATION (opname self arg ...) default-body) -;; -;; (DEFINE-PREDICATE opname) -;; -;; (OBJECT ((name self arg ...) body) ... ) -;; -;; (OBJECT-WITH-ANCESTORS ( (ancestor1 init1) ...) operation ...) -;; -;; in an operation {a.k.a. send-to-super} -;; (OPERATE-AS component operation self arg ...) -;; - -;; (SET var new-vale) or (SET (access-proc index ...) new-value) -;; -;; (SETTER access-proc) -> setter-proc -;; (DEFINE-ACCESS-OPERATION getter-name) -> operation -;; (ADD-SETTER getter setter) ;; setter is a Scheme proc -;; (REMOVE-SETTER-FOR getter) -;; - -;;;;;;;;;;;;;;;;;;;;;;;;;;;; IMPLEMENTATION ;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -;; INSTANCES - -; (define-predicate instance?) -; (define (make-instance dispatcher) -; (object -; ((instance? self) #t) -; ((instance-dispatcher self) dispatcher) -; ) ) - -(define yasos:make-instance 'bogus) ;; defined below -(define yasos:instance? 'bogus) -(define-syntax yasos:instance-dispatcher ;; alias so compiler can inline for speed - (syntax-rules () ((yasos:instance-dispatcher inst) (cdr inst))) -) - -(let ( (instance-tag "instance") ) ;; Make a unique tag within a local scope. - ;; No other data object is EQ? to this tag. - (set! yasos:make-instance - (lambda (dispatcher) (cons instance-tag dispatcher))) - - (set! yasos:instance? - (lambda (obj) (and (pair? obj) (eq? (car obj) instance-tag)))) -) - -;; DEFINE-OPERATION - - -(define-syntax define-operation - (syntax-rules () - ((define-operation (<name> <inst> <arg> ...) <exp1> <exp2> ...) - ;;=> - (define <name> - (letrec ( (former-inst #f) ;; simple caching -- for loops - (former-method #f) - (self - (lambda (<inst> <arg> ...) - (cond - ((eq? <inst> former-inst) ; check cache - (former-method <inst> <arg> ...) - ) - ((and (yasos:instance? <inst>) - ((yasos:instance-dispatcher <inst>) self)) - => (lambda (method) - (set! former-inst <inst>) - (set! former-method method) - (method <inst> <arg> ...)) - ) - (else <exp1> <exp2> ...) - ) ) ) ) - self) - )) - ((define-operation (<name> <inst> <arg> ...) ) ;; no body - ;;=> - (define-operation (<name> <inst> <arg> ...) - (slib:error "Operation not handled" - '<name> - (format #f (if (yasos:instance? <inst>) "#<INSTANCE>" "~s") - <inst>))) - )) -) - - - -;; DEFINE-PREDICATE - -(define-syntax define-predicate - (syntax-rules () - ((define-predicate <name>) - ;;=> - (define-operation (<name> obj) #f) - ) -) ) - - -;; OBJECT - -(define-syntax object - (syntax-rules () - ((object ((<name> <self> <arg> ...) <exp1> <exp2> ...) ...) - ;;=> - (let ( (table - (list (cons <name> - (lambda (<self> <arg> ...) <exp1> <exp2> ...)) - ... - ) ) - ) - (yasos:make-instance - (lambda (op) - (cond - ((assq op table) => cdr) - (else #f) -) ) )))) ) - - -;; OBJECT with MULTIPLE INHERITANCE {First Found Rule} - -(define-syntax object-with-ancestors - (syntax-rules () - ((object-with-ancestors ( (<ancestor1> <init1>) ... ) <operation> ...) - ;;=> - (let ( (<ancestor1> <init1>) ... ) - (let ( (child (object <operation> ...)) ) - (yasos:make-instance - (lambda (op) - (or ((yasos:instance-dispatcher child) op) - ((yasos:instance-dispatcher <ancestor1>) op) ... - ) ) ) - ))) -) ) - - -;; OPERATE-AS {a.k.a. send-to-super} - -; used in operations/methods - -(define-syntax operate-as - (syntax-rules () - ((operate-as <component> <op> <composit> <arg> ...) - ;;=> - (((yasos:instance-dispatcher <component>) <op>) <composit> <arg> ...) - )) -) - - - -;; SET & SETTER - - -(define-syntax set - (syntax-rules () - ((set (<access> <index> ...) <newval>) - ((yasos:setter <access>) <index> ... <newval>) - ) - ((set <var> <newval>) - (set! <var> <newval>) - ) -) ) - - -(define yasos:add-setter 'bogus) -(define yasos:remove-setter-for 'bogus) - -(define yasos:setter - (let ( (known-setters (list (cons car set-car!) - (cons cdr set-cdr!) - (cons vector-ref vector-set!) - (cons string-ref string-set!)) - ) - (added-setters '()) - ) - - (set! yasos:add-setter - (lambda (getter setter) - (set! added-setters (cons (cons getter setter) added-setters))) - ) - (set! yasos:remove-setter-for - (lambda (getter) - (cond - ((null? added-setters) - (slib:error "REMOVE-SETTER-FOR: Unknown getter" getter) - ) - ((eq? getter (caar added-setters)) - (set! added-setters (cdr added-setters)) - ) - (else - (let loop ((x added-setters) (y (cdr added-setters))) - (cond - ((null? y) (slib:error "REMOVE-SETTER-FOR: Unknown getter" - getter)) - ((eq? getter (caar y)) (set-cdr! x (cdr y))) - (else (loop (cdr x) (cdr y))) - ) ) ) - ) ) ) - - (letrec ( (self - (lambda (proc-or-operation) - (cond ((assq proc-or-operation known-setters) => cdr) - ((assq proc-or-operation added-setters) => cdr) - (else (proc-or-operation self))) ) - ) ) - self) -) ) - - - -(define (yasos:make-access-operation <name>) - (letrec ( (setter-dispatch - (lambda (inst . args) - (cond - ((and (yasos:instance? inst) - ((yasos:instance-dispatcher inst) setter-dispatch)) - => (lambda (method) (apply method inst args)) - ) - (else #f))) - ) - (self - (lambda (inst . args) - (cond - ((eq? inst yasos:setter) setter-dispatch) ; for (setter self) - ((and (yasos:instance? inst) - ((yasos:instance-dispatcher inst) self)) - => (lambda (method) (apply method inst args)) - ) - (else (slib:error "Operation not handled" <name> inst)) - ) ) - ) - ) - - self -) ) - -(define-syntax define-access-operation - (syntax-rules () - ((define-access-operation <name>) - ;=> - (define <name> (yasos:make-access-operation '<name>)) -) ) ) - - - -;;--------------------- -;; general operations -;;--------------------- - -(define-operation (yasos:print obj port) - (format port - ;; if an instance does not have a PRINT operation.. - (if (yasos:instance? obj) "#<INSTANCE>" "~s") - obj -) ) - -(define-operation (yasos:size obj) - ;; default behavior - (cond - ((vector? obj) (vector-length obj)) - ((list? obj) (length obj)) - ((pair? obj) 2) - ((string? obj) (string-length obj)) - ((char? obj) 1) - (else - (slib:error "Operation not supported: size" obj)) -) ) - -(require 'format) - -;;; exports: - -(define print yasos:print) ; print also in debug.scm -(define size yasos:size) -(define add-setter yasos:add-setter) -(define remove-setter-for yasos:remove-setter-for) -(define setter yasos:setter) - -(provide 'oop) ;in case we were loaded this way. -;; --- E O F "yasos.scm" --- ;; diff --git a/yasyn.scm b/yasyn.scm new file mode 100644 index 0000000..2b3cec0 --- /dev/null +++ b/yasyn.scm @@ -0,0 +1,201 @@ +;;"yasyn.scm" YASOS in terms of "object.scm" +;;;From: whumeniu@datap.ca (Wade Humeniuk) + +(require 'object) + +(define yasos:instance? object?) +;; Removed (define yasos:make-instance 'bogus) ;; +;; Removed (define-syntax YASOS:INSTANCE-DISPATCHER ;; alias so compiler can inline for speed +;; (syntax-rules () ((yasos:instance-dispatcher inst) (cdr inst)))) +;; DEFINE-OPERATION + +(define-syntax define-operation + (syntax-rules () + ((define-operation (<name> <inst> <arg> ...) <exp1> <exp2> ...) + ;;=> + (define <name> (make-generic-method + (lambda (<inst> <arg> ...) <exp1> <exp2> ...)))) + + ((define-operation (<name> <inst> <arg> ...) ) ;; no body + ;;=> + (define-operation (<name> <inst> <arg> ...) + (slib:error "Operation not handled" + '<name> + (format #f (if (yasos:instance? <inst>) "#<INSTANCE>" "~s") + <inst>)))))) + +;; DEFINE-PREDICATE + +(define-syntax define-predicate + (syntax-rules () + ((define-predicate <name>) + ;;=> + (define <name> (make-generic-predicate))))) + +;; OBJECT + +(define-syntax object + (syntax-rules () + ((object ((<name> <self> <arg> ...) <exp1> <exp2> ...) ...) + ;;=> + (let ((self (make-object))) + (make-method! self <name> (lambda (<self> <arg> ...) <exp1> <exp2> ...)) + ... + self)))) + +;; OBJECT with MULTIPLE INHERITANCE {First Found Rule} + +(define-syntax object-with-ancestors + (syntax-rules () + ((object-with-ancestors ( (<ancestor1> <init1>) ... ) + ((<name> <self> <arg> ...) <exp1> <exp2> ...) ...) + ;;=> + (let* ((<ancestor1> <init1>) + ... + (self (make-object <ancestor1> ...))) + (make-method! self <name> (lambda (<self> <arg> ...) <exp1> <exp2> ...)) + ... + self)))) + +;; OPERATE-AS {a.k.a. send-to-super} + +; used in operations/methods + +(define-syntax operate-as + (syntax-rules () + ((operate-as <component> <op> <composit> <arg> ...) ;; What is <composit> ??? + ;;=> + ((get-method <component> <op>) <composit> <arg> ...)))) + + + +;; SET & SETTER + + +(define-syntax set + (syntax-rules () + ((set (<access> <index> ...) <newval>) + ((yasos:setter <access>) <index> ... <newval>) + ) + ((set <var> <newval>) + (set! <var> <newval>) + ) +) ) + + +(define yasos:add-setter 'bogus) +(define yasos:remove-setter-for 'bogus) + +(define yasos:setter + (let ( (known-setters (list (cons car set-car!) + (cons cdr set-cdr!) + (cons vector-ref vector-set!) + (cons string-ref string-set!)) + ) + (added-setters '()) + ) + + (set! yasos:add-setter + (lambda (getter setter) + (set! added-setters (cons (cons getter setter) added-setters))) + ) + (set! yasos:remove-setter-for + (lambda (getter) + (cond + ((null? added-setters) + (slib:error "REMOVE-SETTER-FOR: Unknown getter" getter) + ) + ((eq? getter (caar added-setters)) + (set! added-setters (cdr added-setters)) + ) + (else + (let loop ((x added-setters) (y (cdr added-setters))) + (cond + ((null? y) (slib:error "REMOVE-SETTER-FOR: Unknown getter" + getter)) + ((eq? getter (caar y)) (set-cdr! x (cdr y))) + (else (loop (cdr x) (cdr y))) + ) ) ) + ) ) ) + + (letrec ( (self + (lambda (proc-or-operation) + (cond ((assq proc-or-operation known-setters) => cdr) + ((assq proc-or-operation added-setters) => cdr) + (else (proc-or-operation self))) ) + ) ) + self) +) ) + + + +(define (yasos:make-access-operation <name>) + (letrec ( (setter-dispatch + (lambda (inst . args) + (cond + ((and (yasos:instance? inst) + (get-method inst setter-dispatch)) + => (lambda (method) (apply method (cons inst args))) + ) + (else #f))) + ) + (self + (lambda (inst . args) + (cond + ((eq? inst yasos:setter) setter-dispatch) ; for (setter self) + ((and (yasos:instance? inst) + (get-method inst self)) + => (lambda (method) (apply method (cons inst args))) + ) + (else (slib:error "Operation not handled" <name> inst)) + ) ) + ) + ) + + self +) ) + +(define-syntax define-access-operation + (syntax-rules () + ((define-access-operation <name>) + ;=> + (define <name> (yasos:make-access-operation '<name>)) +) ) ) + + + +;;--------------------- +;; general operations +;;--------------------- + +(define-operation (yasos:print obj port) + (format port + ;; if an instance does not have a PRINT operation.. + (if (yasos:instance? obj) "#<INSTANCE>" "~s") + obj +) ) + +(define-operation (yasos:size obj) + ;; default behavior + (cond + ((vector? obj) (vector-length obj)) + ((list? obj) (length obj)) + ((pair? obj) 2) + ((string? obj) (string-length obj)) + ((char? obj) 1) + (else + (slib:error "Operation not supported: size" obj)) +) ) + +(require 'format) + +;;; exports: + +(define print yasos:print) ; print also in debug.scm +(define size yasos:size) +(define add-setter yasos:add-setter) +(define remove-setter-for yasos:remove-setter-for) +(define setter yasos:setter) + +(provide 'oop) ;in case we were loaded this way. +(provide 'yasos) |