diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2017-02-20 00:05:26 -0800 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2017-02-20 00:05:26 -0800 |
| commit | deda2c0fd8689349fea2a900199a76ff7ecb319e (patch) | |
| tree | c9726d54a0806a9b0c75e6c82db8692aea0053cf /scm.info | |
| parent | 3278b75942bdbe706f7a0fba87729bb1e935b68b (diff) | |
| download | scm-deda2c0fd8689349fea2a900199a76ff7ecb319e.tar.gz scm-deda2c0fd8689349fea2a900199a76ff7ecb319e.zip | |
Import Upstream version 5d6upstream/5d6
Diffstat (limited to 'scm.info')
| -rw-r--r-- | scm.info | 2938 |
1 files changed, 1611 insertions, 1327 deletions
@@ -1,5 +1,4 @@ -This is Info file scm.info, produced by Makeinfo version 1.68 from the -input file scm.texi. +This is scm.info, produced by makeinfo version 4.0 from scm.texi. INFO-DIR-SECTION The Algorithmic Language Scheme START-INFO-DIR-ENTRY @@ -9,11 +8,11 @@ END-INFO-DIR-ENTRY File: scm.info, Node: Top, Next: Overview, Prev: (dir), Up: (dir) -This manual documents the SCM Scheme implementation. SCM version | -5d2 was released December 1999. The most recent information about SCM | -can be found on SCM's "WWW" home page: | +This manual documents the SCM Scheme implementation. SCM version +5d6 was released April 2002. The most recent information about SCM can | +be found on SCM's "WWW" home page: | - `http://swissnet.ai.mit.edu/~jaffer/SCM.html' + <http://swissnet.ai.mit.edu/~jaffer/SCM.html> Copyright (C) 1990-1999 Free Software Foundation @@ -52,82 +51,13 @@ machine independent platform for [JACAL], a symbolic algebra system. * Menu: -* Copying:: * SCM Features:: * SCM Authors:: +* Copying:: * Bibliography:: -File: scm.info, Node: Copying, Next: SCM Features, Prev: Overview, Up: Overview - -Copying -======= - - COPYRIGHT (c) 1989 BY - - PARADIGM ASSOCIATES INCORPORATED, CAMBRIDGE, MASSACHUSETTS. - - ALL RIGHTS RESERVED - -Permission to use, copy, modify, distribute and sell this software and -its documentation for any purpose and without fee is hereby granted, -provided that the above copyright notice appear in all copies and that -both that copyright notice and this permission notice appear in -supporting documentation, and that the name of Paradigm Associates Inc -not be used in advertising or publicity pertaining to distribution of -the software without specific, written prior permission. - -PARADIGM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, -INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO -EVENT SHALL PARADIGM BE LIABLE FOR ANY SPECIAL, INDIRECT OR -CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF -USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR -OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -PERFORMANCE OF THIS SOFTWARE. - -gjc@paradigm.com - Phone: 617-492-6079 - -Paradigm Associates Inc -29 Putnam Ave, Suite 6 -Cambridge, MA 02138 - - Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 - - Free Software Foundation, Inc. - - 59 Temple Place, Suite 330, Boston, MA 02111, USA - -Permission to use, copy, modify, distribute, and sell this software and -its documentation for any purpose is hereby granted without fee, -provided that the above copyright notice appear in all copies and that -both that copyright notice and this permission notice appear in -supporting documentation. - - NO WARRANTY - -BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR -THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER -EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE -ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH -YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL -NECESSARY SERVICING, REPAIR OR CORRECTION. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR -DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL -DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM -(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED -INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF -THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR -OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - - -File: scm.info, Node: SCM Features, Next: SCM Authors, Prev: Copying, Up: Overview +File: scm.info, Node: SCM Features, Next: SCM Authors, Prev: Overview, Up: Overview Features ======== @@ -177,16 +107,16 @@ Features function). `Restart', `quit', and `exec'. -File: scm.info, Node: SCM Authors, Next: Bibliography, Prev: SCM Features, Up: Overview +File: scm.info, Node: SCM Authors, Next: Copying, Prev: SCM Features, Up: Overview Authors ======= -Aubrey Jaffer (jaffer @ ai.mit.edu) +Aubrey Jaffer (jaffer @ alum.mit.edu) | Most of SCM. Radey Shouman - Arrays. `gsubr's, compiled closures, records, Ecache, syntax-rules + Arrays, `gsubr's, compiled closures, records, Ecache, syntax-rules macros, and "safeport"s. Jerry D. Hedden @@ -200,13 +130,87 @@ George Carrette "Siod", written by George Carrette, was the starting point for SCM. The major innovations taken from Siod are the evaluator's use of the C-stack and being able to garbage collect off the C-stack - (*note Garbage Collection::.). + (*note Garbage Collection::). There are many other contributors to SCM. They are acknowledged in the file `ChangeLog', a log of changes that have been made to scm. -File: scm.info, Node: Bibliography, Prev: SCM Authors, Up: Overview +File: scm.info, Node: Copying, Next: Bibliography, Prev: SCM Authors, Up: Overview + +Copyright +========= + +Authors have assigned their SCM copyrights to: + + + Free Software Foundation, Inc. + + 59 Temple Place, Suite 330, Boston, MA 02111, USA + +Permission to use, copy, modify, distribute, and sell this software and +its documentation for any purpose is hereby granted without fee, +provided that the above copyright notice appear in all copies and that +both that copyright notice and this permission notice appear in +supporting documentation. + + NO WARRANTY + +BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE +ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH +YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL +NECESSARY SERVICING, REPAIR OR CORRECTION. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR +DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL +DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM +(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF +THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR +OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +SIOD copyright +============== + + + COPYRIGHT (c) 1989 BY + + PARADIGM ASSOCIATES INCORPORATED, CAMBRIDGE, MASSACHUSETTS. + + ALL RIGHTS RESERVED + +Permission to use, copy, modify, distribute and sell this software and +its documentation for any purpose and without fee is hereby granted, +provided that the above copyright notice appear in all copies and that +both that copyright notice and this permission notice appear in +supporting documentation, and that the name of Paradigm Associates Inc +not be used in advertising or publicity pertaining to distribution of +the software without specific, written prior permission. + +PARADIGM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO +EVENT SHALL PARADIGM BE LIABLE FOR ANY SPECIAL, INDIRECT OR +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. + +gjc@paradigm.com + Phone: 617-492-6079 + +Paradigm Associates Inc +29 Putnam Ave, Suite 6 +Cambridge, MA 02138 + + +File: scm.info, Node: Bibliography, Prev: Copying, Up: Overview Bibliography ============ @@ -215,15 +219,6 @@ Bibliography `IEEE Standard 1178-1990. IEEE Standard for the Scheme Programming Language.' IEEE, New York, 1991. -[Simply] - Brian Harvey and Matthew Wright. `Simply Scheme: Introducing - Computer Science' MIT Press, 1994 ISBN 0-262-08226-8 - -[SICP] - Harold Abelson and Gerald Jay Sussman with Julie Sussman. - `Structure and Interpretation of Computer Programs.' MIT Press, - Cambridge, 1985. - [R4RS] William Clinger and Jonathan Rees, Editors. Revised(4) Report on the Algorithmic Language Scheme. `ACM Lisp Pointers' Volume IV, @@ -243,19 +238,28 @@ Bibliography William Clinger Hygienic Macros Through Explicit Renaming `Lisp Pointers' Volume IV, Number 4 (December 1991), pp 17-23. -[GUILE] - Tom Lord. The Guile Architecture for Ubiquitous Computing. - `Usenix Symposium on Tcl/Tk', 1995. +[SICP] + Harold Abelson and Gerald Jay Sussman with Julie Sussman. + `Structure and Interpretation of Computer Programs.' MIT Press, + Cambridge, 1985. + +[Simply] + Brian Harvey and Matthew Wright. `Simply Scheme: Introducing + Computer Science' MIT Press, 1994 ISBN 0-262-08226-8 + +[SchemePrimer] + 犬飼大(Dai Inukai) `入門Scheme' + 1999年12月初版 ISBN4-87966-954-7 [SLIB] Todd R. Eigenschink, Dave Love, and Aubrey Jaffer. SLIB, The - Portable Scheme Library. Version 2c5, Jan 1999. + Portable Scheme Library. Version 2c8, June 2000. *Note Top: (slib)Top. [JACAL] - Aubrey Jaffer. JACAL Symbolic Mathematics System. Version 1a9, - Jan 1999. + Aubrey Jaffer. JACAL Symbolic Mathematics System. Version 1b0, + Sep 1999. *Note Top: (jacal)Top. @@ -297,36 +301,25 @@ Making SCM ========== The SCM distribution has "Makefile" which contains rules for making -"scmlit", a "bare-bones" version of SCM sufficient for running -`build.scm'. `build.scm' is used to compile (or create scripts to -compile) full featured versions. +"scmlit", a "bare-bones" version of SCM sufficient for running `build'. +`build' is used to compile (or create scripts to compile) full +featured versions. Makefiles are not portable to the majority of platforms. If `Makefile' works for you, good; If not, I don't want to hear about it. If you -need to compile SCM without build.scm, there are several ways to -proceed: +need to compile SCM without build, there are several ways to proceed: - * Use SCM on a different platform to run `build.scm' to create a - script to build SCM; + * Use the build (http://swissnet.ai.mit.edu/~jaffer/buildscm.html) + web page to create custom batch scripts for compiling SCM. + + * Use SCM on a different platform to run `build' to create a script + to build SCM; - * Use another implementation of Scheme to run `build.scm' to create a + * Use another implementation of Scheme to run `build' to create a script to build SCM; * Create your own script or `Makefile'. - * Buy a SCM executable from jaffer @ ai.mit.edu. See the end of the - `ANNOUNCE' file in the distribution for details. - - * Use scmconfig (From: bos@scrg.cs.tcd.ie): - - Build and install scripts using GNU "autoconf" are available from - `scmconfig4e3.tar.gz' in the distribution directories. See - `README.unix' in `scmconfig4e3.tar.gz' for further instructions. - - *Note:* The last release of scmconfig (4e3) was on March 20, 1996. - I am moving it to the OLD subdirectory until someone submits an - update. - File: scm.info, Node: SLIB, Next: Building SCM, Prev: Making SCM, Up: Installing SCM @@ -335,22 +328,22 @@ SLIB [SLIB] is a portable Scheme library meant to provide compatibility and utility functions for all standard Scheme implementations. Although -SLIB is not *neccessary* to run SCM, I strongly suggest you obtain and +SLIB is not _neccessary_ to run SCM, I strongly suggest you obtain and install it. Bug reports about running SCM without SLIB have very low priority. SLIB is available from the same sites as SCM: - * swissnet.ai.mit.edu:/pub/scm/slib2c7.tar.gz | + * swissnet.ai.mit.edu:/pub/scm/slib2d4.tar.gz | - * ftp.gnu.org:/pub/gnu/jacal/slib2c7.tar.gz | + * ftp.gnu.org:/pub/gnu/jacal/slib2d4.tar.gz | - * ftp.cs.indiana.edu:/pub/scheme-repository/imp/slib2c7.tar.gz | + * ftp.cs.indiana.edu:/pub/scheme-repository/imp/slib2d4.tar.gz | -Unpack SLIB (`tar xzf slib2c7.tar.gz' or `unzip -ao slib2c7.zip') in an | +Unpack SLIB (`tar xzf slib2d4.tar.gz' or `unzip -ao slib2d4.zip') in an | appropriate directory for your system; both `tar' and `unzip' will create the directory `slib'. Then create a file `require.scm' in the SCM "implementation-vicinity" -(this is the same directory as where the file `Init5d2.scm' is | +(this is the same directory as where the file `Init5d6.scm' is | installed). `require.scm' should have the contents: (define (library-vicinity) "/usr/local/lib/slib/") @@ -379,11 +372,12 @@ File: scm.info, Node: Building SCM, Next: Installing Dynamic Linking, Prev: S Building SCM ============ -The file "build.scm" builds and runs a relational database of how to -compile and link SCM executables. It has information for most platforms -which SCM has been ported to (of which I have been notified). Some of -this information is old, incorrect, or incomplete. Send corrections and -additions to jaffer @ ai.mit.edu. +The file "build" loads the file "build.scm", which constructs a +relational database of how to compile and link SCM executables. +`build.scm' has information for the platforms which SCM has been ported +to (of which I have been notified). Some of this information is old, +incorrect, or incomplete. Send corrections and additions to jaffer @ +ai.mit.edu. * Menu: @@ -397,57 +391,56 @@ File: scm.info, Node: Invoking Build, Next: Build Options, Prev: Building SCM Invoking Build -------------- -The *all* method will also work for MS-DOS and unix. Use the *all* -method if you encounter problems with `build.scm'. +The _all_ method will also work for MS-DOS and unix. Use the _all_ +method if you encounter problems with `build'. MS-DOS From the SCM source directory, type `build' followed by up to 9 command line arguments. unix - From the SCM source directory, type `./build.scm' followed by - command line arguments. + From the SCM source directory, type `./build' followed by command + line arguments. -*all* +_all_ From the SCM source directory, start `scm' or `scmlit' and type - `(load "build.scm")'. Alternatively, start `scm' or `scmlit' with - the command line argument `-ilbuild'. + `(load "build")'. Alternatively, start `scm' or `scmlit' with the + command line argument `-ilbuild'. Invoking build without the `-F' option will build or create a shell script with the `arrays', `inexact', and `bignums' options as defaults. - bash$ ./build.scm + bash$ ./build -| - #!/bin/sh + #! /bin/sh + # unix (linux) script created by SLIB/batch | + # ================ Write file with C defines | rm -f scmflags.h - echo '#define IMPLINIT "/home/jaffer/scm/Init5d2.scm"'>>scmflags.h | + echo '#define IMPLINIT "Init5d6.scm"'>>scmflags.h | echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h echo '#define ARRAYS'>>scmflags.h - gcc -O2 -c continue.c scm.c findexec.c script.c time.c repl.c scl.c \ - eval.c sys.c subr.c unif.c rope.c - gcc -rdynamic -o scm continue.o scm.o findexec.o script.o time.o \ - repl.o scl.o eval.o sys.o subr.o unif.o rope.o -lm -lc + # ================ Compile C source files | + gcc -O2 -c continue.c scm.c scmmain.c findexec.c script.c time.c repl.c scl.c eval.c sys.c subr.c debug.c unif.c rope.c + # ================ Link C object files | + gcc -rdynamic -o scm continue.o scm.o scmmain.o findexec.o script.o time.o repl.o scl.o eval.o sys.o subr.o debug.o unif.o rope.o -lm -lc To cross compile for another platform, invoke build with the `-p' or `--platform=' option. This will create a script for the platform named in the `-p' or `--platform=' option. - bash$ ./build.scm -p vms + bash$ ./build -o scmlit -p darwin -F lit | -| - $DELETE scmflags.h - $CREATE scmflags.h - $DECK - #define IMPLINIT "/home/jaffer/scm/Init5d2.scm" | - #define BIGNUMS - #define FLOATS - #define ARRAYS - $EOD - $ cc continue scm findexec script time repl scl eval sys subr unif rope - $ macro setjump - $ link continue,scm,findexec,script,time,repl,scl,eval,sys,subr,unif,rope,setjump,sys$input/opt - -lc,sys$share:vaxcrtl/share - $RENAME continue.exe scm.exe + #! /bin/sh | + # unix (darwin) script created by SLIB/batch | + # ================ Write file with C defines | + rm -f scmflags.h | + echo '#define IMPLINIT "Init5d6.scm"'>>scmflags.h | + # ================ Compile C source files | + cc -O3 -c continue.c scm.c scmmain.c findexec.c script.c time.c repl.c scl.c eval.c sys.c subr.c debug.c unif.c rope.c + # ================ Link C object files | + mv -f scmlit scmlit~ | + cc -o scmlit continue.o scm.o scmmain.o findexec.o script.o time.o repl.o scl.o eval.o sys.o subr.o debug.o unif.o rope.o File: scm.info, Node: Build Options, Next: Compiling and Linking Custom Files, Prev: Invoking Build, Up: Building SCM @@ -463,45 +456,48 @@ the SCM command line options. - Build Option: --platform=PLATFORM-NAME specifies that the compilation should be for a computer/operating-system combination called PLATFORM-NAME. - *Note:* The case of PLATFORM-NAME is distinguised. The current + _Note:_ The case of PLATFORM-NAME is distinguised. The current PLATFORM-NAMEs are all lower-case. The platforms defined by table "platform" in `build.scm' are: - Table: platform - name processor operating-system compiler - () processor-family operating-system () | - symbol processor-family operating-system symbol - symbol atom symbol symbol - ================= ================= ================= ================= + Table: platform | + name processor operating-system compiler | + #f processor-family operating-system #f | + symbol processor-family operating-system symbol | + symbol atom symbol symbol | + ================= ================= ================= ================= | *unknown* *unknown* unix cc | acorn-unixlib acorn *unknown* cc | aix powerpc aix cc | - alpha alpha osf1 cc + alpha alpha osf1 cc | alpha-elf alpha unix cc | - alpha-linux alpha linux gcc + alpha-linux alpha linux gcc | amiga-aztec m68000 amiga cc | amiga-dice-c m68000 amiga dcc | - amiga-gcc m68000 amiga gcc + amiga-gcc m68000 amiga gcc | amiga-sas m68000 amiga lc | - atari-st-gcc m68000 atari.st gcc + atari-st-gcc m68000 atari.st gcc | atari-st-turbo-c m68000 atari.st tcc | borland-c 8086 ms-dos bcc | - cygwin32 i386 unix gcc - djgpp i386 ms-dos gcc - freebsd i386 unix cc - gcc *unknown* unix gcc + cygwin32 i386 unix gcc | + darwin powerpc unix cc | + djgpp i386 ms-dos gcc | + freebsd i386 unix cc | + gcc *unknown* unix gcc | highc i386 ms-dos hc386 | hp-ux hp-risc hp-ux cc | - irix mips irix gcc - linux i386 linux gcc - linux-aout i386 linux gcc + irix mips irix gcc | + linux i386 linux gcc | + linux-aout i386 linux gcc | microsoft-c 8086 ms-dos cl | microsoft-c-nt i386 ms-dos cl | microsoft-quick-c 8086 ms-dos qcl | ms-dos 8086 ms-dos cc | + openbsd *unknown* unix gcc | os/2-cset i386 os/2 icc | - os/2-emx i386 os/2 gcc + os/2-emx i386 os/2 gcc | + plan9-8 i386 plan9 8c | sunos sparc sunos cc | svr4 *unknown* unix cc | svr4-gcc-sun-ld sparc sunos gcc | @@ -509,7 +505,7 @@ the SCM command line options. unicos cray unicos cc | unix *unknown* unix cc | vms vax vms cc | - vms-gcc vax vms gcc + vms-gcc vax vms gcc | watcom-9.0 i386 ms-dos wcc386p | - Build Option: -o FILENAME @@ -543,9 +539,9 @@ the SCM command line options. - Build Option: -s PATHNAME - Build Option: --scheme-initial=PATHNAME specifies that PATHNAME should be the default location of the SCM - initialization file `Init5d2.scm'. SCM tries several likely | + initialization file `Init5d6.scm'. SCM tries several likely | locations before resorting to PATHNAME (*note File-System - Habitat::.). If not specified, the current directory (where build + Habitat::). If not specified, the current directory (where build is building) is used. - Build Option: -c PATHNAME ... @@ -590,7 +586,7 @@ the SCM command line options. * vms - * amigados + * amigaos (was amigados) | * system @@ -611,23 +607,23 @@ the SCM command line options. specifies to build the given features into the executable. The defined features are: - "array" | - Alias for ARRAYS | - | - "array-for-each" | - array-map! and array-for-each (arrays must also be featured). | - | - "arrays" | - Use if you want arrays, uniform-arrays and uniform-vectors. | - | - "bignums" | - Large precision integers. | - | - "careful-interrupt-masking" | - Define this for extra checking of interrupt masking and some | - simple checks for proper use of malloc and free. This is for | - debugging C code in `sys.c', `eval.c', `repl.c' and makes the | - interpreter several times slower than usual. | + "array" + Alias for ARRAYS + + "array-for-each" + array-map! and array-for-each (arrays must also be featured). + + "arrays" + Use if you want arrays, uniform-arrays and uniform-vectors. + + "bignums" + Large precision integers. + + "careful-interrupt-masking" + Define this for extra checking of interrupt masking and some + simple checks for proper use of malloc and free. This is for + debugging C code in `sys.c', `eval.c', `repl.c' and makes the + interpreter several times slower than usual. "cautious" Normally, the number of arguments arguments to interpreted @@ -638,125 +634,125 @@ the SCM command line options. always check the number of arguments to interpreted closures define feature `cautious'. - "cheap-continuations" | - If you only need straight stack continuations, executables | - compile with this feature will run faster and use less | - storage than not having it. Machines with unusual stacks | - *need* this. Also, if you incorporate new C code into scm | - which uses VMS system services or library routines (which | - need to unwind the stack in an ordrly manner) you may need to | - use this feature. | + "cheap-continuations" + If you only need straight stack continuations, executables + compile with this feature will run faster and use less + storage than not having it. Machines with unusual stacks + _need_ this. Also, if you incorporate new C code into scm + which uses VMS system services or library routines (which + need to unwind the stack in an ordrly manner) you may need to + use this feature. - "compiled-closure" | - Use if you want to use compiled closures. | + "compiled-closure" + Use if you want to use compiled closures. - "curses" | - For the "curses" screen management package. | + "curses" + For the "curses" screen management package. - "debug" | - Turns on the features `cautious', | - `careful-interrupt-masking', and `stack-limit'; uses `-g' | - flags for debugging SCM source code. | + "debug" + Turns on the features `cautious', + `careful-interrupt-masking', and `stack-limit'; uses `-g' + flags for debugging SCM source code. - "dump" | - Convert a running scheme program into an executable file. | + "dump" + Convert a running scheme program into an executable file. - "dynamic-linking" | - Be able to load compiled files while running. | + "dynamic-linking" + Be able to load compiled files while running. - "edit-line" | - interface to the editline or GNU readline library. | + "edit-line" + interface to the editline or GNU readline library. "engineering-notation" Use if you want floats to display in engineering notation (exponents always multiples of 3) instead of scientific notation. - "generalized-c-arguments" | - `make_gsubr' for arbitrary (< 11) arguments to C functions. | + "generalized-c-arguments" + `make_gsubr' for arbitrary (< 11) arguments to C functions. - "i/o-extensions" | - Commonly available I/O extensions: "exec", line I/O, file | - positioning, file delete and rename, and directory functions. | + "i/o-extensions" + Commonly available I/O extensions: "exec", line I/O, file + positioning, file delete and rename, and directory functions. - "inexact" | - Use if you want floating point numbers. | + "inexact" + Use if you want floating point numbers. - "lit" | - Lightweight - no features | + "lit" + Lightweight - no features - "macro" | - C level support for hygienic and referentially transparent | - macros (syntax-rules macros). | - | - "mysql" | - Client connections to the mysql databases. | - | - "no-heap-shrink" | - Use if you want segments of unused heap to not be freed up | - after garbage collection. This may increase time in GC for | - *very* large working sets. | - | - "none" | - No features | - | - "posix" | - Posix functions available on all "Unix-like" systems. fork | - and process functions, user and group IDs, file permissions, | - and "link". | - | - "reckless" | - If your scheme code runs without any errors you can disable | - almost all error checking by compiling all files with | - `reckless'. | + "macro" + C level support for hygienic and referentially transparent + macros (syntax-rules macros). + + "mysql" + Client connections to the mysql databases. + + "no-heap-shrink" + Use if you want segments of unused heap to not be freed up + after garbage collection. This may increase time in GC for + *very* large working sets. + + "none" + No features + + "posix" + Posix functions available on all "Unix-like" systems. fork + and process functions, user and group IDs, file permissions, + and "link". + + "reckless" + If your scheme code runs without any errors you can disable + almost all error checking by compiling all files with + `reckless'. "record" The Record package provides a facility for user to define their own record data types. See SLIB for documentation. - "regex" | - String regular expression matching. | + "regex" + String regular expression matching. - "rev2-procedures" | - These procedures were specified in the `Revised^2 Report on | - Scheme' but not in `R4RS'. | + "rev2-procedures" + These procedures were specified in the `Revised^2 Report on + Scheme' but not in `R4RS'. - "sicp" | - Use if you want to run code from: | + "sicp" + Use if you want to run code from: - Harold Abelson and Gerald Jay Sussman with Julie Sussman. | - `Structure and Interpretation of Computer Programs.' The MIT | - Press, Cambridge, Massachusetts, USA, 1985. | + Harold Abelson and Gerald Jay Sussman with Julie Sussman. + `Structure and Interpretation of Computer Programs.' The MIT + Press, Cambridge, Massachusetts, USA, 1985. - Differences from R5RS are: | - * (eq? '() '#f) | + Differences from R5RS are: + * (eq? '() '#f) - * (define a 25) returns the symbol a. | + * (define a 25) returns the symbol a. - * (set! a 36) returns 36. | + * (set! a 36) returns 36. - "single-precision-only" | - Use if you want all inexact real numbers to be single | - precision. This only has an effect if SINGLES is also | - defined (which is the default). This does not affect complex | - numbers. | + "single-precision-only" + Use if you want all inexact real numbers to be single + precision. This only has an effect if SINGLES is also + defined (which is the default). This does not affect complex + numbers. "socket" BSD "socket" interface. - "stack-limit" | - Use to enable checking for stack overflow. Define value of | - the C preprocessor variable STACK_LIMIT to be the size to | - which SCM should allow the stack to grow. STACK_LIMIT should | - be less than the maximum size the hardware can support, as | - not every routine checks the stack. | - | - "tick-interrupts" | - Use if you want the ticks and ticks-interrupt functions. | - | - "turtlegr" | - "Turtle" graphics calls for both Borland-C and X11 from | - sjm@ee.tut.fi. | + "stack-limit" + Use to enable checking for stack overflow. Define value of + the C preprocessor variable STACK_LIMIT to be the size to + which SCM should allow the stack to grow. STACK_LIMIT should + be less than the maximum size the hardware can support, as + not every routine checks the stack. + + "tick-interrupts" + Use if you want the ticks and ticks-interrupt functions. + + "turtlegr" + "Turtle" graphics calls for both Borland-C and X11 from + sjm@ee.tut.fi. "unix" Those unix features which have not made it into the Posix @@ -765,11 +761,11 @@ the SCM command line options. "windows" Microsoft Windows executable. - "x" | - Alias for Xlib feature. | + "x" + Alias for Xlib feature. - "xlib" | - Interface to Xlib graphics routines. | + "xlib" + Interface to Xlib graphics routines. @@ -785,16 +781,16 @@ A correspondent asks: functions we want access to). Would this involve changing build.scm or the Makefile or both? -(*note Changing Scm::. has instructions describing the C code format). +(*note Changing Scm:: has instructions describing the C code format). Suppose a C file "foo.c" has functions you wish to add to SCM. To compile and link your file at compile time, use the `-c' and `-i' options to build: bash$ build -c foo.c -i init_foo -| - #!/bin/sh + #! /bin/sh rm -f scmflags.h - echo '#define IMPLINIT "/home/jaffer/scm/Init5d2.scm"'>>scmflags.h | + echo '#define IMPLINIT "/home/jaffer/scm/Init5d6.scm"'>>scmflags.h | echo '#define COMPILED_INITS init_foo();'>>scmflags.h echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h @@ -808,9 +804,9 @@ To make a dynamically loadable object file use the `-t dll' option: bash$ build -t dll -c foo.c -| - #!/bin/sh + #! /bin/sh rm -f scmflags.h - echo '#define IMPLINIT "/home/jaffer/scm/Init5d2.scm"'>>scmflags.h | + echo '#define IMPLINIT "/home/jaffer/scm/Init5d6.scm"'>>scmflags.h | echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h echo '#define ARRAYS'>>scmflags.h @@ -874,7 +870,7 @@ The SLIB module "catalog" can be extended to define other `mkimpcat.scm'. Within `mkimpcat.scm', the following procedures are defined. - - Function: add-link FEATURE OBJECT-FILE LIB1 ... + - Function: add-link feature object-file lib1 ... FEATURE should be a symbol. OBJECT-FILE should be a string naming a file containing compiled "object-code". Each LIBn argument should be either a string naming a library file or `#f'. @@ -895,7 +891,7 @@ defined. link:able-suffix)) - - Function: add-alias ALIAS FEATURE + - Function: add-alias alias feature ALIAS and FEATURE are symbols. The procedure `add-alias' registers ALIAS as an alias for FEATURE. An unspecified value is returned. @@ -903,7 +899,7 @@ defined. `add-alias' causes `(require 'ALIAS)' to behave like `(require 'FEATURE)'. - - Function: add-source FEATURE FILENAME + - Function: add-source feature filename FEATURE is a symbol. FILENAME is a string naming a file containing Scheme source code. The procedure `add-source' registers FEATURE so that the first time `require' is called with @@ -920,7 +916,7 @@ Saving Images ============= In SCM, the ability to save running program images is called "dump" -(*note Dump::.). In order to make `dump' available to SCM, build with +(*note Dump::). In order to make `dump' available to SCM, build with feature `dump'. `dump'ed executables are compatible with dynamic linking. @@ -948,7 +944,7 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of ------- ---------- ARM_ULIB Huw Rogers free unix library for acorn archimedes AZTEC_C Aztec_C 5.2a - __CYGWIN__ Cygwin | + __CYGWIN__ Cygwin _DCC Dice C on AMIGA __GNUC__ Gnu CC (and DJGPP) __EMX__ Gnu C port (gcc/emx 0.8e) to OS/2 2.0 @@ -966,8 +962,9 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of __ZTC__ Zortech C _AIX AIX operating system + __APPLE__ Apple Darwin | AMIGA SAS/C 5.10 or Dice C on AMIGA - __amigados__ Gnu CC on AMIGA + __amigaos__ Gnu CC on AMIGA | atarist ATARI-ST under Gnu CC __FreeBSD__ FreeBSD GNUDOS DJGPP (obsolete in version 1.08) @@ -976,11 +973,12 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of linux Linux macintosh Macintosh (THINK_C and __MWERKS__ define) MCH_AMIGA Aztec_c 5.2a on AMIGA + __MACH__ Apple Darwin | MSDOS Microsoft C 5.10 and 6.00A __MSDOS__ Turbo C, Borland C, and DJGPP nosve Control Data NOS/VE SVR2 System V Revision 2. - __svr4__ SunOS + __SVR4 SunOS THINK_C developement environment for the Macintosh ultrix VAX with ULTRIX operating system. unix most Unix and similar systems and DJGPP (!?) @@ -991,7 +989,7 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of vax11c VAX C compiler VAX11 VAX C compiler _Windows Borland C 3.1 compiling for Windows - _WIN32 MS VisualC++ 4.2 and Cygwin (Win32 API) | + _WIN32 MS VisualC++ 4.2 and Cygwin (Win32 API) vms (and VMS) VAX-11 C under VMS. __alpha DEC Alpha processor @@ -1000,6 +998,8 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of __i386__ DJGPP i386 DJGPP MULTIMAX Encore computer + ppc PowerPC | + __ppc__ PowerPC | pyr Pyramid 9810 processor __sgi__ Silicon Graphics Inc. sparc SPARC processor @@ -1013,32 +1013,32 @@ File: scm.info, Node: Problems Compiling, Next: Problems Linking, Prev: Autom Problems Compiling ================== -FILE PROBLEM / MESSAGE HOW TO FIX -*.c include file not found. Correct the status of - STDC_HEADERS in scmfig.h. - fix #include statement or add - #define for system type to - scmfig.h. -*.c Function should return a value. Ignore. - Parameter is never used. - Condition is always false. - Unreachable code in function. -scm.c assignment between incompatible Change SIGRETTYPE in scm.c. - types. -time.c CLK_TCK redefined. incompatablility between - <stdlib.h> and <sys/types.h>. - Remove STDC_HEADERS in scmfig.h. - Edit <sys/types.h> to remove - incompatability. -subr.c Possibly incorrect assignment Ignore. - in function lgcd. -sys.c statement not reached. Ignore. - constant in conditional - expression. -sys.c undeclared, outside of #undef STDC_HEADERS in scmfig.h. - functions. -scl.c syntax error. #define SYSTNAME to your system - type in scl.c (softtype). +FILE PROBLEM / MESSAGE HOW TO FIX +*.c include file not found. Correct the status of + STDC_HEADERS in scmfig.h. + fix #include statement or add + #define for system type to + scmfig.h. +*.c Function should return a value. Ignore. + Parameter is never used. + Condition is always false. + Unreachable code in function. +scm.c assignment between incompatible Change SIGRETTYPE in scm.c. + types. +time.c CLK_TCK redefined. incompatablility between + <stdlib.h> and <sys/types.h>. + Remove STDC_HEADERS in scmfig.h. + Edit <sys/types.h> to remove + incompatability. +subr.c Possibly incorrect assignment Ignore. + in function lgcd. +sys.c statement not reached. Ignore. + constant in conditional + expression. +sys.c undeclared, outside of #undef STDC_HEADERS in scmfig.h. + functions. +scl.c syntax error. #define SYSTNAME to your system + type in scl.c (softtype). File: scm.info, Node: Problems Linking, Next: Problems Running, Prev: Problems Compiling, Up: Installing SCM @@ -1046,8 +1046,8 @@ File: scm.info, Node: Problems Linking, Next: Problems Running, Prev: Problem Problems Linking ================ -PROBLEM HOW TO FIX -_sin etc. missing. Uncomment LIBS in makefile. +PROBLEM HOW TO FIX +_sin etc. missing. Uncomment LIBS in makefile. File: scm.info, Node: Problems Running, Next: Testing, Prev: Problems Linking, Up: Installing SCM @@ -1055,38 +1055,38 @@ File: scm.info, Node: Problems Running, Next: Testing, Prev: Problems Linking Problems Running ================ -PROBLEM HOW TO FIX -Opening message and then machine Change memory model option to C -crashes. compiler (or makefile). - Make sure sizet definition is - correct in scmfig.h. - Reduce the size of HEAP_SEG_SIZE in - setjump.h. -Input hangs. #define NOSETBUF -ERROR: heap: need larger initial. Increase initial heap allocation - using -a<kb> or INIT_HEAP_SIZE. -ERROR: Could not allocate. Check sizet definition. - Use 32 bit compiler mode. - Don't try to run as subproccess. -remove <FLAG> in scmfig.h and Do so and recompile files. -recompile scm. -add <FLAG> in scmfig.h and -recompile scm. -ERROR: Init5d2.scm not found. Assign correct IMPLINIT in makefile | - or scmfig.h. - Define environment variable - SCM_INIT_PATH to be the full - pathname of Init5d2.scm. | -WARNING: require.scm not found. Define environment variable - SCHEME_LIBRARY_PATH to be the full - pathname of the scheme library - [SLIB]. - Change library-vicinity in - Init5d2.scm to point to library or | - remove. - Make sure the value of - (library-vicinity) has a trailing - file separator (like / or \). +PROBLEM HOW TO FIX +Opening message and then machine Change memory model option to C +crashes. compiler (or makefile). + Make sure sizet definition is + correct in scmfig.h. + Reduce the size of HEAP_SEG_SIZE in + setjump.h. +Input hangs. #define NOSETBUF +ERROR: heap: need larger initial. Increase initial heap allocation + using -a<kb> or INIT_HEAP_SIZE. +ERROR: Could not allocate. Check sizet definition. + Use 32 bit compiler mode. + Don't try to run as subproccess. +remove <FLAG> in scmfig.h and Do so and recompile files. +recompile scm. +add <FLAG> in scmfig.h and +recompile scm. +ERROR: Init5d6.scm not found. Assign correct IMPLINIT in makefile | + or scmfig.h. + Define environment variable + SCM_INIT_PATH to be the full + pathname of Init5d6.scm. | +WARNING: require.scm not found. Define environment variable + SCHEME_LIBRARY_PATH to be the full + pathname of the scheme library + [SLIB]. + Change library-vicinity in + Init5d6.scm to point to library or | + remove. + Make sure the value of + (library-vicinity) has a trailing + file separator (like / or \). File: scm.info, Node: Testing, Next: Reporting Problems, Prev: Problems Running, Up: Installing SCM @@ -1114,13 +1114,13 @@ of pi. > (load "pi") ;loading "pi" ;done loading "pi.scm" - ;Evaluation took 20 mSec (0 in gc) 767 cells work, 233 bytes other + ;Evaluation took 20 ms (0 in gc) 767 cells work, 233.B other | #<unspecified> > (pi 100 5) 00003 14159 26535 89793 23846 26433 83279 50288 41971 69399 37510 58209 74944 59230 78164 06286 20899 86280 34825 34211 70679 - ;Evaluation took 550 mSec (60 in gc) 36976 cells work, 1548 bytes other + ;Evaluation took 550 ms (60 in gc) 36976 cells work, 1548.B other | #<unspecified> Loading `bench.scm' will compute and display performance statistics of @@ -1128,34 +1128,34 @@ SCM running `pi.scm'. `make bench' or `make benchlit' appends the performance report to the file `BenchLog', facilitating tracking effects of changes to SCM on performance. -PROBLEM HOW TO FIX -Runs some and then machine crashes. See above under machine crashes. -Runs some and then ERROR: ... Remove optimization option to C -(after a GC has happened). compiler and recompile. - #define SHORT_ALIGN in `scmfig.h'. -Some symbol names print incorrectly. Change memory model option to C - compiler (or makefile). - Check that HEAP_SEG_SIZE fits - within sizet. - Increase size of HEAP_SEG_SIZE (or - INIT_HEAP_SIZE if it is smaller - than HEAP_SEG_SIZE). -ERROR: Rogue pointer in Heap. See above under machine crashes. -Newlines don't appear correctly in Check file mode (define OPEN_... in -output files. `Init5d2.scm'). | -Spaces or control characters appear Check character defines in -in symbol names. `scmfig.h'. -Negative numbers turn positive. Check SRS in `scmfig.h'. -VMS: Couldn't unwind stack. #define CHEAP_CONTIUATIONS in - `scmfig.h'. -VAX: botched longjmp. +PROBLEM HOW TO FIX +Runs some and then machine crashes. See above under machine crashes. +Runs some and then ERROR: ... Remove optimization option to C +(after a GC has happened). compiler and recompile. + #define SHORT_ALIGN in `scmfig.h'. +Some symbol names print incorrectly. Change memory model option to C + compiler (or makefile). + Check that HEAP_SEG_SIZE fits + within sizet. + Increase size of HEAP_SEG_SIZE (or + INIT_HEAP_SIZE if it is smaller + than HEAP_SEG_SIZE). +ERROR: Rogue pointer in Heap. See above under machine crashes. +Newlines don't appear correctly in Check file mode (define OPEN_... in +output files. `Init5d6.scm'). | +Spaces or control characters appear Check character defines in +in symbol names. `scmfig.h'. +Negative numbers turn positive. Check SRS in `scmfig.h'. +VMS: Couldn't unwind stack. #define CHEAP_CONTIUATIONS in + `scmfig.h'. +VAX: botched longjmp. Sparc(SUN-4) heap is growing out of control You are experiencing a GC problem peculiar to the Sparc. The problem is that SCM doesn't know how to clear register windows. Every location which is not reused still gets marked at GC time. This causes lots of stuff which should be collected to not be. - This will be a problem with any *conservative* GC until we find + This will be a problem with any _conservative_ GC until we find what instruction will clear the register windows. This problem is exacerbated by using lots of call-with-current-continuations. @@ -1167,8 +1167,8 @@ Reporting Problems Reported problems and solutions are grouped under Compiling, Linking, Running, and Testing. If you don't find your problem listed there, you -can send a bug report to `jaffer @ ai.mit.edu'. The bug report should -include: +can send a bug report to `jaffer @ alum.mit.edu'. The bug report | +should include: | 1. The version of SCM (printed when SCM is invoked with no arguments). @@ -1211,10 +1211,11 @@ File: scm.info, Node: Invoking SCM, Next: SCM Options, Prev: Operational Feat Invoking SCM ============ -scm [-a kbytes] [-ibvqmu] [-p number] - [-c expression] [-e expression] [-f filename] - [-l filename] [-r feature] [-- | - | -s] - [filename] [arguments ...] + scm [-a kbytes] [-muvbiq] [-version] [-help] + [[-]-no-init-file] [-p int] [-r feature] [-h feature] + [-d filename] [-f filename] [-l filename] + [-c expression] [-e expression] [-o dumpname] + [-- | - | -s] [filename] [arguments ...] Upon startup `scm' loads the file specified by by the environment variable SCM_INIT_PATH. @@ -1222,7 +1223,7 @@ variable SCM_INIT_PATH. If SCM_INIT_PATH is not defined or if the file it names is not present, `scm' tries to find the directory containing the executable file. If it is able to locate the executable, `scm' looks for the initialization -file (usually `Init5d2.scm') in platform-dependent directories relative | +file (usually `Init5d6.scm') in platform-dependent directories relative | to this directory. See *Note File-System Habitat:: for a blow-by-blow description. @@ -1231,12 +1232,12 @@ compile parameter IMPLINIT (defined in the makefile or `scmfig.h') is tried. Unless the option `-no-init-file' or `--no-init-file' occurs in the -command line, `Init5d2.scm' checks to see if there is file | +command line, `Init5d6.scm' checks to see if there is file | `ScmInit.scm' in the path specified by the environment variable HOME -(or in the current directory if HOME is undefined). If it finds such a +(or in the current directory if HOME is undefined). If it finds such a file it is loaded. -`Init5d2.scm' then looks for command input from one of three sources: | +`Init5d6.scm' then looks for command input from one of three sources: | From an option on the command line, from a file named on the command line, or from standard input. @@ -1253,9 +1254,9 @@ Options The options are processed in the order specified on the command line. - - Command Option: -a KB - specifies that `scm' should allocate an initial heapsize of KB - kilobytes. This option, if present, must be the first on the + - Command Option: -a k | + specifies that `scm' should allocate an initial heapsize of K | + kilobytes. This option, if present, must be the first on the command line. If not specified, the default is `INIT_HEAP_SIZE' in source file `setjump.h' which the distribution sets at `25000*sizeof(cell)'. @@ -1264,28 +1265,51 @@ The options are processed in the order specified on the command line. - Command Option: --no-init-file Inhibits the loading of `ScmInit.scm' as described above. - - Command Option: -e EXPRESSION - - Command Option: -c EXPRESSION - specifies that the scheme expression EXPRESSION is to be - evaluated. These options are inspired by `perl' and `sh' - respectively. On Amiga systems the entire option and argument need - to be enclosed in quotes. For instance `"-e(newline)"'. - - - Command Option: -r FEATURE - requires FEATURE. This will load a file from [SLIB] if that - FEATURE is not already supported. If FEATURE is 2, 3, 4, or 5 - `scm' will require the features neccessary to support [R2RS], - [R3RS], [R4RS], or [R5RS], respectively. - - - Command Option: -l FILENAME - - Command Option: -f FILENAME - loads FILENAME. `Scm' will load the first (unoptioned) file named + - Command Option: --help + prints usage information and URI; then exit. + + - Command Option: --version + prints version information and exit. + + - Command Option: -r feature + requires FEATURE. This will load a file from [SLIB] if that + FEATURE is not already provided. If FEATURE is 2, 2rs, r2rs, 3, | + 3rs, r3rs, 4, 4rs, r4rs, 5, 5rs, or r5rs; `scm' will require the | + features neccessary to support [R2RS], [R3RS], [R4RS], or [R5RS], | + respectively. | + + - Command Option: -h feature + provides FEATURE. + + - Command Option: -l filename + - Command Option: -f filename + loads FILENAME. `Scm' will load the first (unoptioned) file named on the command line if no `-c', `-e', `-f', `-l', or `-s' option preceeds it. - - Command Option: -p LEVEL - sets the prolixity (verboseness) to LEVEL. This is the same as the - `scm' command (verobse LEVEL). + - Command Option: -d filename + Loads SLIB `databases' feature and opens FILENAME as a database. | + + - Command Option: -e expression + - Command Option: -c expression + specifies that the scheme expression EXPRESSION is to be + evaluated. These options are inspired by `perl' and `sh' + respectively. On Amiga systems the entire option and argument + need to be enclosed in quotes. For instance `"-e(newline)"'. + + - Command Option: -o dumpname + saves the current SCM session as the executable program `dumpname'. + This option works only in SCM builds supporting `dump' (*note + Dump::). + + If options appear on the command line after `-o DUMPNAME', then + the saved session will continue with processing those options when + it is invoked. Otherwise the (new) command line is processed as + usual when the saved image is invoked. + + - Command Option: -p level + sets the prolixity (verboseness) to LEVEL. This is the same as + the `scm' command (verobse LEVEL). - Command Option: -v (verbose mode) specifies that `scm' will print prompts, evaluation @@ -1298,7 +1322,7 @@ The options are processed in the order specified on the command line. - Command Option: -m specifies that subsequent loads, evaluations, and user - interactions will be with syntax-rules macro capability. To use a + interactions will be with syntax-rules macro capability. To use a specific syntax-rules macro implementation from [SLIB] (instead of [SLIB]'s default) put `-r' MACROPACKAGE before `-m' on the command line. @@ -1306,21 +1330,21 @@ The options are processed in the order specified on the command line. - Command Option: -u specifies that subsequent loads, evaluations, and user interactions will be without syntax-rules macro capability. - syntax-rules macro capability can be restored by a subsequent `-m' + Syntax-rules macro capability can be restored by a subsequent `-m' on the command line or from Scheme code. - Command Option: -i - specifies that `scm' should run interactively. That means that + specifies that `scm' should run interactively. That means that `scm' will not terminate until the `(quit)' or `(exit)' command is - given, even if there are errors. It also sets the prolixity level - to 2 if it is less than 2. This will print prompts, evaluation - times, and notice of loading files. The prolixity level can be set - by subsequent options. If `scm' is started from a tty, it will - assume that it should be interactive unless given a subsequent `-b' - option. + given, even if there are errors. It also sets the prolixity level + to 2 if it is less than 2. This will print prompts, evaluation + times, and notice of loading files. The prolixity level can be + set by subsequent options. If `scm' is started from a tty, it + will assume that it should be interactive unless given a + subsequent `-b' option. - Command Option: -b - specifies that `scm' should run non-interactively. That means that + specifies that `scm' should run non-interactively. That means that `scm' will terminate after processing the command line or if there are errors. @@ -1332,25 +1356,6 @@ The options are processed in the order specified on the command line. - Command Option: -- specifies that there are no more options on the command line. - - Command Option: -d FILENAME - loads SLIB database-utilities and opens FILENAME as a database. - - - Command Option: -o FILENAME - saves the current SCM session as the executable program `filename'. - This option works only in SCM builds supporting `dump' (*note - Dump::.). - - If options appear on the command line after `-o FILENAME', then - the saved session will continue with processing those options when - it is invoked. Otherwise the (new) command line is processed as - usual when the saved image is invoked. - - - Command Option: --help - prints usage information and URL; then exit. - - - Command Option: --version - prints version information and exit. - File: scm.info, Node: Invocation Examples, Next: SCM Variables, Prev: SCM Options, Up: Operational Features @@ -1391,13 +1396,13 @@ Environment Variables - Environment Variable: SCM_INIT_PATH is the pathname where `scm' will look for its initialization code. - The default is the file `Init5d2.scm' in the source directory. | + The default is the file `Init5d6.scm' in the source directory. | - Environment Variable: SCHEME_LIBRARY_PATH is the [SLIB] Scheme library directory. - Environment Variable: HOME - is the directory where `Init5d2.scm' will look for the user | + is the directory where `Init5d6.scm' will look for the user | initialization file `ScmInit.scm'. - Environment Variable: EDITOR @@ -1408,20 +1413,20 @@ Scheme Variables ================ - Variable: *argv* - contains the list of arguments to the program. `*argv*' can change - during argument processing. This list is suitable for use as an + contains the list of arguments to the program. `*argv*' can change + during argument processing. This list is suitable for use as an argument to [SLIB] `getopt'. - - Variable: *R4RS-macro* + - Variable: *syntax-rules* | controls whether loading and interaction support syntax-rules - macros. Define this in `ScmInit.scm' or files specified on the - command line. This can be overridden by subsequent `-m' and `-u' + macros. Define this in `ScmInit.scm' or files specified on the + command line. This can be overridden by subsequent `-m' and `-u' options. - Variable: *interactive* controls interactivity as explained for the `-i' and `-b' options. Define this in `ScmInit.scm' or files specified on the command - line. This can be overridden by subsequent `-i' and `-b' options. + line. This can be overridden by subsequent `-i' and `-b' options. File: scm.info, Node: SCM Session, Next: Editing Scheme Code, Prev: SCM Variables, Up: Operational Features @@ -1440,13 +1445,18 @@ SCM Session form and resumes the top level read-eval-print loop. - Function: quit - - Function: quit N + - Function: quit n - Function: exit - - Function: exit N + - Function: exit n Aliases for `exit' (*note exit: (slib)System.). On many systems, SCM can also tail-call another program. *Note execp: I/O-Extensions. + - Callback procedure: boot-tail dumped? | + `boot-tail' is called by `scm_top_level' just before entering | + interactive top-level. If `boot-tail' calls `quit', then | + interactive top-level is not entered. | + | - Function: program-arguments Returns a list of strings of the arguments scm was called with. @@ -1463,11 +1473,11 @@ File: scm.info, Node: Editing Scheme Code, Next: Debugging Scheme Code, Prev: Editing Scheme Code =================== - - Function: ed ARG1 ... + - Function: ed arg1 ... The value of the environment variable `EDITOR' (or just `ed' if it isn't defined) is invoked as a command with arguments ARG1 .... - - Function: ed FILENAME + - Function: ed filename If SCM is compiled under VMS `ed' will invoke the editor with a single the single argument FILENAME. @@ -1476,11 +1486,11 @@ Gnu Emacs: files ending in .scm are automatically put into scheme-mode. EMACS for MS-DOS and MS-Windows systems is available (free) from: - `http://simtel.coast.net/SimTel/gnu/demacs.html' + <http://simtel.coast.net/SimTel/gnu/demacs.html> If your Emacs can run a process in a buffer you can use the Emacs -command `M-x run-scheme' with SCM. Otherwise, use the emacs command -`M-x suspend-emacs'; or see "other systems" below. + command `M-x run-scheme' with SCM. Otherwise, use the emacs + command `M-x suspend-emacs'; or see "other systems" below. Epsilon (MS-DOS): There is lisp (and scheme) mode available by use of the package @@ -1499,7 +1509,7 @@ Epsilon (MS-DOS): other systems: Define the environment variable `EDITOR' to be the name of the - editing program you use. The SCM procedure `(ed arg1 ...)' will + editing program you use. The SCM procedure `(ed arg1 ...)' will invoke your editor and return to SCM when you exit the editor. The following definition is convenient: @@ -1515,7 +1525,7 @@ Debugging Scheme Code ===================== The `cautious' and `stack-limit' options of `build' (*note Build -Options::.) support debugging in Scheme. +Options::) support debugging in Scheme. "CAUTIOUS" If SCM is built with the `CAUTIOUS' flag, then when an error @@ -1548,7 +1558,7 @@ Options::.) support debugging in Scheme. There are several SLIB macros which so useful that SCM automatically loads the appropriate module from SLIB if they are invoked. - - Macro: trace PROC1 ... + - Macro: trace proc1 ... Traces the top-level named procedures given as arguments. - Macro: trace @@ -1556,7 +1566,7 @@ loads the appropriate module from SLIB if they are invoked. identifiers are traced (even if those identifiers have been redefined) and returns a list of the traced identifiers. - - Macro: untrace PROC1 ... + - Macro: untrace proc1 ... Turns tracing off for its arguments. - Macro: untrace @@ -1565,7 +1575,7 @@ loads the appropriate module from SLIB if they are invoked. The routines I use most frequently for debugging are: - - Procedure: print ARG1 ... + - Procedure: print arg1 ... `Print' writes all its arguments, separated by spaces. `Print' outputs a `newline' at the end and returns the value of the last argument. @@ -1573,7 +1583,7 @@ The routines I use most frequently for debugging are: One can just insert `(print '<proc-name>' and `)' around an expression in order to see its value as a program operates. - - Syntax: print-args NAME1 ... + - Syntax: print-args name1 ... Writes NAME1 ... (separated by spaces) and then writes the values of the closest lexical bindings enclosing the call to `Print-args'. @@ -1591,8 +1601,8 @@ When `trace' is not sufficient to find program flow problems, SLIB-PSD, the Portable Scheme Debugger offers source code debugging from GNU Emacs. PSD runs slowly, so start by instrumenting only a few functions at a time. - http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz | - ftp.gnu.org:pub/gnu/jacal/slib-psd1-3.tar.gz + http://swissnet.ai.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz + swissnet.ai.mit.edu:/pub/scm/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 @@ -1613,7 +1623,7 @@ response code in C. The following common error and conditions are handled by C code. Those with callback names after them can also be handled by Scheme code -(*note Interrupts::.). If the callback identifier is not defined at top +(*note Interrupts::). If the callback identifier is not defined at top level, the default error handler (C code) is invoked. There are many other error messages which are not treated specially. @@ -1682,13 +1692,13 @@ other error messages which are not treated specially. current form, prints a message explaining the error, and resumes the top level read-eval-print loop. The value of ERROBJ is the offending object if appropriate. The builtin procedure `error' - does *not* set ERROBJ. + does _not_ set ERROBJ. `errno' and `perror' report ANSI C errors encountered during a call to a system or library function. - Function: errno - - Function: errno N + - Function: errno n With no argument returns the current value of the system variable `errno'. When given an argument, `errno' sets the system variable `errno' to N and returns the previous value of `errno'. `(errno @@ -1696,7 +1706,7 @@ a system or library function. `try-load' returns `#f' since this occurs when the file could not be opened. - - Function: perror STRING + - Function: perror string Prints on standard error output the argument STRING, a colon, followed by a space, the error message corresponding to the current value of `errno' and a newline. The value returned is unspecified. @@ -1704,15 +1714,15 @@ a system or library function. `warn' and `error' provide a uniform way for Scheme code to signal warnings and errors. - - Function: warn ARG1 ARG2 ARG3 ... + - Function: warn arg1 arg2 arg3 ... Alias for *Note slib:warn: (slib)System. Outputs an error message - containing the arguments. `warn' is defined in `Init5d2.scm'. | + containing the arguments. `warn' is defined in `Init5d6.scm'. | - - Function: error ARG1 ARG2 ARG3 ... + - Function: error arg1 arg2 arg3 ... Alias for *Note slib:error: (slib)System. Outputs an error message containing the arguments, aborts evaluation of the current form and resumes the top level read-eval-print loop. `Error' is - defined in `Init5d2.scm'. | + defined in `Init5d6.scm'. | If SCM is built with the `CAUTIOUS' flag, then when an error occurs, a "stack trace" of certain pending calls are printed as part of the @@ -1730,7 +1740,7 @@ with Lisp systems. - Function: stack-trace Prints information describing the stack of partially evaluated expressions. `stack-trace' returns `#t' if any lines were printed - and `#f' otherwise. See `Init5d2.scm' for an example of the use | + and `#f' otherwise. See `Init5d6.scm' for an example of the use | of `stack-trace'. @@ -1755,7 +1765,7 @@ a convenient aid to locating bugs and untested expressions. * The names of identifiers which are not lexiallly bound but defined at top-level have #@ prepended. -For instance, `open-input-file' is defined as follows in `Init5d2.scm': | +For instance, `open-input-file' is defined as follows in `Init5d6.scm': | (define (open-input-file str) (or (open-file str OPEN_READ) @@ -1802,9 +1812,9 @@ Internal State The variable *INTERACTIVE* determines whether the SCM session is interactive, or should quit after the command line is processed. *INTERACTIVE* is controlled directly by the command-line options - `-b', `-i', and `-s' (*note Invoking SCM::.). If none of these + `-b', `-i', and `-s' (*note Invoking SCM::). If none of these options are specified, the rules to determine interactivity are - more complicated; see `Init5d2.scm' for details. | + more complicated; see `Init5d6.scm' for details. | - Function: abort Resumes the top level Read-Eval-Print loop. @@ -1815,16 +1825,16 @@ Internal State those files have changed, those changes will be reflected in the new session. - *Note:* When running a saved executable (*note Dump::.), `restart' + _Note:_ When running a saved executable (*note Dump::), `restart' is redefined to be `exec-self'. - Function: exec-self Exits and immediately re-invokes the same executable with the same arguments. If the executable file has been changed or replaced - since the beginning of the current session, the *new* executable + since the beginning of the current session, the _new_ executable will be invoked. This differentiates `exec-self' from `restart'. - - Function: verbose N + - Function: verbose n Controls how much monitoring information is printed. If N is: 0 @@ -1834,37 +1844,38 @@ Internal State a prompt is printed. >= 2 - the CPU time is printed after each top level form evaluated. + messages bracketing file loading are printed. | >= 3 - messages about heap growth are printed. + the CPU time is printed after each top level form evaluated; | + notifications of heap growth printed. | >= 4 - garbage collection (*note Garbage Collection::.) messages are - printed. + a garbage collection summary is printed after each top level | + form evaluated; | >= 5 - a warning will be printed for each top-level symbol which is - defined more than one time. + a message for each GC (*note Garbage Collection::) is printed; | + warnings issued for top-level symbols redefined. | - Function: gc Scans all of SCM objects and reclaims for further use those that are no longer accessible. - Function: room - - Function: room #T + - Function: room #t Prints out statistics about SCM's current use of storage. `(room #t)' also gives the hexadecimal heap segment and stack bounds. - Constant: *scm-version* - Contains the version string (e.g. `5d2') of SCM. | + Contains the version string (e.g. `5d6') of SCM. | Executable path --------------- In order to dump a saved executable or to dynamically-link using DLD, SCM must know where its executable file is. Sometimes SCM (*note -Executable Pathname::.) guesses incorrectly the location of the +Executable Pathname::) guesses incorrectly the location of the currently running executable. In that case, the correct path can be set by calling `execpath' with the pathname. @@ -1873,8 +1884,8 @@ by calling `execpath' with the pathname. file whose invocation the currently running session is, or #f if the path is not set. - - Function: execpath #F - - Function: execpath NEWPATH + - Function: execpath #f + - Function: execpath newpath Sets the path to `#f' or NEWPATH, respectively. The old path is returned. @@ -1908,7 +1919,7 @@ file has (different) meanings to SCM and the operating system permissions) whose first two characters are `#!'. The INTERPRETER argument must be the pathname of the program to process the rest of the file. The directories named by environment variable `PATH' - are *not* searched to find INTERPRETER. + are _not_ searched to find INTERPRETER. When executing a shell-script, the operating system invokes INTERPRETER with a single argument encapsulating the rest of the @@ -1932,7 +1943,7 @@ file has (different) meanings to SCM and the operating system `\' substitution; this will only take place if INTERPRETER is a SCM or SCSH interpreter. - - Read syntax: #! IGNORED !# + - Read syntax: #! ignored !# When the first two characters of the file being loaded are `#!' and a `\' is present before a newline in the file, all characters up to `!#' will be ignored by SCM `read'. @@ -1940,7 +1951,7 @@ file has (different) meanings to SCM and the operating system This combination of interpretatons allows SCM source files to be used as POSIX shell-scripts if the first line is: - #!/usr/local/bin/scm \ + #! /usr/local/bin/scm \ The following Scheme-Script prints factorial of its argument: @@ -2013,7 +2024,7 @@ following syntax for <PROGRAM>.BAT files. Once the INTERPRETER executable path is found, arguments are processed in the manner of scheme-shell, with the all the text after the `\' taken as part of the meta-argument. More precisely, - `#!' calls INTERPRETER with any options on the second line of the + `#!' calls INTERPRETER with any options on the second line of the Scheme-Script up to `!#', the name of the Scheme-Script file, and then any of at most 8 arguments given on the command line invoking this Scheme-Script. @@ -2036,7 +2047,7 @@ Scheme-scripts suffer from two drawbacks: programs are moved. The following approach solves these problems at the expense of slower -startup. Make `#!/bin/sh' the first line and prepend every subsequent +startup. Make `#! /bin/sh' the first line and prepend every subsequent line to be executed by the shell with `:;'. The last line to be executed by the shell should contain an "exec" command; `exec' tail-calls its argument. @@ -2096,6 +2107,7 @@ The Language * Interrupts:: and exceptions * Process Synchronization:: Because interrupts are preemptive * Files and Ports:: +* Line Numbers:: | * Soft Ports:: Emulate I/O devices * Syntax Extensions:: * Low Level Syntactic Hooks:: @@ -2108,7 +2120,7 @@ Standards Compliance ==================== Scm conforms to the `IEEE Standard 1178-1990. IEEE Standard for the -Scheme Programming Language.' (*note Bibliography::.), and `Revised(5) +Scheme Programming Language.' (*note Bibliography::), and `Revised(5) Report on the Algorithmic Language Scheme'. *Note Top: (r5rs)Top. All the required features of these specifications are supported. Many of the optional features are supported as well. @@ -2227,7 +2239,7 @@ File: scm.info, Node: Miscellaneous Procedures, Next: Time, Prev: Standards C Miscellaneous Procedures ======================== - - Function: try-load FILENAME + - Function: try-load filename If the string FILENAME names an existing file, the try-load procedure reads Scheme source code expressions and definitions from the file and evaluates them sequentially and returns `#t'. @@ -2237,37 +2249,39 @@ Miscellaneous Procedures - Variable: *load-pathname* Is set to the pathname given as argument to `load', `try-load', - and `dyn:link' (*note Compiling And Linking::.). - `*load-pathname*' is used to compute the value of *Note - program-vicinity: (slib)Vicinity. + and `dyn:link' (*note Compiling And Linking: (hobbit)Compiling And | + Linking.). `*load-pathname*' is used to compute the value of | + *Note program-vicinity: (slib)Vicinity. | - Function: line-number Returns the current line number of the file currently being loaded. - - Function: port-filename PORT | - Returns the filename PORT was opened with. If PORT is not open to | - a file the result is unspecified. | - | - - Function: port-line PORT | - - Function: port-column PORT | - If PORT is a tracked port, return the current line (column) number, | - otherwise return `#f'. Line numbers begin with 1, the column | - number is zero if there are no characters on the current line. | - | - - Function: eval OBJ + - Function: port-filename port + Returns the filename PORT was opened with. If PORT is not open to + a file the result is unspecified. + + - Function: port-line port + - Function: port-column port + If PORT is a tracked port, return the current line (column) number, + otherwise return `#f'. Line and column numbers begin with 1. The + column number applies to the next character to be read; if that + character is a newline, then the column number will be one more + than the length of the line. + + - Function: eval obj Alias for *Note eval: (slib)System. - - Function: eval-string STR + - Function: eval-string str Returns the result of reading an expression from STR and evaluating it. `eval-string' does not change `*load-pathname*' or `line-number'. - - Function: load-string STR + - Function: load-string str Reads and evaluates all the expressions from STR. As with `load', the value returned is unspecified. `load-string' does not change `*load-pathname*' or `line-number'. - - Function: vector-set-length! OBJECT LENGTH + - Function: vector-set-length! object length Change the length of string, vector, bit-vector, or uniform-array OBJECT to LENGTH. If this shortens OBJECT then the remaining contents are lost. If it enlarges OBJECT then the contents of the @@ -2275,23 +2289,23 @@ Miscellaneous Procedures It is an error to change the length of literal datums. The new object is returned. - - Function: copy-tree OBJ - - Function: @copy-tree OBJ + - Function: copy-tree obj + - Function: @copy-tree obj *Note copy-tree: (slib)Tree Operations. This extends the SLIB version by also copying vectors. Use `@copy-tree' if you depend on this feature; `copy-tree' could get redefined. - - Function: acons OBJ1 OBJ2 OBJ3 + - Function: acons obj1 obj2 obj3 Returns (cons (cons obj1 obj2) obj3). The expression (set! a-list (acons key datum a-list)) adds a new association to a-list. - Function: terms This command displays the GNU General Public License. - - Function: list-file FILENAME + - Function: list-file filename Displays the text contents of FILENAME. - - Procedure: print ARG1 ... + - Procedure: print arg1 ... `Print' writes all its arguments, separated by spaces. `Print' outputs a `newline' at the end and returns the value of the last argument. @@ -2330,7 +2344,7 @@ File: scm.info, Node: Interrupts, Next: Process Synchronization, Prev: Time, Interrupts ========== - - Function: ticks N + - Function: ticks n Returns the number of ticks remaining till the next tick interrupt. Ticks are an arbitrary unit of evaluation. Ticks can vary greatly in the amount of time they represent. @@ -2347,15 +2361,15 @@ Interrupts should (abort) or some other action which does not return if it does not want processing to continue. - - Function: alarm SECS + - Function: alarm secs Returns the number of seconds remaining till the next alarm interrupt. If SECS is 0, any alarm request is canceled. Otherwise an `alarm-interrupt' will be signaled SECS from the current time. ALARM is not supported on all systems. - - Function: milli-alarm MILLISECS INTERVAL - - Function: virtual-alarm MILLISECS INTERVAL - - Function: profile-alarm MILLISECS INTERVAL + - Function: milli-alarm millisecs interval + - Function: virtual-alarm millisecs interval + - Function: profile-alarm millisecs interval `milli-alarm' is similar to `alarm', except that the first argument MILLISECS, and the return value are measured in milliseconds rather than seconds. If the optional argument @@ -2403,35 +2417,93 @@ Interrupts To unestablish a response for an error set the handler symbol to `#f'. For instance, `(set! could-not-open #f)'. + - Callback procedure: gc-hook ... | + Allows a Scheme procedure to be run shortly after each garbage | + collection. This procedure will not be run recursively. If it | + runs long enough to cause a garbage collection before returning a | + warning will be printed. | + | + - Function: add-finalizer object finalizer | + OBJECT may be any garbage collected object, that is, any object | + other than an immediate integer, character, or special token such | + as `#f' or `#t', *Note Immediates::. FINALIZER is a thunk, or | + procedure taking no arguments. | + | + FINALIZER will be invoked asynchronously exactly once some time | + after OBJECT becomes eligible for garbage collection. A reference | + to OBJECT in the environment of FINALIZER will not prevent | + finalization, but will delay the reclamation of OBJECT at least | + until the next garbage collection. A reference to OBJECT in some | + other object's finalizer will necessarily prevent finalization | + until both objects are eligible for garbage collection. | + | + Finalizers are not run in any predictable order. All finalizers | + will be run by the time the program ends. | + | + This facility was based on the paper by Simon Peyton Jones, et al, | + "Stretching the storage manager: weak pointers and stable names in | + Haskell", Proc. 11th International Workshop on the Implementation | + of Functional Languages, The Netherlands, September 7-10 1999, | + Springer-Verlag LNCS. | + | + | File: scm.info, Node: Process Synchronization, Next: Files and Ports, Prev: Interrupts, Up: The Language Process Synchronization ======================= - - Function: make-arbiter NAME +An "exchanger" is a procedure of one argument regulating mutually | +exclusive access to a resource. When a exchanger is called, its current | +content is returned, while being replaced by its argument in an atomic | +operation. | + | + - Function: make-exchanger obj | + Returns a new exchanger with the argument OBJ as its initial | + content. | + | + (define queue (make-exchanger (list a))) | + | + A queue implemented as an exchanger holding a list can be | + protected from reentrant execution thus: | + | + (define (pop queue) | + (let ((lst #f)) | + (dynamic-wind | + (lambda () (set! lst (queue #f))) | + (lambda () (and lst (not (null? lst)) | + (let ((ret (car lst))) | + (set! lst (cdr lst)) | + ret))) | + (lambda () (and lst (queue lst)))))) | + | + (pop queue) => a | + | + (pop queue) => #f | + | + - Function: make-arbiter name Returns an object of type arbiter and name NAME. Its state is initially unlocked. - - Function: try-arbiter ARBITER + - Function: try-arbiter arbiter Returns `#t' and locks ARBITER if ARBITER was unlocked. Otherwise, returns `#f'. - - Function: release-arbiter ARBITER + - Function: release-arbiter arbiter Returns `#t' and unlocks ARBITER if ARBITER was locked. Otherwise, returns `#f'. -File: scm.info, Node: Files and Ports, Next: Soft Ports, Prev: Process Synchronization, Up: The Language - +File: scm.info, Node: Files and Ports, Next: Line Numbers, Prev: Process Synchronization, Up: The Language + | Files and Ports =============== These procedures generalize and extend the standard capabilities in *Note Ports: (r5rs)Ports. - - Function: open-file STRING MODES - - Function: try-open-file STRING MODES + - Function: open-file string modes + - Function: try-open-file string modes Returns a port capable of receiving or delivering characters as specified by the MODES string. If a file cannot be opened `#f' is returned. @@ -2447,34 +2519,44 @@ These procedures generalize and extend the standard capabilities in Contain modes strings specifying that a file is to be opened for reading, writing, and both reading and writing respectively. - - Function: _ionbf MODESTR - Returns a version of MODESTR which when `open-file' is called with | - it as the second argument will return an unbuffered port. A - non-file input-port must be unbuffered in order for `char-ready?' | - and `wait-for-input' to work correctly on it. The initial value of | - `(current-input-port)' is unbuffered if the platform supports it. | + Both input and output functions can be used with io-ports. An end | + of file must be read or a file-set-position done on the port | + between a read operation and a write operation or vice-versa. | | - - Function: _tracked MODESTR | + - Function: _ionbf modestr + Returns a version of MODESTR which when `open-file' is called with + it as the second argument will return an unbuffered port. An | + input-port must be unbuffered in order for `char-ready?' and | + `wait-for-input' to work correctly on it. The initial value of | + `(current-input-port)' is unbuffered if the platform supports it. + + - Function: _tracked modestr + Returns a version of MODESTR which when `open-file' is called with + it as the second argument will return a tracked port. A tracked + port maintains current line and column numbers, which may be + queried with `port-line' and `port-column'. + + - Function: _exclusive modestr | Returns a version of MODESTR which when `open-file' is called with | - it as the second argument will return a tracked port. A tracked | - port maintains current line and column numbers, which may be | - queried with `port_line' and `port_column'. | - - - Function: close-port PORT + it as the second argument will return a port only if the named file | + does not already exist. This functionality is provided by calling | + `try-create-file' *Note I/O-Extensions::, which is not available | + for all platforms. | + | + - Function: port-closed? port | + Returns #t if PORT is closed. | + | + - Function: port-type obj | + If OBJ is not a port returns false, otherwise returns a symbol | + describing the port type, for example string or pipe. | + | + - Function: close-port port Closes PORT. The same as close-input-port and close-output-port. - - - Function: open-io-file FILENAME - - Function: close-io-port PORT - These functions are analogous to the standard scheme file - functions. The ports are open to FILENAME in read/write mode. - Both input and output functions can be used with io-ports. An end - of file must be read or a file-set-position done on the port - between a read operation and a write operation or vice-versa. - + | - Function: current-error-port Returns the current port to which diagnostic output is directed. - - Function: with-error-to-file STRING THUNK + - Function: with-error-to-file string thunk THUNK must be a procedure of no arguments, and string must be a string naming a file. The file is opened for output, an output port connected to it is made the default value returned by @@ -2483,15 +2565,23 @@ These procedures generalize and extend the standard capabilities in default is restored. With-error-to-file returns the value yielded by THUNK. - - Function: with-input-from-port PORT THUNK - - Function: with-output-to-port PORT THUNK - - Function: with-error-to-port PORT THUNK + - Function: with-input-from-port port thunk + - Function: with-output-to-port port thunk + - Function: with-error-to-port port thunk These routines differ from with-input-from-file, with-output-to-file, and with-error-to-file in that the first argument is a port, rather than a string naming a file. + - Function: call-with-outputs thunk proc + Calls the THUNK procedure while the current-output-port and + current-error-port are directed to string-ports. If THUNK + returns, the PROC procedure is called with the output-string, the + error-string, and the value returned by THUNK. If THUNK does not + return a value (perhaps because of error), PROC is called with + just the output-string and the error-string as arguments. + - procedure: char-ready? - - procedure: char-ready? PORT + - procedure: char-ready? port Returns `#t' if a character is ready on the input PORT and returns `#f' otherwise. If `char-ready?' returns `#t' then the next `read-char' operation on the given PORT is guaranteed not to hang. @@ -2499,44 +2589,103 @@ These procedures generalize and extend the standard capabilities in PORT may be omitted, in which case it defaults to the value returned by `current-input-port'. - *Rationale:* `Char-ready?' exists to make it possible for a + _Rationale:_ `Char-ready?' exists to make it possible for a program to accept characters from interactive ports without getting stuck waiting for input. Any input editors associated with such ports must ensure that characters whose existence has - been asserted by `char-ready?' cannot be rubbed out. If + been asserted by `char-ready?' cannot be rubbed out. If `char-ready?' were to return `#f' at end of file, a port at end of file would be indistinguishable from an interactive port that has no ready characters. - - procedure: wait-for-input X - - procedure: wait-for-input X PORT1 ... + - procedure: wait-for-input x + - procedure: wait-for-input x port1 ... Returns a list those ports PORT1 ... which are `char-ready?'. If none of PORT1 ... become `char-ready?' within the time interval of X seconds, then #f is returned. The PORT1 ... arguments may be omitted, in which case they default to the list of the value returned by `current-input-port'. - - Function: isatty? PORT + - Function: isatty? port Returns `#t' if PORT is input or output to a serial non-file device. - - Function: freshline PORT | - Outputs a newline to optional argument PORT unless the current | - output column number of PORT is known to be zero, ie output will | - start at the beginning of a new line. PORT defaults to | - `current-output-port'. If PORT is not a tracked port `freshline' | - is equivalent to `newline'. | + - Function: freshline port + Outputs a newline to optional argument PORT unless the current + output column number of PORT is known to be zero, ie output will + start at the beginning of a new line. PORT defaults to + `current-output-port'. If PORT is not a tracked port `freshline' + is equivalent to `newline'. + + - Function: open-ports | + Returns a list of all currently open ports, excluding string ports, | + see *Note String Ports: (slib)String Ports. This may be useful | + after a fork *Note Posix Extensions::, or for debugging. Bear in | + mind that ports that would be closed by gc will be kept open by a | + reference to this list. | | -File: scm.info, Node: Soft Ports, Next: Syntax Extensions, Prev: Files and Ports, Up: The Language - +File: scm.info, Node: Line Numbers, Next: Soft Ports, Prev: Files and Ports, Up: The Language + | +Line Numbers | +============ | + | +Scheme code define by load may optionally contain line number | +information. Currently this information is used only for reporting | +expansion time errors, but in the future run-time error messages may | +also include line number information. | + | + - Function: try-load pathname reader | + This is the primitive for loading, PATHNAME is the name of a file | + containing Scheme code, and optional argument READER is a function | + of one argument, a port. READER should read and return Scheme | + code as list structure. The default value is `read', which is | + used if READER is not supplied or is false. | + | +Line number objects are disjoint from integers or other Scheme types. | +When evaluated or loaded as Scheme code, an s-expression containing a | +line-number in the car is equivalent to the cdr of the s-expression. A | +pair consisting of a line-number in the car and a vector in the cdr is | +equivalent to the vector. The meaning of s-expressions with | +line-numbers in other positions is undefined. | + | + - Function: read-numbered port | + Behaves like `read', except that every s-expression read will be | + replaced with a cons of a line-number object and the sexp actually | + read. This replacement is done only if PORT is a tracked port See | + *Note Files and Ports::. | + | + - Function: integer->line-number int | + Returns a line-number object with value INT. INT should be an | + exact non-negative integer. | + | + - Function: line-number->integer linum | + Returns the value of line-number object LINUM as an integer. | + | + - Function: line-number? obj | + Returns true if and only if OBJ is a line-number object. | + | + - Variable: *load-reader* | + - Variable: *slib-load-reader* | + The value of `*load-reader*' should be a value acceptable as the | + second argument to `try-load' (note that #f is acceptable). This | + value will be used to read code during calls to `scm:load'. The | + value of `*slib-load-reader*' will similarly be used during calls | + to `slib:load' and `require'. | + | + In order to disable all line-numbering, it is sufficient to set! | + `*load-reader*' and `*slib-load-reader*' to #f. | + | + +File: scm.info, Node: Soft Ports, Next: Syntax Extensions, Prev: Line Numbers, Up: The Language + | Soft Ports ========== A "soft-port" is a port based on a vector of procedures capable of accepting or delivering characters. It allows emulation of I/O ports. - - Function: make-soft-port VECTOR MODES + - Function: make-soft-port vector modes Returns a port capable of receiving or delivering characters as specified by the MODES string (*note open-file: Files and Ports.). VECTOR must be a vector of length 6. Its components are as @@ -2561,6 +2710,9 @@ accepting or delivering characters. It allows emulation of I/O ports. (r5rs)Input.) it indicates that the port has reached end-of-file. For example: + If it is necessary to explicitly close the port when it is garbage | + collected, (*note add-finalizer: Interrupts.). | + | (define stdout (current-output-port)) (define p (make-soft-port (vector @@ -2579,7 +2731,7 @@ File: scm.info, Node: Syntax Extensions, Next: Low Level Syntactic Hooks, Pre Syntax Extensions ================= - - procedure: procedure-documentation PROC + - procedure: procedure-documentation proc Returns the documentation string of PROC if it exists, or `#f' if not. @@ -2595,18 +2747,18 @@ Syntax Extensions => #<unspecified> (procedure-documentation square) => "Return the square of X." - - Function: comment STRING1 ... | - Appends STRING1 ... to the strings given as arguments to previous | - calls `comment'. | - | - - Function: comment | - Returns the (appended) strings given as arguments to previous calls | - `comment' and empties the current string collection. | - | - - Read syntax: #;text-till-end-of-line | - Behaves as `(comment "TEXT-TILL-END-OF-LINE")'. | - | - - Read syntax: #. EXPRESSION + - Function: comment string1 ... + Appends STRING1 ... to the strings given as arguments to previous + calls `comment'. + + - Function: comment + Returns the (appended) strings given as arguments to previous calls + `comment' and empties the current string collection. + + - Read syntax: #;text-till-end-of-line + Behaves as `(comment "TEXT-TILL-END-OF-LINE")'. + + - Read syntax: #. expression Is read as the object resulting from the evaluation of EXPRESSION. This substitution occurs even inside quoted structure. @@ -2617,7 +2769,7 @@ Syntax Extensions #.(define foo 9) => #<unspecified> '(#.foo #.(+ foo foo)) => (9 18) - - Read syntax: #+ FEATURE FORM + - Read syntax: #+ feature form If feature is `provided?' (by `*features*') then FORM is read as a scheme expression. If not, then FORM is treated as whitespace. @@ -2627,19 +2779,19 @@ Syntax Extensions For more information on `provided?' and `*features*', *Note Require: (slib)Require. - - Read syntax: #- FEATURE FORM + - Read syntax: #- feature form is equivalent to `#+(not feature) expression'. - - Read syntax: #' FORM + - Read syntax: #' form is equivalent to FORM (for compatibility with common-lisp). - - Read syntax: #| ANY THING |# + - Read syntax: #| any thing |# Is a balanced comment. Everything up to the matching `|#' is ignored by the `read'. Nested `#|...|#' can occur inside ANY THING. A similar read syntax "#!" (exclamation rather than vertical bar) is -supported for Posix shell-scripts (*note Scripting::.). +supported for Posix shell-scripts (*note Scripting::). - Read syntax: #\token If TOKEN is a sequence of two or more digits, then this syntax is @@ -2650,31 +2802,31 @@ supported for Posix shell-scripts (*note Scripting::.). followed by a character, then a meta character is read. `c-' and `m-' prefixes may be combined. - - Special Form: defined? SYMBOL + - Special Form: defined? symbol Equivalent to `#t' if SYMBOL is a syntactic keyword (such as `if') or a symbol with a value in the top level environment (*note Variables and regions: (r5rs)Variables and regions.). Otherwise equivalent to `#f'. - - Special Form: defvar IDENTIFIER INITIAL-VALUE + - Special Form: defvar identifier initial-value If IDENTIFIER is unbound in the top level environment, then IDENTIFIER is `define'd to the result of evaluating the form INITIAL-VALUE as if the `defvar' form were instead the form `(define identifier initial-value)' . If IDENTIFIER already has a - value, then INITIAL-VALUE is *not* evaluated and IDENTIFIER's + value, then INITIAL-VALUE is _not_ evaluated and IDENTIFIER's value is not changed. `defconst' is valid only when used at top-level. - - Special Form: defconst IDENTIFIER VALUE + - Special Form: defconst identifier value If IDENTIFIER is unbound in the top level environment, then IDENTIFIER is `define'd to the result of evaluating the form VALUE as if the `defconst' form were instead the form `(define identifier value)' . If IDENTIFIER already has a value, then - VALUE is *not* evaluated, IDENTIFIER's value is not changed, and + VALUE is _not_ evaluated, IDENTIFIER's value is not changed, and an error is signaled. `defconst' is valid only when used at top-level. - - Special Form: set! (VARIABLE1 VARIABLE2 ...) <expression> + - Special Form: set! (variable1 variable2 ...) <expression> The identifiers VARIABLE1, VARIABLE2, ... must be bound either in some region enclosing the `set!' expression or at top level. @@ -2685,12 +2837,12 @@ supported for Posix shell-scripts (*note Scripting::.). (define x 2) (define y 3) (+ x y) => 5 - (set! (x y) (list 4 5)) => *unspecified* + (set! (x y) (list 4 5)) => _unspecified_ (+ x y) => 9 - - Special Form: casev KEY CLAUSE1 CLAUSE2 ... - `casev' is an extension of standard Scheme `case': Each CLAUSE of - a `casev' statement must have as first element a list containing + - Special Form: qase key clause1 clause2 ... | + `qase' is an extension of standard Scheme `case': Each CLAUSE of a | + `qase' statement must have as first element a list containing | elements which are: * literal datums, or @@ -2700,7 +2852,7 @@ supported for Posix shell-scripts (*note Scripting::.). * a comma followed by an at-sign (@) followed by the name of a symbolic constant whose value is a list. - A `casev' statement is equivalent to a `case' statement in which + A `qase' statement is equivalent to a `case' statement in which | these symbolic constants preceded by commas have been replaced by the values of the constants, and all symbolic constants preceded by comma-at-signs have been replaced by the elements of the list @@ -2709,19 +2861,19 @@ supported for Posix shell-scripts (*note Scripting::.). unquoted expressions must be "symbolic constants". Symbolic constants are defined using `defconst', their values are - substituted in the head of each `casev' clause during macro + substituted in the head of each `qase' clause during macro | expansion. `defconst' constants should be defined before use. - `casev' can be substituted for any correct use of `case'. + `qase' can be substituted for any correct use of `case'. | (defconst unit '1) (defconst semivowels '(w y)) - (casev (* 2 3) + (qase (* 2 3) | ((2 3 5 7) 'prime) ((,unit 4 6 8 9) 'composite)) ==> composite - (casev (car '(c d)) + (qase (car '(c d)) | ((a) 'a) - ((b) 'b)) ==> *unspecified* - (casev (car '(c d)) + ((b) 'b)) ==> _unspecified_ + (qase (car '(c d)) | ((a e i o u) 'vowel) ((,@semivowels) 'semivowel) (else 'consonant)) ==> consonant @@ -2731,13 +2883,85 @@ SCM also supports the following constructs from Common Lisp: `defmacro', `macroexpand', `macroexpand-1', and `gentemp'. *Note Defmacro: (slib)Defmacro. +SCM `defmacro' is extended over that described for SLIB: + + (defmacro (macro-name . arguments) body) + +is equivalent to + + (defmacro macro-name arguments body) + +As in Common Lisp, an element of the formal argument list for +`defmacro' may be a possibly nested list, in which case the +corresponding actual argument must be a list with as many members as the +formal argument. Rest arguments are indicated by improper lists, as in +Scheme. It is an error if the actual argument list does not have the +tree structure required by the formal argument list. + +For example: + + (defmacro (let1 ((name value)) . body) + `((lambda (,name) ,@body) ,value)) + + (let1 ((x (foo))) (print x) x) == ((lambda (x) (print x) x) (foo)) + + (let1 not legal syntax) error--> not "does not match" ((name value)) + +SCM supports [R5RS] `syntax-rules' macros *Note Macros: (r5rs)Macros. + +The pattern language is extended by the syntax `(... <obj>)', which is | +identical to `<obj>' except that ellipses in `<obj>' are treated as | +ordinary identifiers in a template, or as literals in a pattern. In | +particular, `(... ...)' quotes the ellipsis token `...' in a pattern or | +template. | + +For example: + (define-syntax check-tree + (syntax-rules () + ((_ (?pattern (... ...)) ?obj) + (let loop ((obj ?obj)) + (or (null? obj) + (and (pair? obj) + (check-tree ?pattern (car obj)) + (loop (cdr obj)))))) + ((_ (?first . ?rest) ?obj) + (let ((obj ?obj)) + (and (pair? obj) + (check-tree ?first (car obj)) + (check-tree ?rest (cdr obj))))) + ((_ ?atom ?obj) #t))) + + (check-tree ((a b) ...) '((1 2) (3 4) (5 6))) => #t + + (check-tree ((a b) ...) '((1 2) (3 4) not-a-2list) => #f + +Note that although the ellipsis is matched as a literal token in the +defined macro it is not included in the literals list for +`syntax-rules'. + +The pattern language is also extended to support identifier macros. A +reference to an identifier macro keyword that is not the first +identifier in a form may expand into Scheme code, rather than raising a +"keyword as variable" error. The pattern for expansion of such a bare +macro keyword is a single identifier, as in other syntax rules the +identifier is ignored. + +For example: + (define-syntax eight + (syntax-rules () + (_ 8))) + + (+ 3 eight) => 11 + (eight) => ERROR + (set! eight 9) => ERROR + File: scm.info, Node: Low Level Syntactic Hooks, Next: Syntactic Hooks for Hygienic Macros, Prev: Syntax Extensions, Up: The Language Low Level Syntactic Hooks ========================= - - Callback procedure: read:sharp C PORT + - Callback procedure: read:sharp c port If a <#> followed by a character (for a non-standard syntax) is encountered by `read', `read' will call the value of the symbol `read:sharp' with arguments the character and the port being read @@ -2747,7 +2971,7 @@ Low Level Syntactic Hooks whitespace. `#<unspecified>' is the value returned by the expression `(if #f #f)'. - - Callback procedure: read:sharp-char TOKEN + - Callback procedure: read:sharp-char token If the sequence <#\> followed by a non-standard character name is encountered by `read', `read' will call the value of the symbol `read:sharp-char' with the token (a string of length at least two) @@ -2755,19 +2979,20 @@ Low Level Syntactic Hooks be the value of `read' for this expression, otherwise an error will be signaled. -*Note:* When adding new <#> syntaxes, have your code save the previous +_Note:_ When adding new <#> syntaxes, have your code save the previous value of `read:sharp' or `read:sharp-char' when defining it. Call this saved value if an invocation's syntax is not recognized. This will allow `#+', `#-', `#!', and *Note Uniform Array::s to still be supported (as they use `read:sharp'). - - Function: procedure->syntax PROC + - Function: procedure->syntax proc Returns a "macro" which, when a symbol defined to this value appears as the first symbol in an expression, returns the result of applying PROC to the expression and the environment. - - Function: procedure->macro PROC - - Function: procedure->memoizing-macro PROC + - Function: procedure->macro proc + - Function: procedure->memoizing-macro proc + - Function: procedure->identifier-macro Returns a "macro" which, when a symbol defined to this value appears as the first symbol in an expression, evaluates the result of applying PROC to the expression and the environment. The value @@ -2775,30 +3000,72 @@ supported (as they use `read:sharp'). `PROCEDURE->MEMOIZING-MACRO' replaces the form passed to PROC. For example: - (define trace + (defsyntax trace | (procedure->macro (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x)))))) (trace foo) == (set! foo (tracef foo 'foo)). - - Function: environment->tree ENV - An "environment" is an opaque object representing lexical bindings. - `environment->tree' returns a representation of the environment - ENV as a list of environment frames. There are 2 types of - environment frames: + `PROCEDURE->IDENTIFIER-MACRO' is similar to + `PROCEDURE->MEMOIZING-MACRO' except that PROC is also called in + case the symbol bound to the macro appears in an expression but + _not_ as the first symbol, that is, when it looks like a variable + reference. In that case, the form passed to PROC is a single + identifier. + + + - Special Form: defsyntax name expr | + Defines NAME as a macro keyword bound to the result of evaluating | + EXPR, which should be a macro. Using `define' for this purpose | + may not result in NAME being interpreted as a macro keyword. | + | +An "environment" is a list of frames representing lexical bindings. | +Only the names and scope of the bindings are included in environments | +passed to macro expanders - run-time values are not included. | + | +There are several types of environment frames: | - `((lambda (variable1 ...) ...) value1 ...)' - `(let ((variable1 value1) (variable2 value2) ...) ...)' - `(letrec ((variable1 value1) ...) ...)' - result in a single enviroment frame: - ((variable1 ...) value1 ...) +`((lambda (variable1 ...) ...) value1 ...)' +`(let ((variable1 value1) (variable2 value2) ...) ...)' +`(letrec ((variable1 value1) ...) ...)' + result in a single enviroment frame: + | + (variable1 variable2 ...) | - `(let ((variable1 value1)) ...)' - `(let* ((variable1 value1) ...) ...)' - result in an environment frame for each variable: - (variable1 . value1) (variable2 . value2) ... +`(let ((variable1 value1)) ...)' +`(let* ((variable1 value1) ...) ...)' + result in an environment frame for each variable: + | + variable1 variable2 ... | + | +`(let-syntax ((key1 macro1) (key2 macro2)) ...)' | +`(letrec-syntax ((key1 value1) (key2 value2)) ...)' | + Lexically bound macros result in environment frames consisting of | + a marker and an alist of keywords and macro objects: | + | + (<env-syntax-marker> (key1 . value1) (key2 . value2)) | + Currently <env-syntax-marker> is the integer 6. | + | +`line numbers' | + Line numbers (*note Line Numbers::) may be included in the | + environment as frame entries to indicate the line number on which | + a function is defined. They are ignored for variable lookup. | + | + #<line 8> | + | +`miscellaneous' | + Debugging information is stored in environments in a plist format: | + Any exact integer stored as an environment frame may be followed | + by any value. The two frame entries are ignored when doing | + variable lookup. Load file names, procedure names, and closure | + documentation strings are stored in this format. | + | + <env-filename-marker> "foo.scm" <env-procedure-name-marker> foo ... | + | + Currently <env-filename-marker> is the integer 1 and | + <env-procedure-name-marker> the integer 2. | - - Special Form: @apply PROCEDURE ARGUMENT-LIST + - Special Form: @apply procedure argument-list Returns the result of applying PROCEDURE to ARGUMENT-LIST. `@apply' differs from `apply' when the identifiers bound by the closure being applied are `set!'; setting affects ARGUMENT-LIST. @@ -2810,13 +3077,6 @@ supported (as they use `read:sharp'). Thus a mutable environment can be treated as both a list and local bindings. - - Special Form: @call-with-current-continuation PROCEDURE - Returns the result of applying PROCEDURE to the current - continuation. A "continuation" is a SCM object of type `contin' - (*note Continuations::.). The procedure - `(call-with-current-continuation PROCEDURE)' is defined to have - the same effect as `(@call-with-current-continuation procedure)'. - File: scm.info, Node: Syntactic Hooks for Hygienic Macros, Prev: Low Level Syntactic Hooks, Up: The Language @@ -2827,9 +3087,9 @@ SCM provides a synthetic identifier type for efficient implementation of hygienic macros (for example, `syntax-rules' *note Macros: (r5rs)Macros.) A synthetic identifier may be inserted in Scheme code by a macro expander in any context where a symbol would normally be used. -Collectively, symbols and synthetic identifiers are *identifiers*. +Collectively, symbols and synthetic identifiers are _identifiers_. - - Function: identifier? OBJ + - Function: identifier? obj Returns `#t' if OBJ is a symbol or a synthetic identifier, and `#f' otherwise. @@ -2842,7 +3102,7 @@ environment which has been passed to a "macro expander" (a procedure passed as an argument to `procedure->macro', `procedure->memoizing-macro', or `procedure->syntax'). - - Function: renamed-identifier PARENT ENV + - Function: renamed-identifier parent env Returns a synthetic identifier. PARENT must be an identifier, and ENV must either be `#f' or a lexical environment passed to a macro expander. `renamed-identifier' returns a distinct object for each @@ -2853,7 +3113,7 @@ identifier, those data are used during variable lookup. If a synthetic identifier is inserted as quoted data then during macro expansion it will be repeatedly replaced by its parent, until a symbol is obtained. - - Function: identifier->symbol ID + - Function: identifier->symbol id Returns the symbol obtained by recursively extracting the parent of ID, which must be an identifier. @@ -2868,7 +3128,8 @@ Use of synthetic identifiers If an identifier returned by this version of `gentemp' is inserted in a binding position as the name of a variable then it is guaranteed that -no other identifier may denote that variable. If an identifier +no other identifier (except one produced by passing the first to +`renamed-identifier') may denote that variable. If an identifier returned by `gentemp' is inserted free, then it will denote the top-level value bound to its parent, the symbol named "An unlikely variable". This behavior, of course, is meant to be put to good use: @@ -2890,31 +3151,25 @@ In other words, we can avoid capturing `foo'. If a lexical environment is passed as the second argument to `renamed-identifier' then if the identifier is inserted free its parent will be looked up in that environment, rather than in the top-level -environment. The use of such an identifier *must* be restricted to the +environment. The use of such an identifier _must_ be restricted to the lexical scope of its environment. There is another restriction imposed for implementation convenience: Macros passing their lexical environments to `renamed-identifier' may -be lexically bound only by the special forms `@let-syntax' or -`@letrec-syntax'. No error is signaled if this restriction is not met, +be lexically bound only by the special forms `let-syntax' or | +`letrec-syntax'. No error is signaled if this restriction is not met, | but synthetic identifier lookup will not work properly. - - - Special Form: @let-syntax - - Special Form: @letrec-syntax - Behave as `let' and `letrec', but may also put extra information - in the lexical environment so that `renamed-identifier' will work - properly during expansion of the macros bound by these forms. - + | In order to maintain referential transparency it is necessary to determine whether two identifiers have the same denotation. With synthetic identifiers it is not necessary that two identifiers be `eq?' in order to denote the same binding. - - Function: identifier-equal? ID1 ID2 ENV + - Function: identifier-equal? id1 id2 env Returns `#t' if identifiers ID1 and ID2 denote the same binding in - lexical environment ENV, and `#f' otherwise. ENV must be a + lexical environment ENV, and `#f' otherwise. ENV must either be a lexical environment passed to a macro transformer during macro - expansion. + expansion or the empty list. For example, (define top-level-foo? @@ -2928,13 +3183,13 @@ in order to denote the same binding. (let ((foo 'local)) (top-level-foo? foo)) => #f - - Function: @macroexpand1 EXPR ENV + - Function: @macroexpand1 expr env If the `car' of EXPR denotes a macro in ENV, then if that macro is a primitive, EXPR will be returned, if the macro was defined in Scheme, then a macro expansion will be returned. If the `car' of EXPR does not denote a macro, the `#f' is returned. - - Function: extended-environment NAMES VALUES ENV + - Function: extended-environment names values env Returns a new environment object, equivalent to ENV, which must either be an environment object or null, extended by one frame. NAMES must be an identifier, or an improper list of identifiers, @@ -2944,13 +3199,13 @@ in order to denote the same binding. list then VALS may be, respectively, any object or an improper list of objects. - - Special Form: syntax-quote OBJ + - Special Form: syntax-quote obj Synthetic identifiers are converted to their parent symbols by `quote' and `quasiquote' so that literal data in macro definitions will be properly transcribed. `syntax-quote' behaves like `quote', but preserves synthetic identifier intact. - - Special Form: the-macro MAC + - Special Form: the-macro mac `the-macro' is the simplest of all possible macro transformers: MAC may be a syntactic keyword (macro name) or an expression evaluating to a macro, otherwise an error is signaled. MAC is @@ -2963,18 +3218,18 @@ in order to denote the same binding. ;; code that will continue to work even if LET is redefined. ...) - - Special Form: renaming-transformer PROC + - Special Form: renaming-transformer proc A low-level "explicit renaming" macro facility very similar to that proposed by W. Clinger [Exrename] is supported. Syntax may be defined in `define-syntax', `let-syntax', and `letrec-syntax' using `renaming-transformer' instead of `syntax-rules'. PROC should evaluate to a procedure accepting three arguments: EXPR, - RENAME, and COMPARE. EXPR is a representation of Scheme code to be - expanded, as list structure. RENAME is a procedure accepting an - identifier and returning an identifier renamed in the definition - environment of the new syntax. COMPARE accepts two identifiers - and returns true if and only if both denote the same binding in - the usage environment of the new syntax. + RENAME, and COMPARE. EXPR is a representation of Scheme code to + be expanded, as list structure. RENAME is a procedure accepting + an identifier and returning an identifier renamed in the + definition environment of the new syntax. COMPARE accepts two + identifiers and returns true if and only if both denote the same + binding in the usage environment of the new syntax. File: scm.info, Node: Packages, Next: The Implementation, Prev: The Language, Up: Top @@ -2983,14 +3238,15 @@ Packages ******** * Menu: - -* Compiling And Linking:: Hobbit + | * Dynamic Linking:: * Dump:: Create Fast-Booting Executables * Numeric:: Numeric Language Extensions * Arrays:: As in APL +* Records:: Define new aggregate data types | * I/O-Extensions:: i/o-extensions * Posix Extensions:: posix +* Unix Extensions:: non-posix unix | * Regular Expression Pattern Matching:: regex * Line Editing:: edit-line * Curses:: Screen Control @@ -2999,57 +3255,11 @@ Packages * Menu: * Xlib: (Xlibscm). X Window Graphics. +* Hobbit: (hobbit). Scheme-to-C Compiler. | -File: scm.info, Node: Compiling And Linking, Next: Dynamic Linking, Prev: Packages, Up: Packages - -Compiling And Linking -===================== - - - Function: compile-file NAME1 NAME2 ... - If the HOBBIT compiler is installed in the - `(implementation-vicinity)', compiles the files NAME1 NAME2 ... to - an object file name NAME1<object-suffix>, where <object-suffix> is - the object file suffix for your computer (for instance, `.o'). - NAME1 must be in the current directory; NAME2 ... can be in other - directories. - - - Function: link-named-scm NAME MODULE1 ... - Creates a new SCM executable with name NAME. NAME will include - the object modules MODULE1 ... which can be produced with - `compile-file'. - - cd ~/scm/ - scm -e'(link-named-scm"cute""cube")' - (delete-file "scmflags.h") - (call-with-output-file - "scmflags.h" - (lambda (fp) - (for-each - (lambda (string) (write-line string fp)) - '("#define IMPLINIT \"/home/jaffer/scm/Init5d2.scm\"" | - "#define COMPILED_INITS init_cube();" - "#define BIGNUMS" - "#define FLOATS" - "#define ARRAYS")))) - (system "gcc -Wall -O2 -c continue.c findexec.c time.c - repl.c scl.c eval.c sys.c subr.c unif.c rope.c scm.c") - ... - scm.c: In function `scm_init_extensions': - scm.c:95: warning: implicit declaration of function `init_cube' - scm.c: In function `scm_cat_path': - scm.c:589: warning: implicit declaration of function `realloc' - scm.c:594: warning: implicit declaration of function `malloc' - scm.c: In function `scm_try_path': - scm.c:612: warning: implicit declaration of function `free' - (system "cc -o cute continue.o findexec.o time.o repl.o scl.o - eval.o sys.o subr.o unif.o rope.o scm.o cube.o -lm -lc") - - Compilation finished at Sun Jul 21 00:59:17 - - -File: scm.info, Node: Dynamic Linking, Next: Dump, Prev: Compiling And Linking, Up: Packages - +File: scm.info, Node: Dynamic Linking, Next: Dump, Prev: Packages, Up: Packages + | Dynamic Linking =============== @@ -3057,24 +3267,24 @@ If SCM has been compiled with `dynl.c' then the additional properties of load and ([SLIB]) require specified here are supported. The `require' form is preferred. - - Function: require FEATURE + - Function: require feature If the symbol FEATURE has not already been given as an argument to `require', then the object and library files associated with FEATURE will be dynamically-linked, and an unspecified value returned. If FEATURE is not found in `*catalog*', then an error is signaled. - - Function: usr:lib LIB + - Function: usr:lib lib Returns the pathname of the C library named LIB. For example: `(usr:lib "m")' returns `"/usr/lib/libm.a"', the path of the C math library. - - Function: x:lib LIB + - Function: x:lib lib Returns the pathname of the X library named LIB. For example: `(x:lib "X11")' returns `"/usr/X11/lib/libX11.sa"', the path of the X11 library. - - Function: load FILENAME LIB1 ... + - Function: load filename lib1 ... In addition to the [R5RS] requirement of loading Scheme expressions if FILENAME is a Scheme source file, `load' will also dynamically load/link object files (produced by `compile-file', for @@ -3103,7 +3313,7 @@ of load and ([SLIB]) require specified here are supported. The or (require 'turtle-graphics) And the string regular expression (*note Regular Expression - Pattern Matching::.) package is linked by: + Pattern Matching::) package is linked by: (load (in-vicinity (implementation-vicinity) "rgx") (usr:lib "c")) or @@ -3113,7 +3323,7 @@ The following functions comprise the low-level Scheme interface to dynamic linking. See the file `Link.scm' in the SCM distribution for an example of their use. - - Function: dyn:link FILENAME + - Function: dyn:link filename FILENAME should be a string naming an "object" or "archive" file, the result of C-compiling. The `dyn:link' procedure links and loads FILENAME into the current SCM session. If successfull, @@ -3121,7 +3331,7 @@ an example of their use. second argument to `dyn:call'. If not successful, `#f' is returned. - - Function: dyn:call NAME LINK-TOKEN + - Function: dyn:call name link-token LINK-TOKEN should be the value returned by a call to `dyn:link'. NAME should be the name of C function of no arguments defined in the file named FILENAME which was succesfully `dyn:link'ed in the @@ -3133,7 +3343,7 @@ an example of their use. SCM object files. The init_... function then makes the identifiers defined in the file accessible as Scheme procedures. - - Function: dyn:main-call NAME LINK-TOKEN ARG1 ... + - Function: dyn:main-call name link-token arg1 ... LINK-TOKEN should be the value returned by a call to `dyn:link'. NAME should be the name of C function of 2 arguments, `(int argc, char **argv)', defined in the file named FILENAME which was @@ -3145,10 +3355,10 @@ an example of their use. `dyn:main-call' can be used to call a `main' procedure from SCM. For example, I link in and `dyn:main-call' a large C program, the - low level routines of which callback (*note Callbacks::.) into SCM + low level routines of which callback (*note Callbacks::) into SCM (which emulates PCI hardware). - - Function: dyn:unlink LINK-TOKEN + - Function: dyn:unlink link-token LINK-TOKEN should be the value returned by a call to `dyn:link'. The `dyn:unlink' procedure removes the previously loaded file from the current SCM session. If successful, `dyn:unlink' returns @@ -3170,10 +3380,10 @@ There are constraints on which sessions are savable using `dump' * Saved continuations are invalid in subsequent invocations; they cause segmentation faults and other unpleasant side effects. - * Although DLD (*note Dynamic Linking::.) can be used to load - compiled modules both before and after dumping, `SUN_DL' ELF - systems can load compiled modules only after dumping. This can be - worked around by compiling in those features you wish to `dump'. + * Although DLD (*note Dynamic Linking::) can be used to load compiled + modules both before and after dumping, `SUN_DL' ELF systems can + load compiled modules only after dumping. This can be worked + around by compiling in those features you wish to `dump'. * Ports (other than `current-input-port', `current-output-port', `current-error-port'), X windows, etc. are invalid in subsequent @@ -3186,17 +3396,17 @@ There are constraints on which sessions are savable using `dump' * `Dump' can be called from the command line. - - Function: dump NEWPATH - - Function: dump NEWPATH #F - - Function: dump NEWPATH #T - - Function: dump NEWPATH THUNK + - Function: dump newpath + - Function: dump newpath #f + - Function: dump newpath #t + - Function: dump newpath thunk * Calls `gc'. * Creates an executable program named NEWPATH which continues the state of the current SCM session when invoked. The optional argument THUNK, if provided, should be a procedure - of no arguments. This procedure will be called in the - restored executable. + of no arguments; BOOT-TAIL will be set to this procedure, | + causing it to be called in the restored executable. | If the optional argument is missing or a boolean, SCM's standard command line processing will be called in the @@ -3216,18 +3426,15 @@ There are constraints on which sessions are savable using `dump' *INTERACTIVE*. `dump' returns an unspecified value. When a dumped executable is invoked, the variable *INTERACTIVE* (*note -Internal State::.) has the value it possessed when `dump' created it. +Internal State::) has the value it possessed when `dump' created it. Calling `dump' with a single argument sets *INTERACTIVE* to `#f', which is the state it has at the beginning of command line processing. The procedure `program-arguments' returns the command line arguments for the curent invocation. More specifically, `program-arguments' for -the restored session are *not* saved from the dumping session. Command +the restored session are _not_ saved from the dumping session. Command line processing is done on the value of the identifier `*argv*'. - -The thunk `boot-tail' is called by SCM to process command line -arguments. `dump' sets `boot-tail' to the THUNK it is called with. - + | The following example shows how to create `rscm', which is like regular scm, but which loads faster and has the `random' package alreadly provided. @@ -3244,7 +3451,7 @@ provided. bash$ This task can also be accomplished using the `-o' command line option -(*note SCM Options::.). +(*note SCM Options::). bash$ scm -rrandom -o rscm > (quit) @@ -3268,53 +3475,63 @@ Numeric - Constant: most-negative-fixnum The immediate integer closest to negative infinity. + - Constant: $pi + - Constant: pi + The ratio of the circumference to the diameter of a circle. + These procedures augment the standard capabilities in *Note Numerical operations: (r5rs)Numerical operations. - - Function: sinh Z - - Function: cosh Z - - Function: tanh Z + - Function: pi* z + `(* pi Z)' + + - Function: pi/ z + `(/ pi Z)' + + - Function: sinh z + - Function: cosh z + - Function: tanh z Return the hyperbolic sine, cosine, and tangent of Z - - Function: asinh Z - - Function: acosh Z - - Function: atanh Z + - Function: asinh z + - Function: acosh z + - Function: atanh z Return the inverse hyperbolic sine, cosine, and tangent of Z - - Function: $sqrt X - - Function: $abs X - - Function: $exp X - - Function: $log X - - Function: $sin X - - Function: $cos X - - Function: $tan X - - Function: $asin X - - Function: $acos X - - Function: $atan X - - Function: $sinh X - - Function: $cosh X - - Function: $tanh X - - Function: $asinh X - - Function: $acosh X - - Function: $atanh X + - Function: $sqrt x + - Function: $abs x + - Function: $exp x + - Function: $log x + - Function: $sin x + - Function: $cos x + - Function: $tan x + - Function: $asin x + - Function: $acos x + - Function: $atan x + - Function: $sinh x + - Function: $cosh x + - Function: $tanh x + - Function: $asinh x + - Function: $acosh x + - Function: $atanh x Real-only versions of these popular functions. The argument X must be a real number. It is an error if the value which should be - returned by a call to these procedures is *not* real. + returned by a call to these procedures is _not_ real. - - Function: $log10 X + - Function: $log10 x Real-only base 10 logarithm. - - Function: $atan2 Y X + - Function: $atan2 y x Computes `(angle (make-rectangular x y))' for real numbers Y and X. - - Function: $expt X1 X2 + - Function: $expt x1 x2 Returns real number X1 raised to the real power X2. It is an error if the value which should be returned by a call to `$expt' is not real. -File: scm.info, Node: Arrays, Next: I/O-Extensions, Prev: Numeric, Up: Packages - +File: scm.info, Node: Arrays, Next: Records, Prev: Numeric, Up: Packages + | Arrays ====== @@ -3350,24 +3567,24 @@ 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: array? OBJ + - Function: array? obj Returns `#t' if the OBJ is an array, and `#f' if not. - - Function: make-array INITIAL-VALUE BOUND1 BOUND2 ... + - Function: make-array initial-value bound1 bound2 ... Creates and returns an array that has as many dimensions as there are BOUNDs and fills it with INITIAL-VALUE. - - Function: array-ref ARRAY INDEX1 INDEX2 ... + - Function: array-ref array index1 index2 ... Returns the INDEX1, INDEX2, ...'th element of ARRAY. - - Function: array-in-bounds? ARRAY INDEX1 INDEX2 ... + - Function: array-in-bounds? array index1 index2 ... Returns `#t' if its arguments would be acceptable to ARRAY-REF. - - Function: array-set! ARRAY NEW-VALUE INDEX1 INDEX2 ... + - Function: array-set! array new-value index1 index2 ... Sets the INDEX1, INDEX2, ...'th element of ARRAY to NEW-VALUE. The value returned by `array-set!' is unspecified. - - Function: make-shared-array ARRAY MAPPER BOUND1 BOUND2 ... + - 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 @@ -3382,7 +3599,7 @@ a single integer. So (make-shared-array fred (lambda (i j) (list (+ 3 i) (+ 3 j))) 2 2)) (array-ref freds-center 0 0) => foo - - Function: transpose-array ARRAY DIM0 DIM1 ... + - Function: transpose-array array dim0 dim1 ... Returns an array sharing contents with ARRAY, but with dimensions arranged in a different order. There must be one DIM argument for each dimension of ARRAY. DIM0, DIM1, ... should be integers @@ -3400,7 +3617,7 @@ a single integer. So (transpose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1 1 0) => #2A((a 4) (b 5) (c 6)) - - Function: enclose-array ARRAY DIM0 DIM1 ... + - Function: enclose-array array dim0 dim1 ... DIM0, DIM1 ... should be nonnegative integers less than the rank of ARRAY. ENCLOSE-ARRAY returns an array resembling an array of shared arrays. The dimensions of each shared array are the same @@ -3421,51 +3638,50 @@ a single integer. So (enclose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1 0) => #<enclosed-array #2A((a 1) (d 4)) #2A((b 2) (e 5)) #2A((c 3) (f 6))> - - Function: array-shape ARRAY + - Function: array-shape array Returns a list of inclusive bounds of integers. (array-shape (make-array 'foo '(-1 3) 5)) => ((-1 3) (0 4)) - - Function: array-dimensions ARRAY + - 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: + elements with a `0' minimum with one greater than the maximum. So: (array-dimensions (make-array 'foo '(-1 3) 5)) => ((-1 3) 5) - - Function: array-rank OBJ + - Function: array-rank obj Returns the number of dimensions of OBJ. If OBJ is not an array, `0' is returned. - - Function: array->list ARRAY + - Function: array->list array Returns a list consisting of all the elements, in order, of ARRAY. In the case of a rank-0 array, returns the single element. - - Function: array-copy! SOURCE DESTINATION + - 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. - - Function: serial-array-copy! SOURCE DESTINATION + - Function: serial-array-copy! source destination Same as `array-copy!' but guaranteed to copy in row-major order. - - Function: array-fill! ARRAY FILL + - Function: array-fill! array fill Stores FILL in every element of ARRAY. The value returned is unspecified. - - Function: array-equal? ARRAY0 ARRAY1 ... + - Function: array-equal? array0 array1 ... Returns `#t' iff all arguments are arrays with the same shape, the same type, and have corresponding elements which are either `equal?' or `array-equal?'. This function differs from `equal?' in that a one dimensional shared array may be ARRAY-EQUAL? but not EQUAL? to a vector or uniform vector. - - Function: array-contents ARRAY - - Function: array-contents ARRAY STRICT + - Function: array-contents array + - Function: array-contents array strict If ARRAY may be "unrolled" into a one dimensional shared array without changing their order (last subscript changing fastest), then `array-contents' returns that shared array, otherwise it - returns `#f'. All arrays made by MAKE-ARRAY and - MAKE-UNIFORM-ARRAY may be unrolled, some arrays made by - MAKE-SHARED-ARRAY may not be. + returns `#f'. All arrays made by MAKE-ARRAY and CREATE-ARRAY may | + be unrolled, some arrays made by MAKE-SHARED-ARRAY may not be. | If the optional argument STRICT is provided, a shared array will be returned only if its elements are stored internally contiguous @@ -3479,7 +3695,7 @@ Array Mapping `(require 'array-for-each)' - - Function: array-map! ARRAY0 PROC ARRAY1 ... + - Function: array-map! array0 proc array1 ... If ARRAY1, ... are arrays, they 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. If they @@ -3491,15 +3707,15 @@ Array Mapping unspecified. - - Function: serial-array-map! ARRAY0 PROC ARRAY1 ... + - Function: serial-array-map! array0 proc array1 ... Same as ARRAY-MAP!, but guaranteed to apply PROC in row-major order. - - Function: array-for-each PROC ARRAY0 ... + - 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-index-map! ARRAY PROC + - 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. @@ -3511,11 +3727,11 @@ Array Mapping ra)) Another example: (define (apl:index-generator n) - (let ((v (make-uniform-vector n 1))) + (let ((v (make-vector n 1))) | (array-index-map! v (lambda (i) i)) v)) - - Function: scalar->array SCALAR ARRAY PROTOTYPE + - Function: scalar->array scalar array prototype Returns a uniform array of the same shape as ARRAY, having only one shared element, which is `eqv?' to SCALAR. If the optional argument PROTOTYPE is supplied it will be used as the prototype @@ -3535,59 +3751,51 @@ same type. Uniform vectors occupy less storage than conventional vectors. Uniform Array procedures also work on vectors, uniform-vectors, bit-vectors, and strings. -PROTOTYPE arguments in the following procedures are interpreted -according to the table: - - prototype type display prefix - - #t boolean (bit-vector) #At - #\a char (string) #A\ - integer >0 unsigned integer #Au - integer <0 signed integer #Ae - 1.0 float (single precision) #Aif - 1/3 double (double precision float) #Aid - +i complex (double precision) #Aic - () conventional vector #A +SLIB now supports uniform arrys. The primary array creation procedure | +is `create-array', detailed in *Note Arrays: (slib)Arrays. | Unshared uniform character 0-based arrays of rank 1 (dimension) are equivalent to (and can't be distinguished from) strings. - (make-uniform-array #\a 3) => "$q2" + (create-array "" 3) => "$q2" | Unshared uniform boolean 0-based arrays of rank 1 (dimension) are equivalent to (and can't be distinguished from) *Note bit-vectors: Bit Vectors. - (make-uniform-array #t 3) => #*000 + (create-array '#at() 3) => #*000 | == #At(#f #f #f) => #*000 == #1At(#f #f #f) => #*000 -Other uniform vectors are written in a form similar to that of general -arrays, except that one or more modifying characters are put between -the #\A character and the contents list. For example, `'#Ae(3 5 9)' -returns a uniform vector of signed integers. +PROTOTYPE arguments in the following procedures are interpreted | +according to the table: | - - Function: uniform-vector-ref UVE INDEX - Returns the element at the INDEX element in UVE. - - - Function: uniform-vector-set! UVE INDEX NEW-VALUE - Sets the element at the INDEX element in UVE to NEW-VALUE. The - value returned by `uniform-vector-set!' is unspecified. + prototype type display prefix | + + () conventional vector #a | + +64i complex (double precision) #ac64 | + 64.0 double (double precision) #ar64 | + 32.0 float (single precision) #ar32 | + 32 unsigned integer (32-bit) #au32 | + -32 signed integer (32-bit) #as32 | + -16 signed integer (16-bit) #as16 | + #\a char (string) #a\ | + #t boolean (bit-vector) #at | + | +Other uniform vectors are written in a form similar to that of general | +arrays, except that one or more modifying characters are put between the | +#\A character and the contents list. For example, `'#As32(3 5 9)' | +returns a uniform vector of signed integers. | - - Function: array? OBJ PROTOTYPE + - Function: array? obj prototype Returns `#t' if the OBJ is an array of type corresponding to PROTOTYPE, and `#f' if not. - - - Function: make-uniform-array PROTOTYPE BOUND1 BOUND2 ... - Creates and returns a uniform array of type corresponding to - PROTOTYPE that has as many dimensions as there are BOUNDs. - - - Function: array-prototype ARRAY + | + - Function: array-prototype array Returns an object that would produce an array of the same type as - ARRAY, if used as the PROTOTYPE for `make-uniform-array'. + ARRAY, if used as the PROTOTYPE for `list->uniform-array'. | - - Function: list->uniform-array RANK PROT LST - - Function: list->uniform-vector PROT LST + - Function: list->uniform-array rank prot lst | Returns a uniform array of the type indicated by prototype PROT with elements the same as those of LST. Elements must be of the appropriate type, no coercions are done. @@ -3600,26 +3808,19 @@ returns a uniform vector of signed integers. If RANK is zero, LST, which need not be a list, is the single element of the returned array. - - Function: uniform-vector-fill! UVE FILL + - Function: uniform-vector-fill! uve fill Stores FILL in every element of UVE. The value returned is unspecified. - - - Function: uniform-vector-length UVE - Returns the number of elements in UVE. - - - Function: dimensions->uniform-array DIMS PROTOTYPE FILL - - Function: dimensions->uniform-array DIMS PROTOTYPE - - Function: make-uniform-vector LENGTH PROTOTYPE FILL - - Function: make-uniform-vector LENGTH PROTOTYPE + | + - Function: dimensions->uniform-array dims prototype fill + - Function: dimensions->uniform-array dims prototype | Creates and returns a uniform array or vector of type corresponding to PROTOTYPE with dimensions DIMS or length LENGTH. If the FILL argument is supplied, the returned array is filled with this value. - - Function: uniform-array-read! URA - - Function: uniform-array-read! URA PORT - - Function: uniform-vector-read! UVE - - Function: uniform-vector-read! UVE PORT + - Function: uniform-array-read! ura + - Function: uniform-array-read! ura port | Attempts to read all elements of URA, in lexicographic order, as binary objects from PORT. If an end of file is encountered during uniform-array-read! the objects up to that point only are put into @@ -3630,16 +3831,14 @@ returns a uniform vector of signed integers. may be omitted, in which case it defaults to the value returned by `(current-input-port)'. - - Function: uniform-array-write URA - - Function: uniform-array-write URA PORT - - Function: uniform-vector-write UVE - - Function: uniform-vector-write UVE PORT - Writes all elements of URA as binary objects to PORT. The number - of of objects actually written is returned. PORT may be omitted, + - Function: uniform-array-write ura + - Function: uniform-array-write ura port | + Writes all elements of URA as binary objects to PORT. The number + of of objects actually written is returned. PORT may be omitted, in which case it defaults to the value returned by `(current-output-port)'. - - Function: logaref ARRAY INDEX1 INDEX2 ... + - Function: logaref array index1 index2 ... If an INDEX is provided for each dimension of ARRAY returns the INDEX1, INDEX2, ...'th element of ARRAY. If one more INDEX is provided, then the last index specifies bit position of the @@ -3651,7 +3850,7 @@ returns a uniform vector of signed integers. (logaref '#(#b1101 #b0010) 0 1) => #f (logaref '#2((#b1101 #b0010)) 0 0) => #b1101 - - Function: logaset! ARRAY VAL INDEX1 INDEX2 ... + - Function: logaset! array val index1 index2 ... If an INDEX is provided for each dimension of ARRAY sets the INDEX1, INDEX2, ...'th element of ARRAY to VAL. If one more INDEX is provided, then the last index specifies bit position of the @@ -3674,18 +3873,18 @@ prefixed by `#*'. Some of these operations will eventually be generalized to other uniform-arrays. - - Function: bit-count BOOL BV + - Function: bit-count bool bv Returns the number occurrences of BOOL in BV. - - Function: bit-position BOOL BV K + - Function: bit-position bool bv k Returns the minimum index of an occurrence of BOOL in BV which is at least K. If no BOOL occurs within the specified range `#f' is returned. - - Function: bit-invert! BV + - Function: bit-invert! bv Modifies BV by replacing each element with its negation. - - Function: bit-set*! BV UVE BOOL + - Function: bit-set*! bv uve bool If uve is a bit-vector BV and uve must be of the same length. If BOOL is `#t', uve is OR'ed into BV; If BOOL is `#f', the inversion of uve is AND'ed into BV. @@ -3696,25 +3895,47 @@ uniform-arrays. The return value is unspecified. - - Function: bit-count* BV UVE BOOL + - Function: bit-count* bv uve bool Returns (bit-count (bit-set*! (if bool bv (bit-invert! bv)) uve #t) #t). BV is not modified. -File: scm.info, Node: I/O-Extensions, Next: Posix Extensions, Prev: Arrays, Up: Packages - +File: scm.info, Node: Records, Next: I/O-Extensions, Prev: Arrays, Up: Packages + | +Records | +======= | + | +SCM provides user-definable datatypes with the same interface as SLIB, | +see *Note Records: (slib)Records, with the following extension. | + | + - Function: record-printer-set! rtd printer | + Causes records of type RTD to be printed in a user-specified | + format. RTD must be a record type descriptor returned by | + `make-record-type', PRINTER a procedure accepting three arguments: | + the record to be printed, the port to print to, and a boolean | + which is true if the record is being written on behalf of `write' | + and false if for `display'. If PRINTER returns #f, the default | + record printer will be called. | + | + A PRINTER value of #f means use the default printer. | + | + Only the default printer will be used when printing error messages. | + | + +File: scm.info, Node: I/O-Extensions, Next: Posix Extensions, Prev: Records, Up: Packages + | I/O-Extensions ============== If `'i/o-extensions' is provided (by linking in `ioext.o'), *Note Line I/O: (slib)Line I/O, and the following functions are defined: - - Function: stat <PORT-OR-STRING> + - Function: stat <port-or-string> Returns a vector of integers describing the argument. The argument - can be either a string or an open input port. If the argument is an - open port then the returned vector describes the file to which the - port is opened; If the argument is a string then the returned + can be either a string or an open input port. If the argument is + an open port then the returned vector describes the file to which + the port is opened; If the argument is a string then the returned vector describes the file named by that string. If there exists no file with the name string, or if the file cannot be accessed `#f' is returned. The elements of the returned vector are as @@ -3756,60 +3977,67 @@ I/O: (slib)Line I/O, and the following functions are defined: - Function: getpid Returns the process ID of the current process. - - Function: file-position PORT + - Function: file-position port Returns the current position of the character in PORT which will next be read or written. If PORT is not open to a file the result is unspecified. - - Function: file-set-position PORT INTEGER + - Function: file-set-position port integer Sets the current position in PORT which will next be read or written. If PORT is not open to a file the action of `file-set-position' is unspecified. The result of `file-set-position' is unspecified. - - Function: reopen-file FILENAME MODES PORT + - Function: try-create-file name modes perms | + If the file with name NAME already exists, return `#f', otherwise | + try to create and open the file like `try-open-file', *Note Files + and Ports::. If the optional integer argument PERMS is provided, | + it is used as the permissions of the new file (modified by the | + current umask). | + | + - Function: reopen-file filename modes port Closes port PORT and reopens it with FILENAME and MODES. `reopen-file' returns `#t' if successful, `#f' if not. - - Function: duplicate-port PORT MODES + - Function: duplicate-port port modes Creates and returns a "duplicate" port from PORT. Duplicate - *unbuffered* ports share one file position. MODES are as for + _unbuffered_ ports share one file position. MODES are as for *Note open-file: Files and Ports. - - Function: redirect-port! FROM-PORT TO-PORT + - Function: redirect-port! from-port to-port Closes TO-PORT and makes TO-PORT be a duplicate of FROM-PORT. `redirect-port!' returns TO-PORT if successful, `#f' if not. If unsuccessful, TO-PORT is not closed. - - Function: opendir DIRNAME + - Function: opendir dirname Returns a "directory" object corresponding to the file system directory named DIRNAME. If unsuccessful, returns `#f'. - - Function: readdir DIR + - Function: readdir dir Returns the string name of the next entry from the directory DIR. If there are no more entries in the directory, `readdir' returns a `#f'. - - Function: rewinddir DIR + - Function: rewinddir dir Reinitializes DIR so that the next call to `readdir' with DIR will return the first entry in the directory again. - - Function: closedir DIR + - Function: closedir dir Closes DIR and returns `#t'. If DIR is already closed,, `closedir' returns a `#f'. - - Function: directory-for-each PROC DIRECTORY + - Function: directory-for-each proc directory The LISTs must be lists, and PROC must be a procedure taking one argument. `Directory-For-Each' applies PROC to the (string) name of each file in DIRECTORY. The dynamic order in which PROC is applied to the elements of the LISTs is unspecified. The value returned by `directory-for-each' is unspecified. - - Function: directory-for-each PROC DIRECTORY PRED + - Function: directory-for-each proc directory pred Applies PROC only to those filenames for which the procedure PRED returns a non-false value. - - Function: directory-for-each PROC DIRECTORY MATCH + - Function: directory-for-each proc directory match Applies PROC only to those filenames for which `(filename:match?? MATCH)' would return a non-false value (*note Filenames: (slib)Filenames.). @@ -3822,9 +4050,9 @@ I/O: (slib)Line I/O, and the following functions are defined: "Link.scm" "Macro.scm" "Transcen.scm" - "Init5d2.scm" | + "Init5d6.scm" | - - Function: mkdir PATH MODE + - Function: mkdir path mode The `mkdir' function creates a new, empty directory whose name is PATH. The integer argument MODE specifies the file permissions for the new directory. *Note The Mode Bits for Access Permission: @@ -3833,12 +4061,12 @@ I/O: (slib)Line I/O, and the following functions are defined: `mkdir' returns if successful, `#f' if not. - - Function: rmdir PATH + - Function: rmdir path The `rmdir' function deletes the directory PATH. The directory must be empty before it can be removed. `rmdir' returns if successful, `#f' if not. - - Function: chdir FILENAME + - Function: chdir filename Changes the current directory to FILENAME. If FILENAME does not exist or is not a directory, `#f' is returned. Otherwise, `#t' is returned. @@ -3848,33 +4076,33 @@ I/O: (slib)Line I/O, and the following functions are defined: name representing the current working directory. If this string cannot be obtained, `#f' is returned. - - Function: rename-file OLDFILENAME NEWFILENAME + - Function: rename-file oldfilename newfilename Renames the file specified by OLDFILENAME to NEWFILENAME. If the renaming is successful, `#t' is returned. Otherwise, `#f' is returned. - - Function: chmod FILE MODE + - Function: chmod file mode The function `chmod' sets the access permission bits for the file named by FILE to MODE. The FILE argument may be a string containing the filename or a port open to the file. `chmod' returns if successful, `#f' if not. - - Function: utime PATHNAME ACCTIME MODTIME + - Function: utime pathname acctime modtime Sets the file times associated with the file named PATHNAME to have access time ACCTIME and modification time MODTIME. `utime' returns if successful, `#f' if not. - - Function: umask MODE + - Function: umask mode The function `umask' sets the file creation mask of the current process to MASK, and returns the previous value of the file creation mask. - - Function: fileno PORT + - Function: fileno port Returns the integer file descriptor associated with the port PORT. If an error is detected, `#f' is returned. - - Function: access PATHNAME HOW + - Function: access pathname how Returns `#t' if the file named by PATHNAME can be accessed in the way specified by the HOW argument. The HOW argument can be the `logior' of the flags: @@ -3900,8 +4128,8 @@ I/O: (slib)Line I/O, and the following functions are defined: <r> File-is-readable? - - Function: execl COMMAND ARG0 ... - - Function: execlp COMMAND ARG0 ... + - Function: execl command arg0 ... + - Function: execlp command arg0 ... Transfers control to program COMMAND called with arguments ARG0 .... For `execl', COMMAND must be an exact pathname of an executable file. `execlp' searches for COMMAND in the list of @@ -3911,13 +4139,13 @@ I/O: (slib)Line I/O, and the following functions are defined: If successful, this procedure does not return. Otherwise an error message is printed and the integer `errno' is returned. - - Function: execv COMMAND ARGLIST - - Function: execvp COMMAND ARGLIST + - Function: execv command arglist + - Function: execvp command arglist Like `execl' and `execlp' except that the set of arguments to COMMAND is ARGLIST. - - Function: putenv STRING - adds or removes definitions from the "environment". If the STRING + - Function: putenv string + adds or removes definitions from the "environment". If the STRING is of the form `NAME=VALUE', the definition is added to the environment. Otherwise, the STRING is interpreted as the name of an environment variable, and any definition for this variable in @@ -3935,32 +4163,40 @@ I/O: (slib)Line I/O, and the following functions are defined: (slib)System Interface.). -File: scm.info, Node: Posix Extensions, Next: Regular Expression Pattern Matching, Prev: I/O-Extensions, Up: Packages - +File: scm.info, Node: Posix Extensions, Next: Unix Extensions, Prev: I/O-Extensions, Up: Packages + | Posix Extensions ================ If `'posix' is provided (by linking in `posix.o'), the following functions are defined: - - Function: open-pipe STRING MODES + - Function: open-pipe string modes If the string MODES contains an <r>, returns an input port capable of delivering characters from the standard output of the system command STRING. Otherwise, returns an output port capable of receiving characters which become the standard input of the system command STRING. If a pipe cannot be created `#f' is returned. - - Function: open-input-pipe STRING + - Function: open-input-pipe string Returns an input port capable of delivering characters from the standard output of the system command STRING. If a pipe cannot be created `#f' is returned. - - Function: open-output-pipe STRING + - Function: open-output-pipe string Returns an output port capable of receiving characters which become the standard input of the system command STRING. If a pipe cannot be created `#f' is returned. - - Function: close-port PIPE + - Function: broken-pipe port | + If this function is defined at top level, it will be called when an | + output pipe is closed from the other side (this is the condition | + under which a SIGPIPE is sent). The already closed PORT will be | + passed so that any necessary cleanup may be done. An error is not | + signaled when output to a pipe fails in this way, but any further | + output to the closed pipe will cause an error to be signaled. | + | + - Function: close-port pipe Closes the PIPE, rendering it incapable of delivering or accepting characters. This routine has no effect if the pipe has already been closed. The value returned is unspecified. @@ -3982,6 +4218,11 @@ Persona. Returns the process ID of the parent of the current process. For a process's own ID *Note getpid: I/O-Extensions. + - Function: getlogin | + Returns the (login) name of the user logged in on the controlling | + terminal of the process, or #f if this information cannot be | + determined. | + | - Function: getuid Returns the real user ID of this process. @@ -3994,23 +4235,23 @@ Persona. - Function: geteuid Returns the effective user ID of this process. - - Function: setuid ID + - Function: setuid id Sets the real user ID of this process to ID. Returns `#t' if successful, `#f' if not. - - Function: setgid ID + - Function: setgid id Sets the real group ID of this process to ID. Returns `#t' if successful, `#f' if not. - - Function: setegid ID + - Function: setegid id Sets the effective group ID of this process to ID. Returns `#t' if successful, `#f' if not. - - Function: seteuid ID + - Function: seteuid id Sets the effective user ID of this process to ID. Returns `#t' if successful, `#f' if not. - - Function: kill PID SIG + - Function: kill pid sig The `kill' function sends the signal SIGNUM to the process or process group specified by PID. Besides the signals listed in *Note Standard Signals: (libc)Standard Signals, SIGNUM can also @@ -4049,7 +4290,7 @@ Persona. There's no way you can tell which of the processes got the signal or whether all of them did. - - Function: waitpid PID OPTIONS + - Function: waitpid pid options The `waitpid' function suspends execution of the current process until a child as specified by the PID argument has exited, or until a signal is delivered whose action is to terminate the @@ -4088,12 +4329,14 @@ Persona. 3. Which means both of the above. - The return value is normally the process ID of the child process - whose status is reported. If the `WNOHANG' option was specified - and no child process is waiting to be noticed, the value is zero. - A value of `#f' is returned in case of error and `errno' is set. - For information about the `errno' codes *Note Process Completion: - (GNU C Library)Process Completion. + The return value normally is the exit status of the child process, + including the exit value along with flags indicating whether a + coredump was generated or the child terminated as a result of a + signal. If the `WNOHANG' option was specified and no child + process is waiting to be noticed, the value is zero. A value of + `#f' is returned in case of error and `errno' is set. For + information about the `errno' codes *Note Process Completion: (GNU + C Library)Process Completion. - Function: uname You can use the `uname' procedure to find out some information @@ -4116,8 +4359,8 @@ Persona. Some examples are `"i386-ANYTHING"', `"m68k-hp"', `"sparc-sun"', `"m68k-sun"', `"m68k-sony"' and `"mips-dec"'. - - Function: getpw NAME - - Function: getpw UID + - Function: getpw name + - Function: getpw uid - Function: getpw Returns a vector of information for the entry for `NAME', `UID', or the next entry if no argument is given. The information is: @@ -4140,15 +4383,15 @@ Persona. user logs in, or `#f', indicating that the system default should be used. - - Function: setpwent #T + - Function: setpwent #t Rewinds the pw entry table back to the begining. - - Function: setpwent #F + - Function: setpwent #f - Function: setpwent Closes the pw table. - - Function: getgr NAME - - Function: getgr UID + - Function: getgr name + - Function: getgr uid - Function: getgr Returns a vector of information for the entry for `NAME', `UID', or the next entry if no argument is given. The information is: @@ -4161,75 +4404,78 @@ Persona. 3. A list of (string) names of users in the group. - - Function: setgrent #T + - Function: setgrent #t Rewinds the group entry table back to the begining. - - Function: setgrent #F + - Function: setgrent #f - Function: setgrent Closes the group table. - Function: getgroups Returns a vector of all the supplementary group IDs of the process. - - Function: link OLDNAME NEWNAME + - Function: link oldname newname The `link' function makes a new link to the existing file named by OLDNAME, under the new name NEWNAME. `link' returns a value of `#t' if it is successful and `#f' on failure. - - Function: chown FILENAME OWNER GROUP + - Function: chown filename owner group The `chown' function changes the owner of the file FILENAME to OWNER, and its group owner to GROUP. `chown' returns a value of `#t' if it is successful and `#f' on failure. - - Function: ttyname PORT + - Function: ttyname port If port PORT is associated with a terminal device, returns a string containing the file name of termainal device; otherwise `#f'. + +File: scm.info, Node: Unix Extensions, Next: Regular Expression Pattern Matching, Prev: Posix Extensions, Up: Packages + | Unix Extensions =============== If `'unix' is provided (by linking in `unix.o'), the following functions are defined: -These "priveledged" and symbolic link functions are not in Posix: +These "privileged" and symbolic link functions are not in Posix: | - - Function: symlink OLDNAME NEWNAME + - Function: symlink oldname newname The `symlink' function makes a symbolic link to OLDNAME named NEWNAME. `symlink' returns a value of `#t' if it is successful and `#f' on failure. - - Function: readlink FILENAME + - Function: readlink filename Returns the value of the symbolic link FILENAME or `#f' for failure. - - Function: lstat FILENAME + - Function: lstat filename The `lstat' function is like `stat', except that it does not follow symbolic links. If FILENAME is the name of a symbolic link, `lstat' returns information about the link itself; otherwise, `lstat' works like `stat'. *Note I/O-Extensions::. - - Function: nice INCREMENT + - Function: nice increment Increment the priority of the current process by INCREMENT. `chown' returns a value of `#t' if it is successful and `#f' on failure. - - Function: acct FILENAME + - Function: acct filename When called with the name of an exisitng file as argument, - accounting is turned on, records for each terminating pro-cess are + accounting is turned on, records for each terminating process are | appended to FILENAME as it terminates. An argument of `#f' causes accounting to be turned off. `acct' returns a value of `#t' if it is successful and `#f' on failure. - - Function: mknod FILENAME MODE DEV + - Function: mknod filename mode dev The `mknod' function makes a special file with name FILENAME and modes MODE for device number DEV. @@ -4242,8 +4488,8 @@ These "priveledged" and symbolic link functions are not in Posix: actual writing is done. The value returned is unspecified. -File: scm.info, Node: Regular Expression Pattern Matching, Next: Line Editing, Prev: Posix Extensions, Up: Packages - +File: scm.info, Node: Regular Expression Pattern Matching, Next: Line Editing, Prev: Unix Extensions, Up: Packages + | Regular Expression Pattern Matching =================================== @@ -4258,15 +4504,14 @@ description of regular expressions, *Note syntax: (regex)syntax. `regerror'. FLAGS in `regcomp' is a string of option letters used to control - the compilation of the regular expression. The letters may consist - of: + the compilation of the regular expression. The letters may + consist of: `n' newlines won't be matched by `.' or hat lists; ( `[^...]' ) `i' - ignore case. - only when compiled with _GNU_SOURCE: + ignore case.only when compiled with _GNU_SOURCE: `0' allows dot to match a null character. @@ -4323,14 +4568,14 @@ description of regular expressions, *Note syntax: (regex)syntax. The character position at which to begin the search or match. If absent, the default is zero. - *Compiled _GNU_SOURCE and using GNU libregex only:* + _Compiled _GNU_SOURCE and using GNU libregex only:_ When searching, if START is negative, the absolute value of START will be used as the start location and reverse searching will be performed. LEN The search is allowed to examine only the first LEN - characters of STRING. If absent, the entire string may be + characters of STRING. If absent, the entire string may be examined. - Function: string-split RE STRING @@ -4389,7 +4634,7 @@ line-editing mode will be entered. - Function: line-editing Returns the current edited line port or `#f'. - - Function: line-editing BOOL + - Function: line-editing bool If BOOL is false, exits line-editing mode and returns the previous value of `(line-editing)'. If BOOL is true, sets the current input and output ports to an edited line port and returns the @@ -4436,14 +4681,14 @@ These routines set options within curses that deal with output. All options are initially `#f', unless otherwise stated. It is not necessary to turn these options off before calling `endwin'. - - Function: clearok WIN BF + - Function: clearok win bf If enabled (BF is `#t'), the next call to `force-output' or `refresh' with WIN will clear the screen completely and redraw the entire screen from scratch. This is useful when the contents of the screen are uncertain, or in some cases for a more pleasing visual effect. - - Function: idlok WIN BF + - Function: idlok win bf If enabled (BF is `#t'), curses will consider using the hardware "insert/delete-line" feature of terminals so equipped. If disabled (BF is `#f'), curses will very seldom use this feature. @@ -4457,7 +4702,7 @@ necessary to turn these options off before calling `endwin'. "insert/delete-line" cannot be used, curses will redraw the changed portions of all lines. - - Function: leaveok WIN BF + - Function: leaveok win bf Normally, the hardware cursor is left at the location of the window cursor being refreshed. This option allows the cursor to be left wherever the update happens to leave it. It is useful for @@ -4465,7 +4710,7 @@ necessary to turn these options off before calling `endwin'. need for cursor motions. If possible, the cursor is made invisible when this option is enabled. - - Function: scrollok WIN BF + - Function: scrollok win bf This option controls what happens when the cursor of window WIN is moved off the edge of the window or scrolling region, either from a newline on the bottom line, or typing the last character of the @@ -4475,12 +4720,12 @@ necessary to turn these options off before calling `endwin'. window WIN, and then the physical terminal and window WIN are scrolled up one line. - *Note:* in order to get the physical scrolling effect on the + _Note:_ in order to get the physical scrolling effect on the terminal, it is also necessary to call `idlok'. - - Function: nodelay WIN BF + - Function: nodelay win bf This option causes wgetch to be a non-blocking call. If no input - is ready, wgetch will return an eof-object. If disabled, wgetch + is ready, wgetch will return an eof-object. If disabled, wgetch will hang until a key is pressed. @@ -4507,7 +4752,7 @@ routines. It is not necessary to turn these options off before calling `cbreak' or `nocbreak' explicitly. Most interactive programs using curses will set `CBREAK' mode. - *Note:* `cbreak' overrides `raw'. For a discussion of how these + _Note:_ `cbreak' overrides `raw'. For a discussion of how these routines interact with `echo' and `noecho' *Note read-char: Input. - Function: raw @@ -4553,14 +4798,14 @@ File: scm.info, Node: Window Manipulation, Next: Output, Prev: Terminal Mode Window Manipulation ------------------- - - Function: newwin NLINES NCOLS BEGY BEGX + - Function: newwin nlines ncols begy begx Create and return a new window with the given number of lines (or rows), NLINES, and columns, NCOLS. The upper left corner of the window is at line BEGY, column BEGX. If either NLINES or NCOLS is 0, they will be set to the value of `LINES'-BEGY and `COLS'-BEGX. A new full-screen window is created by calling `newwin(0,0,0,0)'. - - Function: subwin ORIG NLINES NCOLS BEGY BEGX + - Function: subwin orig nlines ncols begy begx Create and return a pointer to a new window with the given number of lines (or rows), NLINES, and columns, NCOLS. The window is at position (BEGY, BEGX) on the screen. This position is relative to @@ -4570,13 +4815,13 @@ Window Manipulation necessary to call `touchwin' or `touchline' on ORIG before calling `force-output'. - - Function: close-port WIN + - Function: close-port win Deletes the window WIN, freeing up all memory associated with it. In the case of sub-windows, they should be deleted before the main window WIN. - Function: refresh - - Function: force-output WIN + - Function: force-output win These routines are called to write output to the terminal, as most other routines merely manipulate data structures. `force-output' copies the window WIN to the physical terminal screen, taking into @@ -4587,21 +4832,21 @@ Window Manipulation `refresh', the number of characters output to the terminal is returned. - - Function: mvwin WIN Y X + - Function: mvwin win y x Move the window WIN so that the upper left corner will be at position (Y, X). If the move would cause the window WIN to be off the screen, it is an error and the window WIN is not moved. - - Function: overlay SRCWIN DSTWIN - - Function: overwrite SRCWIN DSTWIN + - Function: overlay srcwin dstwin + - Function: overwrite srcwin dstwin These routines overlay SRCWIN on top of DSTWIN; that is, all text in SRCWIN is copied into DSTWIN. SRCWIN and DSTWIN need not be the same size; only text where the two windows overlap is copied. The difference is that `overlay' is non-destructive (blanks are not copied), while `overwrite' is destructive. - - Function: touchwin WIN - - Function: touchline WIN START COUNT + - Function: touchwin win + - Function: touchline win start count Throw away all optimization information about which parts of the window WIN have been touched, by pretending that the entire window WIN has been drawn on. This is sometimes necessary when using @@ -4611,7 +4856,7 @@ Window Manipulation pretends that COUNT lines have been changed, beginning with line START. - - Function: wmove WIN Y X + - Function: wmove win y x The cursor associated with the window WIN is moved to line (row) Y, column X. This does not move the physical cursor of the terminal until `refresh' (or `force-output') is called. The position @@ -4626,10 +4871,10 @@ Output These routines are used to "draw" text on windows - - Function: display CH WIN - - Function: display STR WIN - - Function: wadd WIN CH - - Function: wadd WIN STR + - Function: display ch win + - Function: display str win + - Function: wadd win ch + - Function: wadd win str The character CH or characters in STR are put into the window WIN at the current cursor position of the window and the position of WIN's cursor is advanced. At the right margin, an automatic @@ -4652,51 +4897,51 @@ These routines are used to "draw" text on windows can be copied from one place to another using inch and display. See `standout', below. - *Note:* For `wadd' CH can be an integer and will insert the + _Note:_ For `wadd' CH can be an integer and will insert the character of the corresponding value. - - Function: werase WIN + - Function: werase win This routine copies blanks to every position in the window WIN. - - Function: wclear WIN + - Function: wclear win This routine is like `werase', but it also calls *Note clearok: Output Options Setting, arranging that the screen will be cleared completely on the next call to `refresh' or `force-output' for window WIN, and repainted from scratch. - - Function: wclrtobot WIN + - Function: wclrtobot win All lines below the cursor in window WIN are erased. Also, the current line to the right of the cursor, inclusive, is erased. - - Function: wclrtoeol WIN + - Function: wclrtoeol win The current line to the right of the cursor, inclusive, is erased. - - Function: wdelch WIN + - Function: wdelch win The character under the cursor in the window WIN is deleted. All characters to the right on the same line are moved to the left one position and the last character on the line is filled with a blank. The cursor position does not change. This does not imply use of the hardware "delete-character" feature. - - Function: wdeleteln WIN + - Function: wdeleteln win The line under the cursor in the window WIN is deleted. All lines below the current line are moved up one line. The bottom line WIN is cleared. The cursor position does not change. This does not imply use of the hardware "deleteline" feature. - - Function: winsch WIN CH + - Function: winsch win ch The character CH is inserted before the character under the cursor. All characters to the right are moved one <SPC> to the right, possibly losing the rightmost character of the line. The cursor position does not change . This does not imply use of the hardware "insertcharacter" feature. - - Function: winsertln WIN + - Function: winsertln win A blank line is inserted above the current line and the bottom line is lost. This does not imply use of the hardware "insert-line" feature. - - Function: scroll WIN + - Function: scroll win The window WIN is scrolled up one line. This involves moving the lines in WIN's data structure. As an optimization, if WIN is stdscr and the scrolling region is the entire window, the physical @@ -4708,7 +4953,7 @@ File: scm.info, Node: Input, Next: Curses Miscellany, Prev: Output, Up: Curs Input ----- - - Function: read-char WIN + - Function: read-char win A character is read from the terminal associated with the window WIN. Depending on the setting of `cbreak', this will be after one character (`CBREAK' mode), or after the first newline (`NOCBREAK' @@ -4720,12 +4965,12 @@ Input on the state of the terminal driver when each character is typed, the program may produce undesirable results. - - Function: winch WIN + - Function: winch win The character, of type chtype, at the current position in window WIN is returned. If any attributes are set for that position, their values will be OR'ed into the value returned. - - Function: getyx WIN + - Function: getyx win A list of the y and x coordinates of the cursor position of the window WIN is returned @@ -4735,8 +4980,8 @@ File: scm.info, Node: Curses Miscellany, Prev: Input, Up: Curses Curses Miscellany ----------------- - - Function: wstandout WIN - - Function: wstandend WIN + - Function: wstandout win + - Function: wstandend win These functions set the current attributes of the window WIN. The current attributes of WIN are applied to all characters that are written into it. Attributes are a property of the character, and @@ -4749,16 +4994,16 @@ Curses Miscellany visibly different from other text. `wstandend' turns off the attributes. - - Function: box WIN VERTCH HORCH + - Function: box win vertch horch A box is drawn around the edge of the window WIN. VERTCH and HORCH are the characters the box is to be drawn with. If VERTCH and HORCH are 0, then appropriate default characters, `ACS_VLINE' and `ACS_HLINE', will be used. - *Note:* VERTCH and HORCH can be an integers and will insert the + _Note:_ VERTCH and HORCH can be an integers and will insert the character (with attributes) of the corresponding values. - - Function: unctrl C + - Function: unctrl c This macro expands to a character string which is a printable representation of the character C. Control characters are displayed in the `C-x' notation. Printing characters are displayed @@ -4790,7 +5035,7 @@ Host Data, Network, Protocol, and Service Inquiries - Constant: af_unix Integer family codes for Internet and Unix sockets, respectively. - - Function: gethost HOST-SPEC + - Function: gethost host-spec - Function: gethost Returns a vector of information for the entry for `HOST-SPEC' or the next entry if `HOST-SPEC' isn't given. The information is: @@ -4805,7 +5050,7 @@ Host Data, Network, Protocol, and Service Inquiries 4. list of integer addresses - - Function: sethostent STAY-OPEN + - Function: sethostent stay-open - Function: sethostent Rewinds the host entry table back to the begining if given an argument. If the argument STAY-OPEN is `#f' queries will be be @@ -4813,7 +5058,7 @@ Host Data, Network, Protocol, and Service Inquiries will be used. When called without an argument, the host table is closed. - - Function: getnet NAME-OR-NUMBER + - Function: getnet name-or-number - Function: getnet Returns a vector of information for the entry for NAME-OR-NUMBER or the next entry if an argument isn't given. The information is: @@ -4826,14 +5071,14 @@ Host Data, Network, Protocol, and Service Inquiries 3. integer network number - - Function: setnetent STAY-OPEN + - Function: setnetent stay-open - Function: setnetent Rewinds the network entry table back to the begining if given an argument. If the argument STAY-OPEN is `#f' the table will be closed between calls to getnet. Otherwise, the table stays open. When called without an argument, the network table is closed. - - Function: getproto NAME-OR-NUMBER + - Function: getproto name-or-number - Function: getproto Returns a vector of information for the entry for NAME-OR-NUMBER or the next entry if an argument isn't given. The information is: @@ -4844,7 +5089,7 @@ Host Data, Network, Protocol, and Service Inquiries 3. integer protocol number - - Function: setprotoent STAY-OPEN + - Function: setprotoent stay-open - Function: setprotoent Rewinds the protocol entry table back to the begining if given an argument. If the argument STAY-OPEN is `#f' the table will be @@ -4852,7 +5097,7 @@ Host Data, Network, Protocol, and Service Inquiries open. When called without an argument, the protocol table is closed. - - Function: getserv NAME-OR-PORT-NUMBER PROTOCOL + - Function: getserv name-or-port-number protocol - Function: getserv Returns a vector of information for the entry for NAME-OR-PORT-NUMBER and PROTOCOL or the next entry if arguments @@ -4866,7 +5111,7 @@ Host Data, Network, Protocol, and Service Inquiries 3. protocol - - Function: setservent STAY-OPEN + - Function: setservent stay-open - Function: setservent Rewinds the service entry table back to the begining if given an argument. If the argument STAY-OPEN is `#f' the table will be @@ -4879,43 +5124,43 @@ File: scm.info, Node: Internet Addresses and Socket Names, Next: Socket, Prev Internet Addresses and Socket Names ----------------------------------- - - Function: inet:string->address STRING + - Function: inet:string->address string Returns the host address number (integer) for host STRING or `#f' if not found. - - Function: inet:address->string ADDRESS + - Function: inet:address->string address Converts an internet (integer) address to a string in numbers and dots notation. - - Function: inet:network ADDRESS + - Function: inet:network address Returns the network number (integer) specified from ADDRESS or `#f' if not found. - - Function: inet:local-network-address ADDRESS + - Function: inet:local-network-address address Returns the integer for the address of ADDRESS within its local network or `#f' if not found. - - Function: inet:make-address NETWORK LOCAL-ADDRESS + - Function: inet:make-address network local-address Returns the Internet address of LOCAL-ADDRESS in NETWORK. The type "socket-name" is used for inquiries about open sockets in the following procedures: - - Function: getsockname SOCKET + - Function: getsockname socket Returns the socket-name of SOCKET. Returns `#f' if unsuccessful or SOCKET is closed. - - Function: getpeername SOCKET + - Function: getpeername socket Returns the socket-name of the socket connected to SOCKET. Returns `#f' if unsuccessful or SOCKET is closed. - - Function: socket-name:family SOCKET-NAME + - Function: socket-name:family socket-name Returns the integer code for the family of SOCKET-NAME. - - Function: socket-name:port-number SOCKET-NAME + - Function: socket-name:port-number socket-name Returns the integer port number of SOCKET-NAME. - - Function: socket-name:address SOCKET-NAME + - Function: socket-name:address socket-name Returns the integer Internet address for SOCKET-NAME. @@ -4931,8 +5176,8 @@ buffered ports you can (assuming sock-port is a socket i/o port): (define i-port (duplicate-port sock-port "r")) (define o-port (duplicate-port sock-port "w")) - - Function: make-stream-socket FAMILY - - Function: make-stream-socket FAMILY PROTOCOL + - Function: make-stream-socket family + - Function: make-stream-socket family protocol Returns a `SOCK_STREAM' socket of type FAMILY using PROTOCOL. If FAMILY has the value `AF_INET', `SO_REUSEADDR' will be set. The integer argument PROTOCOL corresponds to the integer protocol @@ -4941,8 +5186,8 @@ buffered ports you can (assuming sock-port is a socket i/o port): specified FAMILY is used. SCM sockets look like ports opened for neither reading nor writing. - - Function: make-stream-socketpair FAMILY - - Function: make-stream-socketpair FAMILY PROTOCOL + - Function: make-stream-socketpair family + - Function: make-stream-socketpair family protocol Returns a pair (cons) of connected `SOCK_STREAM' (socket) ports of type FAMILY using PROTOCOL. Many systems support only socketpairs of the `af-unix' FAMILY. The integer argument PROTOCOL @@ -4950,7 +5195,7 @@ buffered ports you can (assuming sock-port is a socket i/o port): elements) from (getproto). If the PROTOCOL argument is not supplied, the default (0) for the specified FAMILY is used. - - Function: socket:shutdown SOCKET HOW + - Function: socket:shutdown socket how Makes SOCKET no longer respond to some or all operations depending on the integer argument HOW: @@ -4962,34 +5207,34 @@ buffered ports you can (assuming sock-port is a socket i/o port): `Socket:shutdown' returns SOCKET if successful, `#f' if not. - - Function: socket:connect INET-SOCKET HOST-NUMBER PORT-NUMBER - - Function: socket:connect UNIX-SOCKET PATHNAME + - Function: socket:connect inet-socket host-number port-number + - Function: socket:connect unix-socket pathname Returns SOCKET (changed to a read/write port) connected to the Internet socket on host HOST-NUMBER, port PORT-NUMBER or the Unix socket specified by PATHNAME. Returns `#f' if not successful. - - Function: socket:bind INET-SOCKET PORT-NUMBER - - Function: socket:bind UNIX-SOCKET PATHNAME + - Function: socket:bind inet-socket port-number + - Function: socket:bind unix-socket pathname Returns INET-SOCKET bound to the integer PORT-NUMBER or the UNIX-SOCKET bound to new socket in the file system at location - PATHNAME. Returns `#f' if not successful. Binding a UNIX-SOCKET + PATHNAME. Returns `#f' if not successful. Binding a UNIX-SOCKET creates a socket in the file system that must be deleted by the caller when it is no longer needed (using `delete-file'). - - Function: socket:listen SOCKET BACKLOG + - Function: socket:listen socket backlog The bound (*note bind: Socket.) SOCKET is readied to accept connections. The positive integer BACKLOG specifies how many pending connections will be allowed before further connection requests are refused. Returns SOCKET (changed to a read-only port) if successful, `#f' if not. - - Function: char-ready? LISTEN-SOCKET + - Function: char-ready? listen-socket The input port returned by a successful call to `socket:listen' can be polled for connections by `char-ready?' (*note char-ready?: Files and Ports.). This avoids blocking on connections by `socket:accept'. - - Function: socket:accept SOCKET + - Function: socket:accept socket Accepts a connection on a bound, listening SOCKET. Returns an input/output port for the connection. @@ -5124,8 +5369,8 @@ An "immediate" is a data type contained in type `SCM' (`long int'). The type codes distinguishing immediate types from each other vary in length, but reside in the low order bits. - - Macro: IMP X - - Macro: NIMP X + - Macro: IMP x + - Macro: NIMP x Return non-zero if the `SCM' object X is an immediate or non-immediate type, respectively. @@ -5134,15 +5379,15 @@ length, but reside in the low order bits. the second to low order bit position. The high order 30 bits are used for the integer's value. - - Macro: INUMP X - - Macro: NINUMP X + - Macro: INUMP x + - Macro: NINUMP x Return non-zero if the `SCM' X is an immediate integer or not an immediate integer, respectively. - - Macro: INUM X + - Macro: INUM x Returns the C `long integer' corresponding to `SCM' X. - - Macro: MAKINUM X + - Macro: MAKINUM x Returns the `SCM' inum corresponding to C `long integer' x. - Immediate Constant: INUM0 @@ -5161,13 +5406,13 @@ length, but reside in the low order bits. - Immediate: ichr characters. - - Macro: ICHRP X + - Macro: ICHRP x Return non-zero if the `SCM' object X is a character. - - Macro: ICHR X + - Macro: ICHR x Returns corresponding `unsigned char'. - - Macro: MAKICHR X + - Macro: MAKICHR x Given `char' X, returns `SCM' character. @@ -5196,27 +5441,27 @@ length, but reside in the low order bits. values are not specified. - - Macro: IFLAGP N + - Macro: IFLAGP n Returns non-zero if N is an ispcsym, isym or iflag. - - Macro: ISYMP N + - Macro: ISYMP n Returns non-zero if N is an ispcsym or isym. - - Macro: ISYMNUM N + - Macro: ISYMNUM n Given ispcsym, isym, or iflag N, returns its index in the C array `isymnames[]'. - - Macro: ISYMCHARS N + - Macro: ISYMCHARS n Given ispcsym, isym, or iflag N, returns its `char *' representation (from `isymnames[]'). - - Macro: MAKSPCSYM N + - Macro: MAKSPCSYM n Returns `SCM' ispcsym N. - - Macro: MAKISYM N + - Macro: MAKISYM n Returns `SCM' iisym N. - - Macro: MAKIFLAG N + - Macro: MAKIFLAG n Returns `SCM' iflag N. - Variable: isymnames @@ -5247,7 +5492,7 @@ length, but reside in the low order bits. completeness). Since cells are always 8 byte aligned, a pointer to a cell has the low order 3 bits `0'. - There is one exception to this rule, *CAR Immediate*s, described + There is one exception to this rule, _CAR Immediate_s, described next. A "CAR Immediate" is an Immediate point which can only occur in the @@ -5265,7 +5510,7 @@ object. The rest of `CAR' and `CDR' hold object data. The number after `tc' specifies how many bits are in the type code. For instance, `tc7' indicates that the type code is 7 bits. - - Macro: NEWCELL X + - Macro: NEWCELL x Allocates a new cell and stores a pointer to it in `SCM' local variable X. @@ -5275,20 +5520,20 @@ after `tc' specifies how many bits are in the type code. For instance, All of the C macros decribed in this section assume that their argument is of type `SCM' and points to a cell (`CELLPTR'). - - Macro: CAR X - - Macro: CDR X + - Macro: CAR x + - Macro: CDR x Returns the `car' and `cdr' of cell X, respectively. - - Macro: TYP3 X - - Macro: TYP7 X - - Macro: TYP16 X + - Macro: TYP3 x + - Macro: TYP7 x + - Macro: TYP16 x Returns the 3, 7, and 16 bit type code of a cell. - Cell: tc3_cons scheme cons-cell returned by (cons arg1 arg2). - - Macro: CONSP X - - Macro: NCONSP X + - Macro: CONSP x + - Macro: NCONSP x Returns non-zero if X is a `tc3_cons' or isn't, respectively. - Cell: tc3_closure @@ -5301,15 +5546,15 @@ is of type `SCM' and points to a cell (`CELLPTR'). encoding precludes an immediate value for the `CDR': In the case of an empty environment all bits above 2 in the `CDR' are zero. - - Macro: CLOSUREP X + - Macro: CLOSUREP x Returns non-zero if X is a `tc3_closure'. - - Macro: CODE X - - Macro: ENV X + - Macro: CODE x + - Macro: ENV x Returns the code body or environment of closure X, respectively. - - Macro: ARGC X + - Macro: ARGC x Returns the a lower bound on the number of required arguments to closure X, it cannot exceed 3. @@ -5329,13 +5574,13 @@ memory allocated by `malloc'. - Header: tc7_vector scheme vector. - - Macro: VECTORP X - - Macro: NVECTORP X + - Macro: VECTORP x + - Macro: NVECTORP x Returns non-zero if X is a `tc7_vector' or if not, respectively. - - Macro: VELTS X - - Macro: LENGTH X + - Macro: VELTS x + - Macro: LENGTH x Returns the C array of `SCM's holding the elements of vector X or its length, respectively. @@ -5345,26 +5590,26 @@ memory allocated by `malloc'. - Header: tc7_msymbol `malloc'ed scheme symbol (can be GCed) - - Macro: SYMBOLP X + - Macro: SYMBOLP x Returns non-zero if X is a `tc7_ssymbol' or `tc7_msymbol'. - - Macro: CHARS X - - Macro: UCHARS X - - Macro: LENGTH X + - Macro: CHARS x + - Macro: UCHARS x + - Macro: LENGTH x Returns the C array of `char's or as `unsigned char's holding the elements of symbol X or its length, respectively. - Header: tc7_string scheme string - - Macro: STRINGP X - - Macro: NSTRINGP X + - Macro: STRINGP x + - Macro: NSTRINGP x Returns non-zero if X is a `tc7_string' or isn't, respectively. - - Macro: CHARS X - - Macro: UCHARS X - - Macro: LENGTH X + - Macro: CHARS x + - Macro: UCHARS x + - Macro: LENGTH x Returns the C array of `char's or as `unsigned char's holding the elements of string X or its length, respectively. @@ -5377,6 +5622,9 @@ memory allocated by `malloc'. - Header: tc7_uvect uniform vector of non-negative integers + - Header: tc7_svect | + uniform vector of short integers | + | - Header: tc7_fvect uniform vector of short inexact real numbers @@ -5406,12 +5654,12 @@ memory allocated by `malloc'. invocation is currently not tail recursive when given 2 or more arguments. - - Function: makcclo PROC LEN - makes a closure from the *subr* PROC with LEN-1 extra + - Function: makcclo proc len + makes a closure from the _subr_ PROC with LEN-1 extra locations for `SCM' data. Elements of a CCLO are referenced using `VELTS(cclo)[n]' just as for vectors. - - Macro: CCLO_LENGTH CCLO + - Macro: CCLO_LENGTH cclo Expands to the length of CCLO. @@ -5487,7 +5735,7 @@ Ptob Cells A "ptob" is a port object, capable of delivering or accepting characters. *Note Ports: (r5rs)Ports. Unlike the types described so far, new varieties of ptobs can be defined dynamically (*note Defining -Ptobs::.). These are the initial ptobs: +Ptobs::). These are the initial ptobs: - ptob: tc16_inport input port. @@ -5508,33 +5756,32 @@ Ptobs::.). These are the initial ptobs: String port created by `cwos()' or `cwis()'. - ptob: tc16_sfport - Software (virtual) port created by `mksfpt()' (*note Soft - Ports::.). - - - Macro: PORTP X - - Macro: OPPORTP X - - Macro: OPINPORTP X - - Macro: OPOUTPORTP X - - Macro: INPORTP X - - Macro: OUTPORTP X + Software (virtual) port created by `mksfpt()' (*note Soft Ports::). + + - Macro: PORTP x + - Macro: OPPORTP x + - Macro: OPINPORTP x + - Macro: OPOUTPORTP x + - Macro: INPORTP x + - Macro: OUTPORTP x Returns non-zero if X is a port, open port, open input-port, open output-port, input-port, or output-port, respectively. - - Macro: OPENP X - - Macro: CLOSEDP X + - Macro: OPENP x + - Macro: CLOSEDP x Returns non-zero if port X is open or closed, respectively. - - Macro: STREAM X + - Macro: STREAM x Returns the `FILE *' stream for port X. Ports which are particularly well behaved are called "fport"s. Advanced operations like `file-position' and `reopen-file' only work for fports. - - Macro: FPORTP X - - Macro: OPFPORTP X - - Macro: OPINFPORTP X - - Macro: OPOUTFPORTP X + - Macro: FPORTP x + - Macro: OPFPORTP x + - Macro: OPINFPORTP x + - Macro: OPOUTFPORTP x Returns non-zero if X is a port, open port, open input-port, or open output-port, respectively. @@ -5550,7 +5797,7 @@ of the `CAR' can be used for sub-type or other information. The `CDR' contains data of size long and is often a pointer to allocated memory. Like ptobs, new varieties of smobs can be defined dynamically (*note -Defining Smobs::.). These are the initial smobs: +Defining Smobs::). These are the initial smobs: - smob: tc_free_cell unused cell on the freelist. @@ -5590,7 +5837,7 @@ Defining Smobs::.). These are the initial smobs: Why only 4800 digits? The simple multiplication algorithm SCM uses is O(n^2); this means the number of processor instructions - required to perform a multiplication is *some multiple* of the + required to perform a multiplication is _some multiple_ of the product of the number of digits of the two multiplicands. digits * digits ==> operations @@ -5604,7 +5851,7 @@ Defining Smobs::.). These are the initial smobs: should obtain a package which specializes in number-theoretical calculations: - `ftp://megrez.math.u-bordeaux.fr/pub/pari/' + <ftp://megrez.math.u-bordeaux.fr/pub/pari/> - smob: tc16_promise @@ -5620,9 +5867,9 @@ Defining Smobs::.). These are the initial smobs: multi-dimensional array. *Note Arrays::. This type implements both conventional arrays (those with - arbitrary data as elements *note Conventional Arrays::.) and + arbitrary data as elements *note Conventional Arrays::) and uniform arrays (those with elements of a uniform type *note - Uniform Array::.). + Uniform Array::). Conventional Arrays have a pointer to a vector for their `CDR'. Uniform Arrays have a pointer to a Uniform Vector type (string, @@ -5661,7 +5908,7 @@ bvect .........long length....G0010101 ..........long *words........... ivect .........long length....G0011101 ..........long *words........... uvect .........long length....G0011111 ......unsigned long *words...... spare G0100101 - spare G0100111 +svect .........long length....G0100111 ........ short *words........... | fvect .........long length....G0101101 .........float *words........... dvect .........long length....G0101111 ........double *words........... cvect .........long length....G0110101 ........double *words........... @@ -5765,11 +6012,11 @@ during garbage collection. Special C macros are defined in `scm.h' to allow easy manipulation when GC bits are possibly set. `CAR', `TYP3', and `TYP7' can be used on GC marked cells as they are. - - Macro: GCCDR X + - Macro: GCCDR x Returns the CDR of a cons cell, even if that cell has been GC marked. - - Macro: GCTYP16 X + - Macro: GCTYP16 x Returns the 16 bit type code of a cell. We need to (recursively) mark only a few objects in order to assure that @@ -5837,7 +6084,7 @@ optimize the allocation and garbage collection of environments. The optimizations are based on certain facts and assumptions: The SCM evaluator creates many environments with short lifetimes and -these account of a *large portion* of the total number of objects +these account of a _large portion_ of the total number of objects allocated. The general purpose allocator allocates objects from a freelist, and @@ -5933,8 +6180,8 @@ Signals handlers immediately reestablish themselves by a call to `signal()'. - - Function: int_signal SIG - - Function: alrm_signal SIG + - Function: int_signal sig + - Function: alrm_signal sig The low level handlers for `SIGINT' and `SIGALRM'. If an interrupt handler is defined when the interrupt is received, the @@ -5968,7 +6215,7 @@ File: scm.info, Node: C Macros, Next: Changing Scm, Prev: Signals, Up: Opera C Macros -------- - - Macro: ASSERT COND ARG POS SUBR + - Macro: ASSERT cond arg pos subr signals an error if the expression (COND) is 0. ARG is the offending object, SUBR is the string naming the subr, and POS indicates the position or type of error. POS can be one of @@ -6013,7 +6260,7 @@ C Macros defined. An error condition can still be signaled in this case with a call to `wta(arg, pos, subr)'. - - Macro: ASRTGO COND LABEL + - Macro: ASRTGO cond label `goto' LABEL if the expression (COND) is 0. Like `ASSERT', `ASRTGO' does is not active if the flag `RECKLESS' is defined. @@ -6024,7 +6271,7 @@ Changing Scm ------------ When writing C-code for SCM, a precaution is recommended. If your -routine allocates a non-cons cell which will *not* be incorporated into +routine allocates a non-cons cell which will _not_ be incorporated into a `SCM' object which is returned, you need to make sure that a `SCM' variable in your routine points to that cell as long as part of it might be referenced by your code. @@ -6039,7 +6286,7 @@ or put this assignment somewhere in your routine: SCM_dummy1 = (SCM) &foo; `SCM_dummy' variables are not currently defined. Passing the address -of the local `SCM' variable to *any* procedure also protects it. The +of the local `SCM' variable to _any_ procedure also protects it. The procedure `scm_protect_temp' is provided for this purpose. Also, if you maintain a static pointer to some (non-immediate) `SCM' @@ -6106,7 +6353,7 @@ To add a package of new procedures to scm (see `crs.c' for example): 7. put any scheme code which needs to be run as part of your package into `Ifoo.scm'. - 8. put an `if' into `Init5d2.scm' which loads `Ifoo.scm' if your | + 8. put an `if' into `Init5d6.scm' which loads `Ifoo.scm' if your | package is included: (if (defined? twiddle-bits!) @@ -6120,7 +6367,7 @@ To add a package of new procedures to scm (see `crs.c' for example): 9. put documentation of the new procedures into `foo.doc' 10. add lines to your `Makefile' to compile and link SCM with your - object file. Add a `init_foo\(\)\;' to the `INITS=...' line at + object file. Add a `init_foo\(\)\;' to the `INITS=...' line at the beginning of the makefile. These steps should allow your package to be linked into SCM with a @@ -6154,7 +6401,7 @@ The SCM interpreter directly recognizes subrs taking small numbers of arguments. In order to create subrs taking larger numbers of arguments use: - - Function: make_gsubr NAME REQ OPT REST FCN + - Function: make_gsubr name req opt rest fcn returns a cclo (compiled closure) object of name `char *' NAME which takes `int' REQ required arguments, `int' OPT optional arguments, and a list of rest arguments if `int' REST is 1 (0 for @@ -6221,7 +6468,7 @@ following lines need to be added to your code: mark) and returns type `SCM' which will then be marked. If no further objects need to be marked then return an immediate object such as `BOOL_F'. The smob cell itself will already - have been marked. *Note:* This is different from SCM + have been marked. _Note:_ This is different from SCM versions prior to 5c5. Only additional data specific to a smob type need be marked by `smob.mark'. @@ -6247,9 +6494,10 @@ following lines need to be added to your code: is the smob object. The second, of type `SCM', is the stream on which to write the result. The third, of type int, is 1 if the object should be `write'n, 0 if it should be - `display'ed. This function should return non-zero if it - printed, and zero otherwise (in which case a hexadecimal - number will be printed). + `display'ed, and 2 if it should be `write'n for an error | + report. This function should return non-zero if it printed, | + and zero otherwise (in which case a hexadecimal number will | + be printed). | `smob.equalp' is 0 or a function of 2 `SCM' arguments. Both of these @@ -6314,7 +6562,7 @@ following functions are provided for that purpose: - Function: char * must_malloc (long LEN, char *WHAT) LEN is the number of bytes that should be allocated, WHAT is a string to be used in error or gc messages. `must_malloc' returns - a pointer to newly allocated memory. `must_malloc_cell' returns a + a pointer to newly allocated memory. `must_malloc_cell' returns a newly allocated cell whose `car' is C and whose `cdr' is a pointer to newly allocated memory. @@ -6329,14 +6577,16 @@ following functions are provided for that purpose: address of a block of memory of length OLEN allocated by `must_malloc' and returns the address of a block of length LEN. - The contents of the reallocated block will be unchanged up the the + The contents of the reallocated block will be unchanged up to the minimum of the old and new sizes. WHAT is a pointer to a string used for error and gc messages. `must_malloc', `must_malloc_cell', `must_realloc', and `must_realloc_cell' must be called with interrupts deferred *Note -Signals::. +Signals::. `must_realloc' and `must_realloc_cell' must not be called | +during initialization (non-zero errjmp_bad) - the initial allocations | +must be large enough. | - Function: void must_free (char *PTR, sizet LEN) `must_free' is used to free a block of memory allocated by the @@ -6366,8 +6616,8 @@ module. - Variable: char *execpath This string is the pathname of the executable file being run. This variable can be examined and set from Scheme (*note Internal - State::.). EXECPATH must be set to executable's path in order to - use DUMP (*note Dump::.) or DLD. + State::). EXECPATH must be set to executable's path in order to + use DUMP (*note Dump::) or DLD. Rename main() and arrange your code to call it with an ARGV which sets up SCM as you want it. @@ -6382,7 +6632,7 @@ descriptions of the functions which main() calls. - Function: char * scm_find_execpath (int ARGC, char **ARGV, char *SCRIPT_ARG) ARGC and ARGV are as described in main(). SCRIPT_ARG is the - pathname of the SCSH-style script (*note Scripting::.) being + pathname of the SCSH-style script (*note Scripting::) being invoked; 0 otherwise. `scm_find_execpath' returns the pathname of the executable being run; if `scm_find_execpath' cannot determine the pathname, then it returns 0. @@ -6403,7 +6653,7 @@ SCM, then you can replace `scm_find_implpath'. environment variable is defined, its value will be returned from `scm_find_implpath'. Otherwise find_impl_file() is called with the arguments EXECPATH, GENERIC_NAME (default "scm"), INIT_FILE_NAME - (default "Init5d2_scm"), and the directory separator string | + (default "Init5d6_scm"), and the directory separator string | DIRSEP. If find_impl_file() returns 0 and IMPLINIT is defined, then a copy of the string IMPLINIT is returned. @@ -6468,7 +6718,7 @@ handle interrupts and signals. You can call indivdual Scheme procedures from C code in the TOPLVL_FUN argument passed to scm_top_level(), or from module subrs (registered by -an `init_' function, *note Changing Scm::.). +an `init_' function, *note Changing Scm::). Use `apply' to call Scheme procedures from your C code. For example: @@ -6481,7 +6731,7 @@ Use `apply' to call Scheme procedures from your C code. For example: retval = apply(func, cons(mksproc(srvproc), args), EOL); Functions for loading Scheme files and evaluating Scheme code given as -C strings are described in the next section, (*note Callbacks::.). +C strings are described in the next section, (*note Callbacks::). Here is a minimal embedding program `libtest.c': @@ -6515,7 +6765,7 @@ Here is a minimal embedding program `libtest.c': fprintf(stderr, "dld_find_executable(%s): %s\n", argv[0], execpath); implpath = find_impl_file(execpath, "scm", INIT_FILE_NAME, dirsep); fprintf(stderr, "implpath: %s\n", implpath); - scm_init_from_argv(argc, argv, 0, 0); + scm_init_from_argv(argc, argv, 0L, 0, 0); retval = scm_top_level(implpath, user_main); @@ -6525,7 +6775,7 @@ Here is a minimal embedding program `libtest.c': -| dld_find_executable(./libtest): /home/jaffer/scm/libtest - implpath: /home/jaffer/scm/Init5d2.scm | + implpath: /home/jaffer/scm/Init5d6.scm | This is init_user_scm hello world @@ -6541,7 +6791,7 @@ The source code for these routines are found in `rope.c'. - Function: int scm_ldfile (char *FILE) Loads the Scheme source file FILE. Returns 0 if successful, non-0 if not. This function is used to load SCM's initialization file - `Init5d2.scm'. | + `Init5d6.scm'. | - Function: int scm_ldprog (char *FILE) Loads the Scheme source file `(in-vicinity (program-vicinity) @@ -6610,7 +6860,7 @@ code. Most are defined in `rope.c'. NUM and strings POS and S_CALLER. For a listing of useful predefined POS macros, *Note C Macros::. - *Note:* Inexact numbers are accepted only by `num2long' and + _Note:_ Inexact numbers are accepted only by `num2long' and `num2ulong' (for when `SCM' is compiled without bignums). To convert inexact numbers to exact numbers, *Note inexact->exact: (r5rs)Numerical operations. @@ -6622,9 +6872,9 @@ code. Most are defined in `rope.c'. messages from error calls by `scm_addr'. `scm_addr' is useful for performing C operations on strings or - other uniform arrays (*note Uniform Array::.). + other uniform arrays (*note Uniform Array::). - *Note:* While you use a pointer returned from `scm_addr' you must + _Note:_ While you use a pointer returned from `scm_addr' you must keep a pointer to the associated `SCM' object in a stack allocated variable or GC-protected location in order to assure that SCM does not reuse that storage before you are done with it. @@ -6698,7 +6948,7 @@ conflicts. "root" `CONTINUATION's have additional storage (immediately following) to contain a copy of part of the stack. - *Note:* On systems with nonlinear stack disciplines (multiple + _Note:_ On systems with nonlinear stack disciplines (multiple stacks or non-contiguous stack frames) copying the stack will not work properly. These systems need to #define `CHEAP_CONTINUATIONS' in `scmfig.h'. @@ -6763,7 +7013,7 @@ Evaluation ---------- SCM uses its type representations to speed evaluation. All of the -`subr' types (*note Subr Cells::.) are `tc7' types. Since the `tc7' +`subr' types (*note Subr Cells::) are `tc7' types. Since the `tc7' field is in the low order bit position of the `CAR' it can be retrieved and dispatched on quickly by dereferencing the SCM pointer pointing to it and masking the result. @@ -6776,7 +7026,7 @@ to occupy the same bits as `tc7'. All the `isym's occur only in the If the `CAR' of a expression to evaluate is not immediate, then it may be a symbol. If so, the first time it is encountered it will be -converted to an immediate type `ILOC' or `GLOC' (*note Immediates::.). +converted to an immediate type `ILOC' or `GLOC' (*note Immediates::). The codes for `ILOC' and `GLOC' lower 7 bits distinguish them from all the other types we have discussed. @@ -6846,8 +7096,8 @@ argument checks for closures are made only when the function position will be checked only the first time it is evaluated because it will then be replaced with an `ILOC' or `GLOC'. - - Macro: EVAL EXPRESSION ENV - - Macro: SIDEVAL EXPRESSION ENV + - Macro: EVAL expression env + - Macro: SIDEVAL expression env `EVAL' Returns the result of evaluating EXPRESSION in ENV. `SIDEVAL' evaluates EXPRESSION in ENV when the value of the expression is not used. @@ -6912,8 +7162,8 @@ needed. Given the pathname of this executable (EXEC_PATH), test for the existence of INITNAME in the implementation-vicinity of this program. Return a newly allocated string of the path if - successful, 0 if not. The SEP argument is a *null-terminated - string* of the character used to separate directory components. + successful, 0 if not. The SEP argument is a _null-terminated + string_ of the character used to separate directory components. * One convention is to install the support files for an executable program in the same directory as the program. This possibility is @@ -6953,13 +7203,13 @@ File: scm.info, Node: Executable Pathname, Next: Script Support, Prev: File-S Executable Pathname ------------------- -For purposes of finding `Init5d2.scm', dumping an executable, and | +For purposes of finding `Init5d6.scm', dumping an executable, and | dynamic linking, a SCM session needs the pathname of its executable image. When a program is executed by MS-DOS, the full pathname of that executable is available in `argv[0]'. This value can be passed -directly to `find_impl_file' (*note File-System Habitat::.). +directly to `find_impl_file' (*note File-System Habitat::). In order to find the habitat for a unix program, we first need to know the full pathname for the associated executable file. @@ -7034,7 +7284,7 @@ Improvements To Make names. Provide a file full of #define's to provide backward compatability. - * `lgcd()' *needs* to generate at most one bignum, but currently + * `lgcd()' _needs_ to generate at most one bignum, but currently generates more. * `divide()' could use shifts instead of multiply and divide when @@ -7066,6 +7316,7 @@ Improvements To Make gets set which tells the interpreter to instead always look up the values of the associated symbols. + * Menu: * Finishing Dynamic Linking:: @@ -7108,7 +7359,7 @@ with a VMS system needs to finish and debug it. PSECT_ATTR=the_heap,NOSHR,LCL PSECT_ATTR=the_environment,NOSHR,LCL - *Notice:* The "psect" (Program Section) attributes. + _Notice:_ The "psect" (Program Section) attributes. `LCL' means to keep the name local to the shared library. You almost always want to do that for a good clean library. @@ -7173,7 +7424,7 @@ with a VMS system needs to finish and debug it. off <C-c> or other interrupt handling while you are inside most `lib$' calls. - As far as the generation of all the `UNIVERSAL=...' declarations. + As far as the generation of all the `UNIVERSAL=...' declarations. Well, you could do well to have that automatically generated from the public `LISPRTL.H' file, of course. @@ -7272,7 +7523,7 @@ Windows NT: nointerrupt(iflag); return(retval);} - * *Note:* in VMS the linker and dynamic loader is case sensitive, but + * _Note:_ in VMS the linker and dynamic loader is case sensitive, but all the language compilers, including C, will by default upper-case external symbols for use by the linker, although the debugger gets its own symbols and case sensitivity is language mode dependant. @@ -7280,7 +7531,7 @@ Windows NT: and device names, which are case canonicalizing like in the Symbolics filesystem. - * *Also:* All this WINDOWS NT stuff will work in MS-DOS MS-Windows + * _Also:_ All this WINDOWS NT stuff will work in MS-DOS MS-Windows 3.1 too, by a method of compiling and linking under Windows NT, and then copying various files over to MS-DOS/WINDOWS. @@ -7299,7 +7550,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * #+: Syntax Extensions. * #-: Syntax Extensions. * #.: Syntax Extensions. -* #;text-till-end-of-line: Syntax Extensions. | +* #;text-till-end-of-line: Syntax Extensions. * #\token: Syntax Extensions. * #|: Syntax Extensions. * $abs: Numeric. @@ -7349,6 +7600,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * -e: SCM Options. * -f: SCM Options. * -F: Build Options. +* -h <1>: SCM Options. * -h: Build Options. * -i <1>: SCM Options. * -i: Build Options. @@ -7370,19 +7622,18 @@ This is an alphabetical list of all the procedures and macros in SCM. * -v: SCM Options. * -w: Build Options. * @apply: Low Level Syntactic Hooks. -* @call-with-current-continuation: Low Level Syntactic Hooks. -* @copy-tree: Miscellaneous Procedures. -* @let-syntax: Syntactic Hooks for Hygienic Macros. -* @letrec-syntax: Syntactic Hooks for Hygienic Macros. +* @copy-tree: Miscellaneous Procedures. | * @macroexpand1: Syntactic Hooks for Hygienic Macros. +* _exclusive: Files and Ports. | * _ionbf: Files and Ports. -* _tracked: Files and Ports. | +* _tracked: Files and Ports. * abort: Internal State. * access: I/O-Extensions. -* acct: Posix Extensions. +* acct: Unix Extensions. | * acons: Miscellaneous Procedures. * acosh: Numeric. * add-alias: Configure Module Catalog. +* add-finalizer: Interrupts. | * add-link: Configure Module Catalog. * add-source: Configure Module Catalog. * alarm: Interrupts. @@ -7417,9 +7668,12 @@ This is an alphabetical list of all the procedures and macros in SCM. * bit-invert!: Bit Vectors. * bit-position: Bit Vectors. * bit-set*!: Bit Vectors. +* boot-tail <1>: Dump. | +* boot-tail: SCM Session. | * box: Curses Miscellany. -* CAR: Cells. -* casev: Syntax Extensions. +* broken-pipe: Posix Extensions. | +* call-with-outputs: Files and Ports. +* CAR: Cells. | * cbreak: Terminal Mode Setting. * CCLO_LENGTH: Header Cells. * CDR: Cells. @@ -7432,8 +7686,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * CHEAP_CONTINUATIONS: Continuations. * chmod: I/O-Extensions. * chown: Posix Extensions. -* clearok: Output Options Setting. -* close-io-port: Files and Ports. +* clearok: Output Options Setting. | * close-port <1>: Window Manipulation. * close-port <2>: Posix Extensions. * close-port: Files and Ports. @@ -7442,7 +7695,6 @@ This is an alphabetical list of all the procedures and macros in SCM. * CLOSUREP: Cells. * CODE: Cells. * comment: Syntax Extensions. | -* compile-file: Compiling And Linking. * CONSP: Cells. * copy-tree: Miscellaneous Procedures. * cosh: Numeric. @@ -7455,6 +7707,8 @@ This is an alphabetical list of all the procedures and macros in SCM. * defconst: Syntax Extensions. * DEFER_INTS: Signals. * defined?: Syntax Extensions. +* defmacro: Syntax Extensions. +* defsyntax: Low Level Syntactic Hooks. | * defvar: Syntax Extensions. * dimensions->uniform-array: Uniform Array. * directory-for-each: I/O-Extensions. @@ -7471,8 +7725,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * enclose-array: Conventional Arrays. * end-of-program: Interrupts. * endwin: Curses. -* ENV: Cells. -* environment->tree: Low Level Syntactic Hooks. +* ENV: Cells. | * errno: Errors. * error: Errors. * eval: Evaluation. @@ -7496,11 +7749,13 @@ This is an alphabetical list of all the procedures and macros in SCM. * fork: Posix Extensions. * FPORTP: Ptob Cells. * free_continuation: Continuations. -* freshline: Files and Ports. | +* freshline: Files and Ports. * gc: Internal State. +* gc-hook: Interrupts. | * gc_mark: Marking Cells. * GCCDR: Marking Cells. * GCTYP16: Marking Cells. +* gentemp: Syntax Extensions. * get-internal-real-time: Time. * get-internal-run-time: Time. * getcwd: I/O-Extensions. @@ -7510,6 +7765,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * getgr: Posix Extensions. * getgroups: Posix Extensions. * gethost: Host Data. +* getlogin: Posix Extensions. | * getnet: Host Data. * getpeername: Internet Addresses and Socket Names. * getpid: I/O-Extensions. @@ -7541,6 +7797,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * initscr: Curses. * INPORTP: Ptob Cells. * int_signal: Signals. +* integer->line-number: Line Numbers. | * INUM: Immediates. * INUMP: Immediates. * isatty?: Files and Ports. @@ -7552,10 +7809,10 @@ This is an alphabetical list of all the procedures and macros in SCM. * LENGTH: Header Cells. * line-editing: Line Editing. * line-number: Miscellaneous Procedures. -* link: Posix Extensions. -* link-named-scm: Compiling And Linking. -* list->uniform-array: Uniform Array. -* list->uniform-vector: Uniform Array. +* line-number->integer: Line Numbers. | +* line-number?: Line Numbers. | +* link: Posix Extensions. | +* list->uniform-array: Uniform Array. | * list-file: Miscellaneous Procedures. * load: Dynamic Linking. * load-string: Miscellaneous Procedures. @@ -7563,19 +7820,20 @@ This is an alphabetical list of all the procedures and macros in SCM. * logaset!: Uniform Array. * long: Type Conversions. * long2num: Type Conversions. -* lstat: Posix Extensions. +* lstat: Unix Extensions. | +* macroexpand: Syntax Extensions. +* macroexpand-1: Syntax Extensions. * main: Embedding SCM. * makargvfrmstrs: Type Conversions. * makcclo: Header Cells. * make-arbiter: Process Synchronization. * make-array: Conventional Arrays. * make-edited-line-port: Line Editing. +* make-exchanger: Process Synchronization. | * make-shared-array: Conventional Arrays. * make-soft-port: Soft Ports. * make-stream-socket: Socket. -* make-stream-socketpair: Socket. -* make-uniform-array: Uniform Array. -* make-uniform-vector: Uniform Array. +* make-stream-socketpair: Socket. | * make_continuation: Continuations. * make_gsubr: Defining Subrs. * make_root_continuation: Continuations. @@ -7590,7 +7848,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * mark_locations: Marking Cells. * milli-alarm: Interrupts. * mkdir: I/O-Extensions. -* mknod: Posix Extensions. +* mknod: Unix Extensions. | * must_free: Allocating memory. * must_free_argv: Type Conversions. * must_malloc: Allocating memory. @@ -7601,7 +7859,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * NCONSP: Cells. * NEWCELL: Cells. * newwin: Window Manipulation. -* nice: Posix Extensions. +* nice: Unix Extensions. | * NIMP: Immediates. * NINUMP: Immediates. * nl: Terminal Mode Setting. @@ -7614,10 +7872,10 @@ This is an alphabetical list of all the procedures and macros in SCM. * num2long: Type Conversions. * NVECTORP: Header Cells. * open-file: Files and Ports. -* open-input-pipe: Posix Extensions. -* open-io-file: Files and Ports. +* open-input-pipe: Posix Extensions. | * open-output-pipe: Posix Extensions. * open-pipe: Posix Extensions. +* open-ports: Files and Ports. | * opendir: I/O-Extensions. * OPENP: Ptob Cells. * OPFPORTP: Ptob Cells. @@ -7631,14 +7889,19 @@ This is an alphabetical list of all the procedures and macros in SCM. * overlay: Window Manipulation. * overwrite: Window Manipulation. * perror: Errors. +* pi*: Numeric. +* pi/: Numeric. * pipe: Posix Extensions. -* port-column: Miscellaneous Procedures. | -* port-filename: Miscellaneous Procedures. | -* port-line: Miscellaneous Procedures. | +* port-closed?: Files and Ports. | +* port-column: Miscellaneous Procedures. +* port-filename: Miscellaneous Procedures. +* port-line: Miscellaneous Procedures. +* port-type: Files and Ports. | * PORTP: Ptob Cells. * print <1>: Miscellaneous Procedures. * print: Debugging Scheme Code. * print-args: Debugging Scheme Code. +* procedure->identifier-macro: Low Level Syntactic Hooks. * procedure->macro: Low Level Syntactic Hooks. * procedure->memoizing-macro: Low Level Syntactic Hooks. * procedure->syntax: Low Level Syntactic Hooks. @@ -7647,14 +7910,17 @@ This is an alphabetical list of all the procedures and macros in SCM. * profile-alarm-interrupt: Interrupts. * program-arguments: SCM Session. * putenv: I/O-Extensions. +* qase: Syntax Extensions. | * quit: SCM Session. * raw: Terminal Mode Setting. * read-char <1>: Input. * read-char: Files and Ports. +* read-numbered: Line Numbers. | * read:sharp: Low Level Syntactic Hooks. * read:sharp-char: Low Level Syntactic Hooks. * readdir: I/O-Extensions. -* readlink: Posix Extensions. +* readlink: Unix Extensions. | +* record-printer-set!: Records. | * redirect-port!: I/O-Extensions. * refresh: Window Manipulation. * regcomp: Regular Expression Pattern Matching. @@ -7728,9 +7994,10 @@ This is an alphabetical list of all the procedures and macros in SCM. * STRINGP: Header Cells. * subwin: Window Manipulation. * SYMBOLP: Header Cells. -* symlink: Posix Extensions. -* sync: Posix Extensions. +* symlink: Unix Extensions. | +* sync: Unix Extensions. | * syntax-quote: Syntactic Hooks for Hygienic Macros. +* syntax-rules: Syntax Extensions. * tanh: Numeric. * terms: Miscellaneous Procedures. * the-macro: Syntactic Hooks for Hygienic Macros. @@ -7742,6 +8009,8 @@ This is an alphabetical list of all the procedures and macros in SCM. * trace: Debugging Scheme Code. * transpose-array: Conventional Arrays. * try-arbiter: Process Synchronization. +* try-create-file: I/O-Extensions. | +* try-load <1>: Line Numbers. | * try-load: Miscellaneous Procedures. * try-open-file: Files and Ports. * ttyname: Posix Extensions. @@ -7755,12 +8024,7 @@ This is an alphabetical list of all the procedures and macros in SCM. * unctrl: Curses Miscellany. * uniform-array-read!: Uniform Array. * uniform-array-write: Uniform Array. -* uniform-vector-fill!: Uniform Array. -* uniform-vector-length: Uniform Array. -* uniform-vector-read!: Uniform Array. -* uniform-vector-ref: Uniform Array. -* uniform-vector-set!: Uniform Array. -* uniform-vector-write: Uniform Array. +* uniform-vector-fill!: Uniform Array. | * untrace: Debugging Scheme Code. * user-interrupt: Interrupts. * usr:lib: Dynamic Linking. @@ -7802,13 +8066,16 @@ This is an alphabetical list of all the global variables in SCM. * Menu: +* $pi: Numeric. * *argv*: SCM Variables. * *execpath: Embedding SCM. * *interactive* <1>: Internal State. * *interactive*: SCM Variables. * *load-pathname*: Miscellaneous Procedures. -* *R4RS-macro*: SCM Variables. +* *load-reader*: Line Numbers. | * *scm-version*: Internal State. +* *slib-load-reader*: Line Numbers. | +* *syntax-rules*: SCM Variables. | * af_inet: Host Data. * af_unix: Host Data. * BOOL_F: Immediates. @@ -7828,6 +8095,7 @@ This is an alphabetical list of all the global variables in SCM. * open_both: Files and Ports. * open_read: Files and Ports. * open_write: Files and Ports. +* pi: Numeric. * SCHEME_LIBRARY_PATH: SCM Variables. * SCM_INIT_PATH: SCM Variables. * symhash: Evaluation. @@ -7911,6 +8179,7 @@ This is an alphabetical list of data types and feature names in SCM. * tc7_subr_2: Subr Cells. * tc7_subr_2o: Subr Cells. * tc7_subr_3: Subr Cells. +* tc7_svect: Header Cells. | * tc7_uvect: Header Cells. * tc7_vector: Header Cells. * tc_dblc: Smob Cells. @@ -7926,174 +8195,189 @@ Concept Index * Menu: -* !#: MS-DOS Compatible Scripts. | -* !#.exe: MS-DOS Compatible Scripts. | -* #!: MS-DOS Compatible Scripts. | -* #!.bat: MS-DOS Compatible Scripts. | -* array <1>: Conventional Arrays. | -* array: Build Options. | -* array-for-each: Build Options. | -* arrays: Build Options. | -* bignums: Build Options. | +* !#: MS-DOS Compatible Scripts. +* !#.exe: MS-DOS Compatible Scripts. +* #!: MS-DOS Compatible Scripts. +* #!.bat: MS-DOS Compatible Scripts. +* array <1>: Conventional Arrays. +* array: Build Options. +* array-for-each: Build Options. +* arrays: Build Options. +* bignums: Build Options. * callbacks: Callbacks. -* careful-interrupt-masking: Build Options. | -* cautious: Build Options. | -* cheap-continuations: Build Options. | -* compiled-closure: Build Options. | +* careful-interrupt-masking: Build Options. +* cautious: Build Options. +* cheap-continuations: Build Options. +* compiled-closure: Build Options. * continuations: Continuations. -* curses: Build Options. | -* debug: Build Options. | +* curses: Build Options. +* debug: Build Options. * documentation string: Syntax Extensions. -* dump: Build Options. | -* dynamic-linking: Build Options. | -* edit-line: Build Options. | +* dump: Build Options. +* dynamic-linking: Build Options. +* ecache: Memory Management for Environments. | +* edit-line: Build Options. * Embedding SCM: Embedding SCM. -* engineering-notation: Build Options. | -* Exrename: Bibliography. | +* engineering-notation: Build Options. +* environments: Memory Management for Environments. | +* exchanger: Process Synchronization. | +* Exrename: Bibliography. * Extending Scm: Compiling and Linking Custom Files. * foo.c: Compiling and Linking Custom Files. -* generalized-c-arguments: Build Options. | -* GUILE: Bibliography. | -* i/o-extensions: Build Options. | -* IEEE: Bibliography. | -* inexact: Build Options. | -* JACAL: Bibliography. | -* lit: Build Options. | -* macro: Build Options. | -* mysql: Build Options. | -* no-heap-shrink: Build Options. | -* none: Build Options. | -* posix: Build Options. | -* R4RS: Bibliography. | -* R5RS: Bibliography. | -* reckless: Build Options. | -* record: Build Options. | -* regex: Build Options. | -* rev2-procedures: Build Options. | -* SICP: Build Options. | -* sicp: Build Options. | -* SICP: Bibliography. | +* generalized-c-arguments: Build Options. +* graphics: Packages. +* hobbit: Packages. | +* i/o-extensions: Build Options. +* IEEE: Bibliography. +* inexact: Build Options. +* JACAL: Bibliography. +* lit: Build Options. +* macro: Build Options. +* memory management: Memory Management for Environments. | +* mysql: Build Options. +* no-heap-shrink: Build Options. +* NO_ENV_CACHE: Memory Management for Environments. | +* none: Build Options. +* posix: Build Options. +* R4RS: Bibliography. +* R5RS: Bibliography. +* reckless: Build Options. +* record: Build Options. +* regex: Build Options. +* rev2-procedures: Build Options. +* SchemePrimer: Bibliography. +* SICP: Build Options. +* sicp: Build Options. +* SICP: Bibliography. * signals: Signals. -* Simply: Bibliography. | -* single-precision-only: Build Options. | -* SLIB: Bibliography. | -* socket: Build Options. | -* stack-limit: Build Options. | -* tick-interrupts: Build Options. | -* turtlegr: Build Options. | -* unix: Build Options. | -* windows: Build Options. | -* x: Build Options. | -* xlib: Build Options. | +* Simply: Bibliography. +* single-precision-only: Build Options. +* SLIB: Bibliography. +* socket: Build Options. +* stack-limit: Build Options. +* tick-interrupts: Build Options. +* turtlegr: Build Options. +* unix: Build Options. +* windows: Build Options. +* X: Packages. +* x <1>: Packages. +* x: Build Options. +* xlib: Packages. +* Xlib: Packages. +* xlib: Build Options. +* xlibscm: Packages. +* Xlibscm: Packages. Tag Table: -Node: Top229 -Node: Overview1521 -Node: Copying1832 -Node: SCM Features4894 -Node: SCM Authors6905 -Node: Bibliography7805 -Node: Installing SCM9676 -Node: Making SCM10191 -Node: SLIB11531 -Node: Building SCM13549 -Node: Invoking Build14091 -Node: Build Options16112 -Node: Compiling and Linking Custom Files33008 -Node: Installing Dynamic Linking34986 -Node: Configure Module Catalog36770 -Node: Saving Images38767 -Node: Automatic C Preprocessor Definitions39443 -Node: Problems Compiling42659 -Node: Problems Linking44785 -Node: Problems Running45087 -Node: Testing47643 -Node: Reporting Problems50980 -Node: Operational Features51823 -Node: Invoking SCM52187 -Node: SCM Options53748 -Node: Invocation Examples57904 -Node: SCM Variables58856 -Node: SCM Session60306 -Node: Editing Scheme Code61429 -Node: Debugging Scheme Code63563 -Node: Errors67202 -Node: Memoized Expressions71502 -Node: Internal State73866 -Node: Scripting76918 -Node: Unix Scheme Scripts77212 -Node: MS-DOS Compatible Scripts80423 -Node: Unix Shell Scripts82236 -Node: The Language84425 -Node: Standards Compliance85000 -Node: Miscellaneous Procedures87415 -Node: Time90765 -Node: Interrupts91759 -Node: Process Synchronization95369 -Node: Files and Ports95909 -Node: Soft Ports101092 -Node: Syntax Extensions102768 -Node: Low Level Syntactic Hooks109753 -Node: Syntactic Hooks for Hygienic Macros113664 -Node: Packages120817 -Node: Compiling And Linking121493 -Node: Dynamic Linking123530 -Node: Dump128154 -Node: Numeric132264 -Node: Arrays133820 -Node: Conventional Arrays134037 -Node: Array Mapping140675 -Node: Uniform Array142909 -Node: Bit Vectors148821 -Node: I/O-Extensions150086 -Node: Posix Extensions158379 -Node: Regular Expression Pattern Matching169109 -Node: Line Editing173064 -Node: Curses174410 -Node: Output Options Setting175333 -Node: Terminal Mode Setting177981 -Node: Window Manipulation181059 -Node: Output184519 -Node: Input188145 -Node: Curses Miscellany189172 -Node: Sockets190596 -Node: Host Data190920 -Node: Internet Addresses and Socket Names194068 -Node: Socket195602 -Node: The Implementation202838 -Node: Data Types203097 -Node: Immediates203918 -Node: Cells208254 -Node: Header Cells210346 -Node: Subr Cells213327 -Node: Ptob Cells215545 -Node: Smob Cells217091 -Node: Data Type Representations220290 -Node: Operations224909 -Node: Garbage Collection225495 -Node: Marking Cells226116 -Node: Sweeping the Heap228218 -Node: Memory Management for Environments229163 -Node: Signals233720 -Node: C Macros235264 -Node: Changing Scm236387 -Node: Defining Subrs240660 -Node: Defining Smobs242537 -Node: Defining Ptobs245521 -Node: Allocating memory246698 -Node: Embedding SCM248860 -Node: Callbacks256514 -Node: Type Conversions258317 -Node: Continuations261874 -Node: Evaluation266088 -Node: Program Self-Knowledge271253 -Node: File-System Habitat271499 -Node: Executable Pathname275099 -Node: Script Support276718 -Node: Improvements To Make278036 -Node: Finishing Dynamic Linking280067 -Node: Index287814 +Node: Top203 +Node: Overview1481 +Node: SCM Features1792 +Node: SCM Authors3804 +Node: Copying4742 +Node: Bibliography7831 +Node: Installing SCM9699 +Node: Making SCM10214 +Node: SLIB11131 +Node: Building SCM13149 +Node: Invoking Build13723 +Node: Build Options16516 +Node: Compiling and Linking Custom Files29598 +Node: Installing Dynamic Linking31577 +Node: Configure Module Catalog33361 +Node: Saving Images35358 +Node: Automatic C Preprocessor Definitions36033 +Node: Problems Compiling39541 +Node: Problems Linking41194 +Node: Problems Running41459 +Node: Testing43567 +Node: Reporting Problems46654 +Node: Operational Features47577 +Node: Invoking SCM47941 +Node: SCM Options49585 +Node: Invocation Examples54026 +Node: SCM Variables54978 +Node: SCM Session56487 +Node: Editing Scheme Code58010 +Node: Debugging Scheme Code60153 +Node: Errors63776 +Node: Memoized Expressions68075 +Node: Internal State70439 +Node: Scripting73727 +Node: Unix Scheme Scripts74021 +Node: MS-DOS Compatible Scripts77233 +Node: Unix Shell Scripts79045 +Node: The Language81235 +Node: Standards Compliance81890 +Node: Miscellaneous Procedures84304 +Node: Time87460 +Node: Interrupts88454 +Node: Process Synchronization94464 +Node: Files and Ports97244 +Node: Line Numbers104204 +Node: Soft Ports108304 +Node: Syntax Extensions110296 +Node: Low Level Syntactic Hooks119654 +Node: Syntactic Hooks for Hygienic Macros126507 +Node: Packages133588 +Node: Dynamic Linking134544 +Node: Dump139232 +Node: Numeric143350 +Node: Arrays145077 +Node: Conventional Arrays145366 +Node: Array Mapping152015 +Node: Uniform Array154278 +Node: Bit Vectors160302 +Node: Records161567 +Node: I/O-Extensions163253 +Node: Posix Extensions172179 +Node: Unix Extensions182353 +Node: Regular Expression Pattern Matching184358 +Node: Line Editing188387 +Node: Curses189733 +Node: Output Options Setting190656 +Node: Terminal Mode Setting193305 +Node: Window Manipulation196383 +Node: Output199843 +Node: Input203469 +Node: Curses Miscellany204496 +Node: Sockets205920 +Node: Host Data206244 +Node: Internet Addresses and Socket Names209392 +Node: Socket210926 +Node: The Implementation218163 +Node: Data Types218422 +Node: Immediates219243 +Node: Cells223579 +Node: Header Cells225671 +Node: Subr Cells228892 +Node: Ptob Cells231110 +Node: Smob Cells232649 +Node: Data Type Representations235845 +Node: Operations240503 +Node: Garbage Collection241089 +Node: Marking Cells241710 +Node: Sweeping the Heap243812 +Node: Memory Management for Environments244757 +Node: Signals249314 +Node: C Macros250858 +Node: Changing Scm251981 +Node: Defining Subrs256253 +Node: Defining Smobs258130 +Node: Defining Ptobs261265 +Node: Allocating memory262442 +Node: Embedding SCM264833 +Node: Callbacks272486 +Node: Type Conversions274289 +Node: Continuations277845 +Node: Evaluation282059 +Node: Program Self-Knowledge287222 +Node: File-System Habitat287468 +Node: Executable Pathname291068 +Node: Script Support292686 +Node: Improvements To Make294004 +Node: Finishing Dynamic Linking296036 +Node: Index303782 End Tag Table |