diff options
Diffstat (limited to 'scm.info')
| -rw-r--r-- | scm.info | 3967 |
1 files changed, 2142 insertions, 1825 deletions
@@ -1,4 +1,4 @@ -This is scm.info, produced by makeinfo version 4.0 from scm.texi. | +This is scm.info, produced by makeinfo version 4.7 from scm.texi. | INFO-DIR-SECTION The Algorithmic Language Scheme START-INFO-DIR-ENTRY @@ -9,10 +9,10 @@ END-INFO-DIR-ENTRY File: scm.info, Node: Top, Next: Overview, Prev: (dir), Up: (dir) This manual documents the SCM Scheme implementation. SCM version -5d9 was released November 2003. The most recent information about SCM | -can be found on SCM's "WWW" home page: +5e1 was released June 2005. The most recent information about SCM can | +be found on SCM's "WWW" home page: | - <http://swissnet.ai.mit.edu/~jaffer/SCM> + `http://swiss.csail.mit.edu/~jaffer/SCM' | Copyright (C) 1990-1999 Free Software Foundation @@ -43,8 +43,8 @@ approved by the author. File: scm.info, Node: Overview, Next: Installing SCM, Prev: Top, Up: Top -Overview -******** +1 Overview | +********** | Scm is a portable Scheme implementation written in C. Scm provides a machine independent platform for [JACAL], a symbolic algebra system. @@ -59,8 +59,8 @@ machine independent platform for [JACAL], a symbolic algebra system. File: scm.info, Node: SCM Features, Next: SCM Authors, Prev: Overview, Up: Overview -Features -======== +1.1 Features | +============ | * Conforms to Revised^5 Report on the Algorithmic Language Scheme [R5RS] and the [IEEE] P1178 specification. @@ -109,8 +109,8 @@ Features File: scm.info, Node: SCM Authors, Next: Copying, Prev: SCM Features, Up: Overview -Authors -======= +1.2 Authors | +=========== | Aubrey Jaffer (agj @ alum.mit.edu) Most of SCM. @@ -138,16 +138,70 @@ file `ChangeLog', a log of changes that have been made to scm. File: scm.info, Node: Copying, Next: Bibliography, Prev: SCM Authors, Up: Overview -Copyright -========= +1.3 Copyright | +============= | Authors have assigned their SCM copyrights to: - Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111, USA +* Menu: | + | +* The SCM License:: | +* SIOD copyright:: | + | + +File: scm.info, Node: The SCM License, Next: SIOD copyright, Prev: Copying, Up: Copying + | +1.3.1 The SCM License | +--------------------- | + | +The license of SCM consists of the GNU GPL plus a special statement | +giving blanket permission to link with non-free software. This is the | +license statement as found in any individual file that it applies to: | + | + This program is free software; you can redistribute it and/or | + modify it under the terms of the GNU General Public License as | + published by the Free Software Foundation; either version 2, or | + (at your option) any later version. | + | + This program is distributed in the hope that it will be useful, but | + WITHOUT ANY WARRANTY; without even the implied warranty of | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | + General Public License for more details. | + | + You should have received a copy of the GNU General Public License | + along with this software; see the file COPYING. If not, write to | + the Free Software Foundation, Inc., 59 Temple Place, Suite 330, | + Boston, MA 02111-1307 USA | + | + As a special exception, the Free Software Foundation gives | + permission for additional uses of the text contained in its | + release of SCM. | + | + The exception is that, if you link the SCM library with other | + files to produce an executable, this does not by itself cause the | + resulting executable to be covered by the GNU General Public | + License. Your use of that executable is in no way restricted on | + account of linking the SCM library code into it. | + | + This exception does not however invalidate any other reasons why | + the executable file might be covered by the GNU General Public | + License. | + | + This exception applies only to the code released by the Free | + Software Foundation under the name SCM. If you copy code from | + other Free Software Foundation releases into a copy of SCM, as the | + General Public License permits, the exception does not apply to | + the code that you add in this way. To avoid misleading anyone as | + to the status of such modified files, you must delete this | + exception notice from them. | + | + If you write modifications of your own for SCM, it is your choice | + whether to permit this exception to apply to your modifications. | + If you do not wish that, delete this exception notice. | + | 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 @@ -176,14 +230,15 @@ 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 -============== + +File: scm.info, Node: SIOD copyright, Prev: The SCM License, Up: Copying + | +1.3.2 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 @@ -212,8 +267,8 @@ Cambridge, MA 02138 File: scm.info, Node: Bibliography, Prev: Copying, Up: Overview -Bibliography -============ +1.4 Bibliography | +================ | [IEEE] `IEEE Standard 1178-1990. IEEE Standard for the Scheme @@ -276,8 +331,8 @@ Bibliography File: scm.info, Node: Installing SCM, Next: Operational Features, Prev: Overview, Up: Top -Installing SCM -************** +2 Installing SCM | +**************** | * Menu: @@ -297,8 +352,8 @@ Installing SCM File: scm.info, Node: Making SCM, Next: SLIB, Prev: Installing SCM, Up: Installing SCM -Making SCM -========== +2.1 Making SCM | +============== | The SCM distribution has "Makefile" which contains rules for making "scmlit", a "bare-bones" version of SCM sufficient for running `build'. @@ -309,7 +364,7 @@ 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, there are several ways to proceed: - * Use the build (http://swissnet.ai.mit.edu/~jaffer/buildscm.html) + * Use the build (http://swiss.csail.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 @@ -323,8 +378,8 @@ need to compile SCM without build, there are several ways to proceed: File: scm.info, Node: SLIB, Next: Building SCM, Prev: Making SCM, Up: Installing SCM -SLIB -==== +2.2 SLIB | +======== | [SLIB] is a portable Scheme library meant to provide compatibility and utility functions for all standard Scheme implementations. Although @@ -332,18 +387,18 @@ 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/slib3a1.tar.gz | + * swiss.csail.mit.edu:/pub/scm/slib3a2.tar.gz | - * ftp.gnu.org:/pub/gnu/jacal/slib3a1.tar.gz | + * ftp.gnu.org:/pub/gnu/jacal/slib3a2.tar.gz | - * ftp.cs.indiana.edu:/pub/scheme-repository/imp/slib3a1.tar.gz | + * ftp.cs.indiana.edu:/pub/scheme-repository/imp/slib3a2.tar.gz | -Unpack SLIB (`tar xzf slib3a1.tar.gz' or `unzip -ao slib3a1.zip') in an | +Unpack SLIB (`tar xzf slib3a2.tar.gz' or `unzip -ao slib3a2.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 `Init5d9.scm' is | +(this is the same directory as where the file `Init5e1.scm' is | installed). `require.scm' should have the contents: (define (library-vicinity) "/usr/local/lib/slib/") @@ -367,8 +422,8 @@ overrides `require.scm'. Again, absolute pathnames are recommended. File: scm.info, Node: Building SCM, Next: Installing Dynamic Linking, Prev: SLIB, Up: Installing SCM -Building SCM -============ +2.3 Building SCM | +================ | The file "build" loads the file "build.scm", which constructs a relational database of how to compile and link SCM executables. @@ -386,8 +441,8 @@ ai.mit.edu. File: scm.info, Node: Invoking Build, Next: Build Options, Prev: Building SCM, Up: Building SCM -Invoking Build --------------- +2.3.1 Invoking Build | +-------------------- | The _all_ method will also work for MS-DOS and unix. Use the _all_ method if you encounter problems with `build'. @@ -405,6 +460,7 @@ _all_ `(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. @@ -414,7 +470,7 @@ script with the `arrays', `inexact', and `bignums' options as defaults. # unix (linux) script created by SLIB/batch # ================ Write file with C defines rm -f scmflags.h - echo '#define IMPLINIT "Init5d9.scm"'>>scmflags.h | + echo '#define IMPLINIT "Init5e1.scm"'>>scmflags.h | echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h echo '#define ARRAYS'>>scmflags.h @@ -433,7 +489,7 @@ in the `-p' or `--platform=' option. # unix (darwin) script created by SLIB/batch # ================ Write file with C defines rm -f scmflags.h - echo '#define IMPLINIT "Init5d9.scm"'>>scmflags.h | + echo '#define IMPLINIT "Init5e1.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 @@ -443,18 +499,18 @@ in the `-p' or `--platform=' option. File: scm.info, Node: Build Options, Next: Compiling and Linking Custom Files, Prev: Invoking Build, Up: Building SCM -Build Options -------------- +2.3.2 Build Options | +------------------- | The options to "build" specify what, where, and how to build a SCM program or dynamically linked module. These options are unrelated to the SCM command line options. - - Build Option: -p PLATFORM-NAME - - Build Option: --platform=PLATFORM-NAME + -- Build Option: -p PLATFORM-NAME | + -- 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: @@ -507,11 +563,11 @@ the SCM command line options. vms-gcc vax vms gcc | watcom-9.0 i386 ms-dos wcc386p | - - Build Option: -f PATHNAME + -- Build Option: -f PATHNAME | specifies that the build options contained in PATHNAME be spliced into the argument list at this point. The use of option files can | separate functional features from platform-specific ones. | - | + The `Makefile' calls out builds with the options in `.opt' files: | | `dlls.opt' | @@ -527,65 +583,65 @@ the SCM command line options. Options for pgscm, which instruments C functions. | | `udscm4.opt' | - Options for targets udscm4 and myscm4 (scm). | + Options for targets udscm4 and dscm4 (scm). | | `udscm5.opt' | - Options for targets udscm5 and myscm5 (scm). | + Options for targets udscm5 and dscm5 (scm). | | The Makefile creates options files it depends on only if they do | not already exist. | - - - Build Option: -o FILENAME - - Build Option: --outname=FILENAME + | + -- Build Option: -o FILENAME | + -- Build Option: --outname=FILENAME | specifies that the compilation should produce an executable or object name of FILENAME. The default is `scm'. Executable suffixes will be added if neccessary, e.g. `scm' => `scm.exe'. - - Build Option: -l LIBNAME ... - - Build Option: --libraries=LIBNAME + -- Build Option: -l LIBNAME ... | + -- Build Option: --libraries=LIBNAME | specifies that the LIBNAME should be linked with the executable produced. If compile flags or include directories (`-I') are needed, they are automatically supplied for compilations. The `c' library is always included. SCM "features" specify any libraries they need; so you shouldn't need this option often. - - Build Option: -D DEFINITION ... - - Build Option: --defines=DEFINITION + -- Build Option: -D DEFINITION ... | + -- Build Option: --defines=DEFINITION | specifies that the DEFINITION should be made in any C source compilations. If compile flags or include directories (`-I') are needed, they are automatically supplied for compilations. SCM "features" specify any flags they need; so you shouldn't need this option often. - - Build Option: --compiler-options=FLAG + -- Build Option: --compiler-options=FLAG | specifies that that FLAG will be put on compiler command-lines. - - Build Option: --linker-options=FLAG + -- Build Option: --linker-options=FLAG | specifies that that FLAG will be put on linker command-lines. - - Build Option: -s PATHNAME - - Build Option: --scheme-initial=PATHNAME + -- Build Option: -s PATHNAME | + -- Build Option: --scheme-initial=PATHNAME | specifies that PATHNAME should be the default location of the SCM - initialization file `Init5d9.scm'. SCM tries several likely | + initialization file `Init5e1.scm'. SCM tries several likely | locations before resorting to PATHNAME (*note File-System Habitat::). If not specified, the current directory (where build is building) is used. - - Build Option: -c PATHNAME ... - - Build Option: --c-source-files=PATHNAME + -- Build Option: -c PATHNAME ... | + -- Build Option: --c-source-files=PATHNAME | specifies that the C source files PATHNAME ... are to be compiled. - - Build Option: -j PATHNAME ... - - Build Option: --object-files=PATHNAME + -- Build Option: -j PATHNAME ... | + -- Build Option: --object-files=PATHNAME | specifies that the object files PATHNAME ... are to be linked. - - Build Option: -i CALL ... - - Build Option: --initialization=CALL + -- Build Option: -i CALL ... | + -- Build Option: --initialization=CALL | specifies that the C functions CALL ... are to be invoked during initialization. - - Build Option: -t BUILD-WHAT - - Build Option: --type=BUILD-WHAT + -- Build Option: -t BUILD-WHAT | + -- Build Option: --type=BUILD-WHAT | specifies in general terms what sort of thing to build. The choices are: `exe' @@ -602,8 +658,8 @@ the SCM command line options. The default is to build an executable. - - Build Option: -h BATCH-SYNTAX - - Build Option: -batch-dialect=BATCH-SYNTAX + -- Build Option: -h BATCH-SYNTAX | + -- Build Option: -batch-dialect=BATCH-SYNTAX | specifies how to build. The default is to create a batch file for the host system. The SLIB file `batch.scm' knows how to create batch files for: @@ -624,13 +680,13 @@ the SCM command line options. This option outputs Scheme code. - - Build Option: -w BATCH-FILENAME - - Build Option: -script-name=BATCH-FILENAME + -- Build Option: -w BATCH-FILENAME | + -- Build Option: -script-name=BATCH-FILENAME | specifies where to write the build script. The default is to display it on `(current-output-port)'. - - Build Option: -F FEATURE ... - - Build Option: --features=FEATURE + -- Build Option: -F FEATURE ... | + -- Build Option: --features=FEATURE | specifies to build the given features into the executable. The defined features are: @@ -684,6 +740,9 @@ the SCM command line options. `careful-interrupt-masking', and `stack-limit'; uses `-g' flags for debugging SCM source code. + "differ" | + Sequence comparison | + | "dump" Convert a running scheme program into an executable file. @@ -768,7 +827,8 @@ the SCM command line options. numbers. "socket" - BSD "socket" interface. + BSD "socket" interface. Socket addr functions require | + inexacts or bignums for 32-bit precision. | "stack-limit" Use to enable checking for stack overflow. Define value of @@ -788,6 +848,9 @@ the SCM command line options. Those unix features which have not made it into the Posix specs: nice, acct, lstat, readlink, symlink, mknod and sync. + "wb" | + WB database with relational wrapper. | + | "windows" Microsoft Windows executable. @@ -801,8 +864,8 @@ the SCM command line options. File: scm.info, Node: Compiling and Linking Custom Files, Prev: Build Options, Up: Building SCM -Compiling and Linking Custom Files ----------------------------------- +2.3.3 Compiling and Linking Custom Files | +---------------------------------------- | A correspondent asks: @@ -811,16 +874,15 @@ 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). -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: +(*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 rm -f scmflags.h - echo '#define IMPLINIT "/home/jaffer/scm/Init5d9.scm"'>>scmflags.h | + echo '#define IMPLINIT "/home/jaffer/scm/Init5e1.scm"'>>scmflags.h | echo '#define COMPILED_INITS init_foo();'>>scmflags.h echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h @@ -836,7 +898,7 @@ To make a dynamically loadable object file use the `-t dll' option: -| #! /bin/sh rm -f scmflags.h - echo '#define IMPLINIT "/home/jaffer/scm/Init5d9.scm"'>>scmflags.h | + echo '#define IMPLINIT "/home/jaffer/scm/Init5e1.scm"'>>scmflags.h | echo '#define BIGNUMS'>>scmflags.h echo '#define FLOATS'>>scmflags.h echo '#define ARRAYS'>>scmflags.h @@ -852,8 +914,8 @@ add a compiled dll file to SLIB's catalog. File: scm.info, Node: Installing Dynamic Linking, Next: Configure Module Catalog, Prev: Building SCM, Up: Installing SCM -Installing Dynamic Linking -========================== +2.4 Installing Dynamic Linking | +============================== | Dynamic linking has not been ported to all platforms. Operating systems in the BSD family (a.out binary format) can usually be ported to "DLD". @@ -892,15 +954,15 @@ These notes about using libdl on SunOS are from `gcc.info': File: scm.info, Node: Configure Module Catalog, Next: Saving Images, Prev: Installing Dynamic Linking, Up: Installing SCM -Configure Module Catalog -======================== +2.5 Configure Module Catalog | +============================ | The SLIB module "catalog" can be extended to define other `require'-able packages by adding calls to the Scheme source file `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'. @@ -921,7 +983,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. @@ -929,7 +991,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 @@ -942,8 +1004,8 @@ Remember to delete the file `slibcat' after modifying the file File: scm.info, Node: Saving Images, Next: Automatic C Preprocessor Definitions, Prev: Configure Module Catalog, Up: Installing SCM -Saving Images -============= +2.6 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 @@ -959,8 +1021,8 @@ file from emacs. File: scm.info, Node: Automatic C Preprocessor Definitions, Next: Problems Compiling, Prev: Saving Images, Up: Installing SCM -Automatic C Preprocessor Definitions -==================================== +2.7 Automatic C Preprocessor Definitions | +======================================== | These `#defines' are automatically provided by preprocessors of various C compilers. SCM uses the presence or absence of these definitions to @@ -990,7 +1052,7 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of __USE_POSIX ?? __WATCOMC__ Watcom C on MS-DOS __ZTC__ Zortech C - + _AIX AIX operating system __APPLE__ Apple Darwin AMIGA SAS/C 5.10 or Dice C on AMIGA @@ -1010,6 +1072,7 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of __NetBSD__ NetBSD nosve Control Data NOS/VE SVR2 System V Revision 2. + sun SunOS | __SVR4 SunOS THINK_C developement environment for the Macintosh ultrix VAX with ULTRIX operating system. @@ -1024,7 +1087,7 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of _WIN32 MS VisualC++ 4.2 and Cygwin (Win32 API) _WIN32_WCE MS Windows CE vms (and VMS) VAX-11 C under VMS. - + __alpha DEC Alpha processor __alpha__ DEC Alpha processor hp9000s800 HP RISC processor @@ -1048,8 +1111,8 @@ lines or add a `#define FLAG' line to `scmfig.h' or the beginning of File: scm.info, Node: Problems Compiling, Next: Problems Linking, Prev: Automatic C Preprocessor Definitions, Up: Installing SCM -Problems Compiling -================== +2.8 Problems Compiling | +====================== | FILE PROBLEM / MESSAGE HOW TO FIX *.c include file not found. Correct the status of @@ -1081,8 +1144,8 @@ scl.c syntax error. #define SYSTNAME to your system File: scm.info, Node: Problems Linking, Next: Problems Running, Prev: Problems Compiling, Up: Installing SCM -Problems Linking -================ +2.9 Problems Linking | +==================== | PROBLEM HOW TO FIX _sin etc. missing. Uncomment LIBS in makefile. @@ -1090,8 +1153,8 @@ _sin etc. missing. Uncomment LIBS in makefile. File: scm.info, Node: Problems Running, Next: Testing, Prev: Problems Linking, Up: Installing SCM -Problems Running -================ +2.10 Problems Running | +===================== | PROBLEM HOW TO FIX Opening message and then machine Change memory model option to C @@ -1110,17 +1173,17 @@ remove <FLAG> in scmfig.h and Do so and recompile files. recompile scm. add <FLAG> in scmfig.h and recompile scm. -ERROR: Init5d9.scm not found. Assign correct IMPLINIT in makefile | +ERROR: Init5e1.scm not found. Assign correct IMPLINIT in makefile | or scmfig.h. Define environment variable SCM_INIT_PATH to be the full - pathname of Init5d9.scm. | + pathname of Init5e1.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 - Init5d9.scm to point to library or | + Init5e1.scm to point to library or | remove. Make sure the value of (library-vicinity) has a trailing @@ -1129,8 +1192,8 @@ WARNING: require.scm not found. Define environment variable File: scm.info, Node: Testing, Next: Reporting Problems, Prev: Problems Running, Up: Installing SCM -Testing -======= +2.11 Testing | +============ | Loading `r4rstest.scm' in the distribution will run an [R4RS] conformance test on `scm'. @@ -1180,7 +1243,7 @@ Some symbol names print incorrectly. Change memory model option to C 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. `Init5d9.scm'). | +output files. `Init5e1.scm'). | Spaces or control characters appear Check character defines in in symbol names. `scmfig.h'. Negative numbers turn positive. Check SRS in `scmfig.h'. @@ -1195,13 +1258,14 @@ Sparc(SUN-4) heap is growing out of control This causes lots of stuff which should be collected to not be. 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. + exacerbated by using lots of call-with-current-continuations. A | + possible fix for dynthrow() is commented out in `continue.c'. | File: scm.info, Node: Reporting Problems, Prev: Testing, Up: Installing SCM -Reporting Problems -================== +2.12 Reporting Problems | +======================= | Reported problems and solutions are grouped under Compiling, Linking, Running, and Testing. If you don't find your problem listed there, you @@ -1226,8 +1290,8 @@ include: File: scm.info, Node: Operational Features, Next: The Language, Prev: Installing SCM, Up: Top -Operational Features -******************** +3 Operational Features | +********************** | * Menu: @@ -1238,6 +1302,7 @@ Operational Features * SCM Session:: * Editing Scheme Code:: * Debugging Scheme Code:: +* Debugging Continuations:: | * Errors:: * Memoized Expressions:: * Internal State:: @@ -1246,8 +1311,8 @@ Operational Features File: scm.info, Node: Invoking SCM, Next: SCM Options, Prev: Operational Features, Up: Operational Features -Invoking SCM -============ +3.1 Invoking SCM | +================ | scm [-a kbytes] [-muvbiq] [-version] [-help] [[-]-no-init-file] [-p int] [-r feature] [-h feature] @@ -1261,7 +1326,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 `Init5d9.scm') in platform-dependent directories relative | +file (usually `Init5e1.scm') in platform-dependent directories relative | to this directory. See *Note File-System Habitat:: for a blow-by-blow description. @@ -1270,12 +1335,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, `Init5d9.scm' checks to see if there is file | +command line, `Init5e1.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 file it is loaded. -`Init5d9.scm' then looks for command input from one of three sources: | +`Init5e1.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. @@ -1287,55 +1352,55 @@ Lexical Conventions. File: scm.info, Node: SCM Options, Next: Invocation Examples, Prev: Invoking SCM, Up: Operational Features -Options -======= +3.2 Options | +=========== | The options are processed in the order specified on the command line. - - Command Option: -a k + -- 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)'. - - Command Option: -no-init-file - - Command Option: --no-init-file + -- Command Option: -no-init-file | + -- Command Option: --no-init-file | Inhibits the loading of `ScmInit.scm' as described above. - - Command Option: --help + -- Command Option: --help | prints usage information and URI; then exit. - - Command Option: --version + -- Command Option: --version | prints version information and exit. - - Command Option: -r feature + -- 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, or r2rs; | 3, 3rs, or r3rs; 4, 4rs, or r4rs; 5, 5rs, or r5rs; `scm' will | require the features neccessary to support [R2RS]; [R3RS]; [R4RS]; | or [R5RS], respectively. | - - Command Option: -h feature + -- Command Option: -h feature | provides FEATURE. - - Command Option: -l filename - - Command Option: -f filename + -- 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: -d filename + -- Command Option: -d filename | Loads SLIB `databases' feature and opens FILENAME as a database. - - Command Option: -e expression - - Command Option: -c expression + -- 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 + -- 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::). @@ -1345,33 +1410,33 @@ The options are processed in the order specified on the command line. it is invoked. Otherwise the (new) command line is processed as usual when the saved image is invoked. - - Command Option: -p level + -- Command Option: -p level | sets the prolixity (verboseness) to LEVEL. This is the same as the `scm' command (verobse LEVEL). - - Command Option: -v + -- Command Option: -v | (verbose mode) specifies that `scm' will print prompts, evaluation times, notice of loading files, and garbage collection statistics. This is the same as `-p3'. - - Command Option: -q + -- Command Option: -q | (quiet mode) specifies that `scm' will print no extra information. This is the same as `-p0'. - - Command Option: -m + -- Command Option: -m | specifies that subsequent loads, evaluations, and user 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. - - Command Option: -u + -- 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' on the command line or from Scheme code. - - Command Option: -i + -- Command Option: -i | 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 @@ -1381,26 +1446,26 @@ The options are processed in the order specified on the command line. will assume that it should be interactive unless given a subsequent `-b' option. - - Command Option: -b + -- Command Option: -b | specifies that `scm' should run non-interactively. That means that `scm' will terminate after processing the command line or if there are errors. - - Command Option: -s + -- Command Option: -s | specifies, by analogy with `sh', that `scm' should run interactively and that further options are to be treated as program aguments. - - Command Option: - - - Command Option: -- + -- Command Option: - | + -- Command Option: -- | specifies that further options are to be treated as program aguments. File: scm.info, Node: Invocation Examples, Next: SCM Variables, Prev: SCM Options, Up: Operational Features -Invocation Examples -=================== +3.3 Invocation Examples | +======================= | `% scm foo.scm' Loads and executes the contents of `foo.scm' and then enters @@ -1431,39 +1496,39 @@ Invocation Examples File: scm.info, Node: SCM Variables, Next: SCM Session, Prev: Invocation Examples, Up: Operational Features -Environment Variables -===================== +3.4 Environment Variables | +========================= | - - Environment Variable: SCM_INIT_PATH + -- Environment Variable: SCM_INIT_PATH | is the pathname where `scm' will look for its initialization code. - The default is the file `Init5d9.scm' in the source directory. | + The default is the file `Init5e1.scm' in the source directory. | - - Environment Variable: SCHEME_LIBRARY_PATH + -- Environment Variable: SCHEME_LIBRARY_PATH | is the [SLIB] Scheme library directory. - - Environment Variable: HOME - is the directory where `Init5d9.scm' will look for the user | + -- Environment Variable: HOME | + is the directory where `Init5e1.scm' will look for the user | initialization file `ScmInit.scm'. - - Environment Variable: EDITOR + -- Environment Variable: EDITOR | is the name of the program which `ed' will call. If EDITOR is not defined, the default is `ed'. -Scheme Variables -================ +3.5 Scheme Variables | +==================== | - - Variable: *argv* + -- Variable: *argv* | 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: *syntax-rules* + -- 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' options. - - Variable: *interactive* + -- 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. @@ -1471,8 +1536,8 @@ Scheme Variables File: scm.info, Node: SCM Session, Next: Editing Scheme Code, Prev: SCM Variables, Up: Operational Features -SCM Session -=========== +3.6 SCM Session | +=============== | * Options, file loading and features can be specified from the command line. *Note System interface: (scm)System interface. @@ -1484,23 +1549,23 @@ SCM Session * Typing the interrupt character aborts evaluation of the current form and resumes the top level read-eval-print loop. - - Function: quit - - Function: quit n - - Function: exit - - Function: exit n + -- Function: quit | + -- Function: quit n | + -- Function: exit | + -- 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? + -- 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 + -- Function: program-arguments | Returns a list of strings of the arguments scm was called with. - - Function: getlogin + -- 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. @@ -1508,21 +1573,21 @@ SCM Session For documentation of the procedures `getenv' and `system' *Note System Interface: (slib)System Interface. - - Function: vms-debug + -- Function: vms-debug | If SCM is compiled under VMS this `vms-debug' will invoke the VMS debugger. File: scm.info, Node: Editing Scheme Code, Next: Debugging Scheme Code, Prev: SCM Session, Up: Operational Features -Editing Scheme Code -=================== +3.7 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. @@ -1561,10 +1626,10 @@ other systems: After editing, the modified file will be loaded. -File: scm.info, Node: Debugging Scheme Code, Next: Errors, Prev: Editing Scheme Code, Up: Operational Features - -Debugging Scheme Code -===================== +File: scm.info, Node: Debugging Scheme Code, Next: Debugging Continuations, Prev: Editing Scheme Code, Up: Operational Features + | +3.8 Debugging Scheme Code | +========================= | The `cautious' and `stack-limit' options of `build' (*note Build Options::) support debugging in Scheme. @@ -1600,34 +1665,53 @@ 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 + -- Macro: trace | With no arguments, makes sure that all the currently traced identifiers are traced (even if those identifiers have been redefined) and returns a list of the traced identifiers. - - Macro: untrace proc1 ... + -- Macro: untrace proc1 ... | Turns tracing off for its arguments. - - Macro: untrace + -- Macro: untrace | With no arguments, untraces all currently traced identifiers and returns a list of these formerly traced identifiers. The routines I use most frequently for debugging are: - - Procedure: print arg1 ... + -- Function: 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. - One can just insert `(print '<proc-name>' and `)' around an - expression in order to see its value as a program operates. + One can just insert `(print '<label>' and `)' around an expression | + in order to see its values as a program operates. | - - 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'. + -- Function: pprint arg1 ... | + `Pprint' pretty-prints (*note Pretty-Print: (slib)Pretty-Print.) | + all its arguments, separated by newlines. `Pprint' returns the | + value of the last argument. | + | + One can just insert `(pprint '<label>' and `)' around an | + expression in order to see its values as a program operates. | + _Note_ `pretty-print' does _not_ format procedures. | + | +When typing at top level, `pprint' is not a good way to see nested | +structure because it will return the last object pretty-printed, which | +could be large. `pp' is a better choice. | + | + -- Procedure: pp arg1 ... | + `Pprint' pretty-prints (*note Pretty-Print: (slib)Pretty-Print.) | + all its arguments, separated by newlines. `pp' returns | + `#<unspecified>'. | + | + -- Syntax: print-args name | + -- Syntax: print-args | + Writes NAME if supplied; then writes the names and values of the | + closest lexical bindings enclosing the call to `Print-args'. | (define (foo a b) (print-args foo) (+ a b)) (foo 3 6) @@ -1643,16 +1727,104 @@ 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 - swissnet.ai.mit.edu:/pub/scm/slib-psd1-3.tar.gz + http://swiss.csail.mit.edu/ftpdir/scm/slib-psd1-3.tar.gz | + swiss.csail.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 -File: scm.info, Node: Errors, Next: Memoized Expressions, Prev: Debugging Scheme Code, Up: Operational Features - -Errors -====== +File: scm.info, Node: Debugging Continuations, Next: Errors, Prev: Debugging Scheme Code, Up: Operational Features + | +3.9 Debugging Continuations | +=========================== | + | +These functions are defined in `debug.c', all operate on captured | +continuations: | + | + -- Procedure: frame-trace cont n | + Prints information about the code being executed and the | + environment scopes active for continuation frame N of continuation | + CONT. A "continuation frame" is an entry in the environment | + stack; a new frame is pushed when the environment is replaced or | + extended in a non-tail call context. Frame 0 is the top of the | + stack. | + | + -- Procedure: frame->environment cont n | + Prints the environment for continuation frame N of continuation | + CONT. This contains just the names, not the values, of the | + environment. | + | + -- Procedure: scope-trace env | + will print information about active lexical scopes for environment | + ENV. | + | + -- Procedure: frame-eval cont n expr | + Evaluates EXPR in the environment defined by continuation frame N | + of continuation CONT and returns the result. Values in the | + environment may be returned or SET!. | + | +*Note stack-trace: Errors. also now accepts an optional continuation | +argument. `stack-trace' differs from `frame-trace' in that it | +truncates long output using safeports and prints code from all | +available frames. | + | + (define k #f) | + (define (foo x y) | + (set! k (call-with-current-continuation identity)) | + #f) | + (let ((a 3) (b 4)) | + (foo a b) | + #f) | + (stack-trace k) | + -| | + ;STACK TRACE | + 1; ((#@set! #@k (#@call-with-current-continuation #@identity)) #f ... | + 2; (#@let ((a 3) (b 4)) (#@foo #@a #@b) #f) | + ... | + #t | + | + (frame-trace k 0) | + -| | + (#@call-with-current-continuation #@identity) | + ; in scope: | + ; (x y) procedure foo#<unspecified> | + | + (frame-trace k 1) | + -| | + ((#@set! #@k (#@call-with-current-continuation #@identity)) #f) | + ; in scope: | + ; (x y) procedure foo#<unspecified> | + | + (frame-trace k 2) | + -| | + (#@let ((a 3) (b 4)) (#@foo #@a #@b) #f) | + ; in scope: | + ; (a b . #@let)#<unspecified> | + | + (frame-trace k 3) | + -| | + (#@let ((a 3) (b 4)) (#@foo #@a #@b) #f) | + ; in top level environment. | + | + (frame->environment k 0) | + -| | + ((x y) 2 foo) | + | + (scope-trace (frame->environment k 0)) | + -| | + ; in scope: | + ; (x y) procedure foo#<unspecified> | + | + (frame-eval k 0 'x) => 3 | + | + (frame-eval k 0 '(set! x 8)) | + (frame-eval k 0 'x) => 8 | + | + +File: scm.info, Node: Errors, Next: Memoized Expressions, Prev: Debugging Continuations, Up: Operational Features + | +3.10 Errors | +=========== | A computer-language implementation designer faces choices of how reflexive to make the implementation in handling exceptions and errors; @@ -1729,7 +1901,7 @@ other error messages which are not treated specially. "PROF_SIGNAL" `(profile-alarm-interrupt)' - - Variable: errobj + -- Variable: errobj | When SCM encounters a non-fatal error, it aborts evaluation of the current form, prints a message explaining the error, and resumes the top level read-eval-print loop. The value of ERROBJ is the @@ -1739,8 +1911,8 @@ other error messages which are not treated specially. `errno' and `perror' report ANSI C errors encountered during a call to a system or library function. - - Function: errno - - Function: errno n + -- Function: errno | + -- 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 @@ -1748,7 +1920,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. @@ -1756,15 +1928,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 `Init5d9.scm'. | + containing the arguments. `warn' is defined in `Init5e1.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 `Init5d9.scm'. | + defined in `Init5e1.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 @@ -1779,17 +1951,17 @@ and conclude by calling `breakpoint' (*note Breakpoints: (slib)Breakpoints.). This allows the user to interract with SCM as with Lisp systems. - - Function: stack-trace + -- 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 `Init5d9.scm' for an example of the use | + and `#f' otherwise. See `Init5e1.scm' for an example of the use | of `stack-trace'. File: scm.info, Node: Memoized Expressions, Next: Internal State, Prev: Errors, Up: Operational Features -Memoized Expressions -==================== +3.11 Memoized Expressions | +========================= | SCM memoizes the address of each occurence of an identifier's value when first encountering it in a source expression. Subsequent executions of @@ -1807,7 +1979,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 `Init5d9.scm': | +For instance, `open-input-file' is defined as follows in `Init5e1.scm': | (define (open-input-file str) (or (open-file str OPEN_READ) @@ -1835,10 +2007,10 @@ If we cause `open-input-file' to execute other sections of code, they too become memoized: (open-input-file "foo.scm") => - + ERROR: No such file or directory ERROR: OPEN-INPUT-FILE couldn't open file "foo.scm" - + open-input-file => #<CLOSURE (str) (#@or (#@open-file #@0+0 #@open_read) (#@and (#@procedure? #@could-not-open) (could-not-open) #f) @@ -1847,36 +2019,36 @@ too become memoized: File: scm.info, Node: Internal State, Next: Scripting, Prev: Memoized Expressions, Up: Operational Features -Internal State -============== +3.12 Internal State | +=================== | - - Variable: *interactive* + -- Variable: *interactive* | 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 options are specified, the rules to determine interactivity are - more complicated; see `Init5d9.scm' for details. | + more complicated; see `Init5e1.scm' for details. | - - Function: abort + -- Function: abort | Resumes the top level Read-Eval-Print loop. - - Function: restart + -- Function: restart | Restarts the SCM program with the same arguments as it was originally invoked. All `-l' loaded files are loaded again; If 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 + -- 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 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 @@ -1900,20 +2072,20 @@ Internal State a message for each GC (*note Garbage Collection::) is printed; warnings issued for top-level symbols redefined. - - Function: gc + -- 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 | + -- 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. `5d9') of SCM. | + -- Constant: *scm-version* | + Contains the version string (e.g. `5e1') of SCM. | -Executable path ---------------- +3.12.1 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 @@ -1921,13 +2093,13 @@ 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. - - Function: execpath + -- Function: execpath | Returns the path (string) which SCM uses to find the executable 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. @@ -1937,8 +2109,8 @@ For other configuration constants and procedures *Note Configuration: File: scm.info, Node: Scripting, Prev: Internal State, Up: Operational Features -Scripting -========= +3.13 Scripting | +============== | * Menu: @@ -1949,14 +2121,14 @@ Scripting File: scm.info, Node: Unix Scheme Scripts, Next: MS-DOS Compatible Scripts, Prev: Scripting, Up: Scripting -Unix Scheme Scripts -------------------- +3.13.1 Unix Scheme Scripts | +-------------------------- | In reading this section, keep in mind that the first line of a script file has (different) meanings to SCM and the operating system (`execve'). - - file: #! interpreter \ ... + -- file: #! interpreter \ ... | On unix systems, a "Shell-Script" is a file (with execute permissions) whose first two characters are `#!'. The INTERPRETER argument must be the pathname of the program to process the rest @@ -1985,7 +2157,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'. @@ -1997,15 +2169,15 @@ POSIX shell-scripts if the first line is: The following Scheme-Script prints factorial of its argument: - #! /usr/local/bin/scm \ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9 + #! /usr/local/bin/scm \ %0 %* | - !# - + (define (fact.script args) (cond ((and (= 1 (length args)) (string->number (car args))) => (lambda (n) (print (fact n)) #t)) (else (fact.usage)))) - + (define (fact.usage) (print *argv*) (display "\ @@ -2014,9 +2186,9 @@ The following Scheme-Script prints factorial of its argument: " (current-error-port)) #f) - + (define (fact n) (if (< n 2) 1 (* n (fact (+ -1 n))))) - + (if *script* (exit (fact.script (list-tail *argv* *optind*)))) ./fact 32 @@ -2035,23 +2207,23 @@ usage information. File: scm.info, Node: MS-DOS Compatible Scripts, Next: Unix Shell Scripts, Prev: Unix Scheme Scripts, Up: Scripting -MS-DOS Compatible Scripts -------------------------- +3.13.2 MS-DOS Compatible Scripts | +-------------------------------- | It turns out that we can create scheme-scripts which run both under unix and MS-DOS. To implement this, I have written the MS-DOS programs: `#!.bat' and `!#.exe', which are available from: | -<http://swissnet.ai.mit.edu/ftpdir/scm/sharpbang.zip> | +`http://swiss.csail.mit.edu/ftpdir/scm/sharpbang.zip' | With these two programs installed in a `PATH' directory, we have the following syntax for <PROGRAM>.BAT files. - - file: #! interpreter \ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9 + -- file: #! interpreter \ %0 %* | The first two characters of the Scheme-Script are `#!'. The INTERPRETER can be either a unix style program path (using `/' between filename components) or a DOS program name or path. The rest of the first line of the Scheme-Script should be literally - `\ %0 %1 %2 %3 %4 %5 %6 %7 %8 %9', as shown. + `\ %0 %*', as shown. | If INTERPRETER has `/' in it, INTERPRETER is converted to a DOS style filename (`/' => `\'). @@ -2076,8 +2248,8 @@ systems. File: scm.info, Node: Unix Shell Scripts, Prev: MS-DOS Compatible Scripts, Up: Scripting -Unix Shell Scripts ------------------- +3.13.3 Unix Shell Scripts | +------------------------- | Scheme-scripts suffer from two drawbacks: * Some Unixes limit the length of the `#!' interpreter line to the @@ -2109,14 +2281,14 @@ argument, making it compatible with the scheme code of the previous example. #! /bin/sh - :;exec scm -e"(set! *script* \"$0\")" -l$0 $* - + :;exec scm -e"(set! *script* \"$0\")" -l$0 "$@" | + (define (fact.script args) (cond ((and (= 1 (length args)) (string->number (car args))) => (lambda (n) (print (fact n)) #t)) (else (fact.usage)))) - + (define (fact.usage) (print *argv*) (display "\ @@ -2125,9 +2297,9 @@ example. " (current-error-port)) #f) - + (define (fact n) (if (< n 2) 1 (* n (fact (+ -1 n))))) - + (if *script* (exit (fact.script (list-tail *argv* *optind*)))) ./fact 6 @@ -2136,8 +2308,8 @@ example. File: scm.info, Node: The Language, Next: Packages, Prev: Operational Features, Up: Top -The Language -************ +4 The Language | +************** | * Menu: @@ -2154,8 +2326,8 @@ The Language File: scm.info, Node: Standards Compliance, Next: Storage, Prev: The Language, Up: The Language -Standards Compliance -==================== +4.1 Standards Compliance | +======================== | Scm conforms to the `IEEE Standard 1178-1990. IEEE Standard for the Scheme Programming Language.' (*note Bibliography::), and `Revised(5) @@ -2216,7 +2388,7 @@ Optionals of [R5RS] not Supported by SCM See SLIB file `Template.scm'. `current-time' - *Note Time: (slib)Time. + *Note Time and Date: (slib)Time and Date. | `defmacro' *Note Defmacro: (slib)Defmacro. @@ -2274,10 +2446,10 @@ Optionals of [R5RS] not Supported by SCM File: scm.info, Node: Storage, Next: Time, Prev: Standards Compliance, Up: The Language -Storage -======= +4.2 Storage | +=========== | - - 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 @@ -2285,20 +2457,20 @@ Storage 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). (set! a-list (acons key datum a-list)) Adds a new association to a-list. - - Callback procedure: gc-hook ... + -- 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 @@ -2306,7 +2478,7 @@ Storage To remove the gc-hook, `(set! gc-hook #f)'. - - Function: add-finalizer object finalizer + -- 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 @@ -2332,38 +2504,38 @@ Storage File: scm.info, Node: Time, Next: Interrupts, Prev: Storage, Up: The Language -Time -==== +4.3 Time | +======== | - - Constant: internal-time-units-per-second + -- Constant: internal-time-units-per-second | Is the integer number of internal time units in a second. - - Function: get-internal-run-time + -- Function: get-internal-run-time | Returns the integer run time in internal time units from an unspecified starting time. The difference of two calls to `get-internal-run-time' divided by `internal-time-units-per-second' will give elapsed run time in seconds. - - Function: get-internal-real-time + -- Function: get-internal-real-time | Returns the integer time in internal time units from an unspecified starting time. The difference of two calls to `get-internal-real-time' divided by `interal-time-units-per-second' will give elapsed real time in seconds. - - Function: current-time + -- Function: current-time | Returns the time since 00:00:00 GMT, January 1, 1970, measured in - seconds. *Note current-time: (slib)Time. `current-time' is used - in *Note Time: (slib)Time. + seconds. *Note current-time: (slib)Time and Date. `current-time' | + is used in *Note Time and Date: (slib)Time and Date. | File: scm.info, Node: Interrupts, Next: Process Synchronization, Prev: Time, Up: The Language -Interrupts -========== +4.4 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. @@ -2373,22 +2545,22 @@ Interrupts `ticks' is supported if SCM is compiled with the `ticks' flag defined. - - Callback procedure: ticks-interrupt ... + -- Callback procedure: ticks-interrupt ... | Establishes a response for tick interrupts. Another tick interrupt will not occur unless `ticks' is called again. Program execution will resume if the handler returns. This procedure 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 @@ -2405,10 +2577,10 @@ Interrupts `milli-alarm', `virtual-alarm', and `profile-alarm' are supported only on systems providing the `setitimer' system call. - - Callback procedure: user-interrupt ... - - Callback procedure: alarm-interrupt ... - - Callback procedure: virtual-alarm-interrupt ... - - Callback procedure: profile-alarm-interrupt ... + -- Callback procedure: user-interrupt ... | + -- Callback procedure: alarm-interrupt ... | + -- Callback procedure: virtual-alarm-interrupt ... | + -- Callback procedure: profile-alarm-interrupt ... | Establishes a response for `SIGINT' (control-C interrupt) and `SIGALRM', `SIGVTALRM', and `SIGPROF' interrupts. Program execution will resume if the handler returns. This procedure @@ -2421,11 +2593,11 @@ Interrupts To unestablish a response for an interrupt set the handler symbol to `#f'. For instance, `(set! user-interrupt #f)'. - - Callback procedure: out-of-storage ... - - Callback procedure: could-not-open ... - - Callback procedure: end-of-program ... - - Callback procedure: hang-up ... - - Callback procedure: arithmetic-error ... + -- Callback procedure: out-of-storage ... | + -- Callback procedure: could-not-open ... | + -- Callback procedure: end-of-program ... | + -- Callback procedure: hang-up ... | + -- Callback procedure: arithmetic-error ... | Establishes a response for storage allocation error, file opening error, end of program, SIGHUP (hang up interrupt) and arithmetic errors respectively. This procedure should (abort) or some other @@ -2439,15 +2611,15 @@ Interrupts File: scm.info, Node: Process Synchronization, Next: Files and Ports, Prev: Interrupts, Up: The Language -Process Synchronization -======================= +4.5 Process Synchronization | +=========================== | -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 +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 + -- Function: make-exchanger obj | Returns a new exchanger with the argument OBJ as its initial content. @@ -2465,28 +2637,28 @@ operation. (set! lst (cdr lst)) ret))) (lambda () (and lst (queue lst)))))) - + (pop queue) => a - + (pop queue) => #f - - Function: make-arbiter name + -- 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: Eval and Load, Prev: Process Synchronization, Up: The Language -Files and Ports -=============== +4.6 Files and Ports | +=================== | These procedures generalize and extend the standard capabilities in *Note Ports: (r5rs)Ports. @@ -2501,11 +2673,11 @@ These procedures generalize and extend the standard capabilities in File: scm.info, Node: Opening and Closing, Next: Port Properties, Prev: Files and Ports, Up: Files and Ports -Opening and Closing -------------------- +4.6.1 Opening and Closing | +------------------------- | - - 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. @@ -2515,9 +2687,9 @@ Opening and Closing `try-open-file' is the primitive procedure; Do not redefine `try-open-file'! - - Constant: open_read - - Constant: open_write - - Constant: open_both + -- Constant: open_read | + -- Constant: open_write | + -- Constant: open_both | Contain modes strings specifying that a file is to be opened for reading, writing, and both reading and writing respectively. @@ -2525,108 +2697,108 @@ Opening and Closing 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: _ionbf 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 + -- 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 + -- Function: _exclusive modestr | Returns a version of MODESTR which when `open-file' is called with 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: open-ports + -- 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. - - Function: close-port port + -- Function: close-port port | Closes PORT. The same as close-input-port and close-output-port. File: scm.info, Node: Port Properties, Next: Port Redirection, Prev: Opening and Closing, Up: Files and Ports -Port Properties ---------------- +4.6.2 Port Properties | +--------------------- | - - Function: port-closed? port + -- Function: port-closed? port | Returns #t if PORT is closed. - - Function: port-type obj + -- 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: port-filename port + -- 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 + -- 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: freshline port + -- 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: isatty? port + -- Function: isatty? port | Returns `#t' if PORT is input or output to a serial non-file device. - - procedure: char-ready? - - procedure: char-ready? port + -- procedure: char-ready? | + -- 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. - If the PORT is at end of file then `char-ready?' returns `#t'. - 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 - 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 - `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 ... + If the PORT is at end of file then `char-ready?' returns `#t'. 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 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 `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 ... | 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'. + returned by `current-input-port'. File: scm.info, Node: Port Redirection, Next: Soft Ports, Prev: Port Properties, Up: Files and Ports -Port Redirection ----------------- +4.6.3 Port Redirection | +---------------------- | - - Function: current-error-port + -- 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 @@ -2635,14 +2807,14 @@ Port Redirection 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 + -- 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 @@ -2653,16 +2825,16 @@ Port Redirection File: scm.info, Node: Soft Ports, Prev: Port Redirection, Up: Files and Ports -Soft Ports ----------- +4.6.4 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 + VECTOR must be a vector of length 5. Its components are as | follows: 0. procedure accepting one character for output @@ -2696,16 +2868,16 @@ accepting or delivering characters. It allows emulation of I/O ports. (lambda () (char-upcase (read-char))) (lambda () (display "@" stdout))) "rw")) - + (write p p) => #<input-output-soft#\space45d10#\> File: scm.info, Node: Eval and Load, Next: Lexical Conventions, Prev: Files and Ports, Up: The Language -Eval and Load -============= +4.7 Eval and Load | +================= | - - 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'. @@ -2713,26 +2885,26 @@ Eval and Load affect the values returned by `current-input-port' and `current-output-port'. - - Variable: *load-pathname* + -- Variable: *load-pathname* | Is set to the pathname given as argument to `load', `try-load', 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: eval obj + -- 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: line-number + -- Function: line-number | Returns the current line number of the file currently being loaded. * Menu: @@ -2742,15 +2914,15 @@ Eval and Load File: scm.info, Node: Line Numbers, Prev: Eval and Load, Up: Eval and Load -Line Numbers ------------- +4.7.1 Line Numbers | +------------------ | Scheme code defined 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 + -- 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 @@ -2764,9 +2936,9 @@ 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 + -- Function: read-numbered port | Behaves like `read', except that | - | + bullet Load (read) sytnaxes are enabled. | | bullet every s-expression read will be replaced with a cons of | @@ -2774,22 +2946,22 @@ line-numbers in other positions is undefined. replacement is done only if PORT is a tracked port See *Note | Files and Ports::. | | - - - Function: integer->line-number int + | + -- 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 + -- Function: line-number->integer linum | Returns the value of line-number object LINUM as an integer. - - Function: line-number? obj + -- Function: line-number? obj | Returns true if and only if OBJ is a line-number object. - - Function: read-for-load port | + -- Function: read-for-load port | Behaves like `read', except that load syntaxes are enabled. | | - - Variable: *load-reader* - - Variable: *slib-load-reader* + -- 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 @@ -2802,8 +2974,8 @@ line-numbers in other positions is undefined. File: scm.info, Node: Lexical Conventions, Next: Syntax, Prev: Eval and Load, Up: The Language -Lexical Conventions -=================== +4.8 Lexical Conventions | +======================= | * Menu: @@ -2815,10 +2987,10 @@ Lexical Conventions File: scm.info, Node: Common-Lisp Read Syntax, Next: Load Syntax, Prev: Lexical Conventions, Up: Lexical Conventions | -Common-Lisp Read Syntax ------------------------ +4.8.1 Common-Lisp Read Syntax | +----------------------------- | - - Read syntax: #\token | + -- Read syntax: #\token | If TOKEN is a sequence of two or more digits, then this syntax is | equivalent to `#.(integer->char (string->number token 8))'. | @@ -2827,7 +2999,7 @@ Common-Lisp Read Syntax followed by a character, then a meta character is read. `c-' and | `m-' prefixes may be combined. | - - 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. @@ -2837,10 +3009,10 @@ Common-Lisp Read Syntax 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: #| 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. @@ -2850,7 +3022,7 @@ part of loading a file or string. This distinction was made so that | reading from a datafile would not be able to corrupt a scheme program | using `#.'. | - - Load syntax: #. expression | + -- Load syntax: #. expression | Is read as the object resulting from the evaluation of EXPRESSION. | This substitution occurs even inside quoted structure. | @@ -2861,42 +3033,42 @@ using `#.'. | #.(define foo 9) => #<unspecified> | '(#.foo #.(+ foo foo)) => (9 18) | | - - Load syntax: #' form | + -- Load syntax: #' form | is equivalent to FORM (for compatibility with common-lisp). | File: scm.info, Node: Load Syntax, Next: Documentation and Comments, Prev: Common-Lisp Read Syntax, Up: Lexical Conventions | -Load Syntax | ------------ | - | +4.8.2 Load Syntax | +----------------- | + "#!" is the unix mechanism for executing scripts. See *Note Unix Scheme Scripts:: for the full description of how this comment supports | scripting. | | - - Load syntax: #?line | - - Load syntax: #?column | + -- Load syntax: #?line | + -- Load syntax: #?column | Return integers for the current line and column being read during a | load. | | - - Load syntax: #?file | + -- Load syntax: #?file | Returns the string naming the file currently being loaded. This | path is the string passed to `load', possibly with `.scm' appended. | | File: scm.info, Node: Documentation and Comments, Next: Modifying Read Syntax, Prev: Load Syntax, Up: Lexical Conventions | -Documentation and Comments --------------------------- - - - procedure: procedure-documentation proc +4.8.3 Documentation and Comments | +-------------------------------- | + | + -- procedure: procedure-documentation proc | Returns the documentation string of PROC if it exists, or `#f' if not. If the body of a `lambda' (or the definition of a procedure) has more than one expression, and the first expression (preceeding any internal definitions) is a string, then that string is the - "documentation string" of that procedure. + "documentation string" of that procedure. (procedure-documentation (lambda (x) "Identity" x)) => "Identity" (define (square x) @@ -2905,24 +3077,24 @@ Documentation and Comments => #<unspecified> (procedure-documentation square) => "Return the square of X." - - Function: comment string1 ... + -- Function: comment string1 ... | Appends STRING1 ... to the strings given as arguments to previous calls `comment'. - - Function: comment + -- Function: comment | Returns the (appended) strings given as arguments to previous calls `comment' and empties the current string collection. - - Load syntax: #;text-till-end-of-line | + -- Load syntax: #;text-till-end-of-line | Behaves as `(comment "TEXT-TILL-END-OF-LINE")'. File: scm.info, Node: Modifying Read Syntax, Prev: Documentation and Comments, Up: Lexical Conventions -Modifying Read Syntax ---------------------- +4.8.4 Modifying Read Syntax | +--------------------------- | - - 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 @@ -2932,13 +3104,13 @@ Modifying Read Syntax whitespace. `#<unspecified>' is the value returned by the expression `(if #f #f)'. - - Callback procedure: load:sharp c port | + -- Callback procedure: load:sharp c port | Dispatches like `read:sharp', but only during `load's. The | read-syntaxes handled by `load:sharp' are a superset of those | handled by `read:sharp'. `load:sharp' calls `read:sharp' if none | of its syntaxes match C. | | - - Callback procedure: char:sharp token | + -- Callback procedure: char:sharp token | If the sequence <#\> followed by a non-standard character name is encountered by `read', `read' will call the value of the symbol `char:sharp' with the token (a string of length at least two) as | @@ -2946,7 +3118,7 @@ Modifying Read Syntax 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 `load:sharp', `read:sharp', or `char:sharp' 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 | @@ -2955,8 +3127,8 @@ supported (as they dispatch from `read:sharp'). | File: scm.info, Node: Syntax, Prev: Lexical Conventions, Up: The Language -Syntax -====== +4.9 Syntax | +========== | SCM provides a native implementation of "defmacro". *Note Defmacro: (slib)Defmacro. @@ -2988,16 +3160,16 @@ use the correct macro loader when `require'd. File: scm.info, Node: Define and Set, Next: Defmacro, Prev: Syntax, Up: Syntax -Define and Set --------------- +4.9.1 Define and Set | +-------------------- | - - 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 @@ -3006,7 +3178,7 @@ Define and Set value is not changed. `defvar' 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 @@ -3015,7 +3187,7 @@ Define and Set 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. @@ -3029,7 +3201,7 @@ Define and Set (set! (x y) (list 4 5)) => _unspecified_ (+ x y) => 9 - - Special Form: qase key clause1 clause2 ... + -- 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: @@ -3070,8 +3242,8 @@ Define and Set File: scm.info, Node: Defmacro, Next: Syntax-Rules, Prev: Define and Set, Up: Syntax -Defmacro --------- +4.9.2 Defmacro | +-------------- | SCM supports the following constructs from Common Lisp: `defmacro', `macroexpand', `macroexpand-1', and `gentemp'. *Note Defmacro: @@ -3096,16 +3268,16 @@ 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)) File: scm.info, Node: Syntax-Rules, Next: Macro Primitives, Prev: Defmacro, Up: Syntax -Syntax-Rules ------------- +4.9.3 Syntax-Rules | +------------------ | SCM supports [R5RS] `syntax-rules' macros *Note Macros: (r5rs)Macros. @@ -3130,9 +3302,9 @@ For example: (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 @@ -3150,7 +3322,7 @@ For example: (define-syntax eight (syntax-rules () (_ 8))) - + (+ 3 eight) => 11 (eight) => ERROR (set! eight 9) => ERROR @@ -3158,17 +3330,17 @@ For example: File: scm.info, Node: Macro Primitives, Next: Environment Frames, Prev: Syntax-Rules, Up: Syntax -Macro Primitives ----------------- +4.9.4 Macro Primitives | +---------------------- | - - 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->identifier-macro + -- 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 @@ -3179,7 +3351,7 @@ Macro Primitives (defsyntax trace (procedure->macro (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x)))))) - + (trace foo) == (set! foo (tracef foo 'foo)). `PROCEDURE->IDENTIFIER-MACRO' is similar to @@ -3190,7 +3362,7 @@ Macro Primitives identifier. - - Special Form: defsyntax name expr + -- 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. @@ -3198,8 +3370,8 @@ Macro Primitives File: scm.info, Node: Environment Frames, Next: Syntactic Hooks for Hygienic Macros, Prev: Macro Primitives, Up: Syntax -Environment Frames ------------------- +4.9.5 Environment Frames | +------------------------ | An "environment" is a list of frames representing lexical bindings. Only the names and scope of the bindings are included in environments @@ -3247,7 +3419,8 @@ There are several types of environment frames: 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. @@ -3262,8 +3435,8 @@ There are several types of environment frames: File: scm.info, Node: Syntactic Hooks for Hygienic Macros, Prev: Environment Frames, Up: Syntax -Syntactic Hooks for Hygienic Macros ------------------------------------ +4.9.6 Syntactic Hooks for Hygienic Macros | +----------------------------------------- | SCM provides a synthetic identifier type for efficient implementation of hygienic macros (for example, `syntax-rules' *note Macros: @@ -3271,7 +3444,7 @@ hygienic macros (for example, `syntax-rules' *note Macros: a macro expander in any context where a symbol would normally be used. 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. @@ -3284,7 +3457,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 @@ -3295,12 +3468,12 @@ 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. -Use of Synthetic Identifiers ----------------------------- +4.9.7 Use of Synthetic Identifiers | +---------------------------------- | `renamed-identifier' may be used as a replacement for `gentemp': (define gentemp @@ -3347,7 +3520,7 @@ 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 either be a lexical environment passed to a macro transformer during macro @@ -3359,19 +3532,19 @@ in order to denote the same binding. (let ((foo-name (renamed-identifier 'foo #f))) (lambda (exp env) (identifier-equal? (cadr exp) foo-name env))))) - + (top-level-foo? foo) => #t - + (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, @@ -3381,13 +3554,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 @@ -3400,7 +3573,7 @@ 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' @@ -3416,8 +3589,8 @@ in order to denote the same binding. File: scm.info, Node: Packages, Next: The Implementation, Prev: The Language, Up: Top -Packages -******** +5 Packages | +********** | * Menu: @@ -3429,44 +3602,46 @@ Packages * I/O-Extensions:: i/o-extensions * Posix Extensions:: posix * Unix Extensions:: non-posix unix +* Sequence Comparison:: | * Regular Expression Pattern Matching:: regex * Line Editing:: edit-line * Curses:: Screen Control * Sockets:: Cruise the Net +* SCMDB:: interface to MySQL | * Menu: * Xlib: (Xlibscm). X Window Graphics. -* Hobbit: (hobbit). Scheme-to-C Compiler. +* Hobbit: (hobbit). Scheme-to-C Compiler | File: scm.info, Node: Dynamic Linking, Next: Dump, Prev: Packages, Up: Packages -Dynamic Linking -=============== +5.1 Dynamic Linking | +=================== | 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 @@ -3477,6 +3652,7 @@ of load and ([SLIB]) require specified here are supported. The or (load (in-vicinity (implementation-vicinity) "sc2.o")) or (require 'rev2-procedures) or (require 'rev3-procedures) + will load/link `sc2.o' if it exists. @@ -3487,12 +3663,14 @@ of load and ([SLIB]) require specified here are supported. The (load (in-vicinity (implementation-vicinity) "crs.o") (usr:lib "ncurses") (usr:lib "c")) or (require 'curses) + Turtlegr graphics library is linked by: (load (in-vicinity (implementation-vicinity) "turtlegr") (usr:lib "X11") (usr:lib "c") (usr:lib "m")) or (require 'turtle-graphics) + And the string regular expression (*note Regular Expression Pattern Matching::) package is linked by: @@ -3500,12 +3678,13 @@ of load and ([SLIB]) require specified here are supported. The (load (in-vicinity (implementation-vicinity) "rgx") (usr:lib "c")) or (require 'regex) + 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, @@ -3513,7 +3692,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 @@ -3525,7 +3704,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 @@ -3540,7 +3719,7 @@ an example of their use. 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 @@ -3549,8 +3728,8 @@ an example of their use. File: scm.info, Node: Dump, Next: Numeric, Prev: Dynamic Linking, Up: Packages -Dump -==== +5.2 Dump | +======== | "Dump", (also known as "unexec"), saves the continuation of an entire SCM session to an executable file, which can then be invoked as a @@ -3578,10 +3757,10 @@ 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 @@ -3647,66 +3826,66 @@ This task can also be accomplished using the `-o' command line option File: scm.info, Node: Numeric, Next: Arrays, Prev: Dump, Up: Packages -Numeric -======= +5.3 Numeric | +=========== | - - Constant: most-positive-fixnum + -- Constant: most-positive-fixnum | The immediate integer closest to positive infinity. *Note Configuration: (slib)Configuration. - - Constant: most-negative-fixnum + -- Constant: most-negative-fixnum | The immediate integer closest to negative infinity. - - Constant: $pi - - Constant: pi + -- 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: pi* z + -- Function: pi* z | `(* pi Z)' - - Function: pi/ z + -- Function: pi/ z | `(/ pi Z)' - - Function: sinh z - - Function: cosh z - - Function: tanh 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. - - 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. @@ -3714,8 +3893,8 @@ operations: (r5rs)Numerical operations. File: scm.info, Node: Arrays, Next: Records, Prev: Numeric, Up: Packages -Arrays -====== +5.4 Arrays | +========== | * Menu: @@ -3727,8 +3906,8 @@ Arrays File: scm.info, Node: Conventional Arrays, Next: Uniform Array, Prev: Arrays, Up: Arrays -Conventional Arrays -------------------- +5.4.1 Conventional Arrays | +------------------------- | The following syntax and procedures are SCM extensions to feature `array' in *Note Arrays: (slib)Arrays. @@ -3737,17 +3916,14 @@ The following syntax and procedures are SCM extensions to feature dimensions) followed by the character #\a or #\A and what appear as lists (of lists) of elements. The lists must be nested to the depth of the rank. For each depth, all lists must be the same length. - (create-array '#(ho) 4 3) => | + (make-array '#(ho) 4 3) => | #2A((ho ho ho) (ho ho ho) (ho ho ho) (ho ho ho)) | -The rank may be elided, in which case it is read as one. - '#A(a b c) == '#(a b c) - Unshared, conventional (not uniform) 0-based arrays of rank 1 are equivalent to (and can't be distinguished from) scheme vectors. - (create-array '#(ho) 3) => #(ho ho ho) + (make-array '#(ho) 3) => #(ho ho ho) | - - 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 @@ -3765,7 +3941,7 @@ equivalent to (and can't be distinguished from) scheme vectors. (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 @@ -3782,21 +3958,21 @@ equivalent to (and can't be distinguished from) scheme vectors. examples: (enclose-array '#3A(((a b c) (d e f)) ((1 2 3) (4 5 6))) 1) => #<enclosed-array (#1A(a d) #1A(b e) #1A(c f)) (#1A(1 4) #1A(2 5) #1A(3 6))> - + (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->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-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 CREATE-ARRAY may be unrolled, - some arrays made by MAKE-SHARED-ARRAY may not be. + returns `#f'. All arrays made by MAKE-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 @@ -3805,8 +3981,8 @@ equivalent to (and can't be distinguished from) scheme vectors. File: scm.info, Node: Uniform Array, Next: Bit Vectors, Prev: Conventional Arrays, Up: Arrays -Uniform Array -------------- +5.4.2 Uniform Array | +------------------- | "Uniform Arrays" and vectors are arrays whose elements are all of the same type. Uniform vectors occupy less storage than conventional @@ -3814,18 +3990,16 @@ vectors. Uniform Array procedures also work on vectors, uniform-vectors, bit-vectors, and strings. SLIB now supports uniform arrys. The primary array creation procedure -is `create-array', detailed in *Note Arrays: (slib)Arrays. +is `make-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. - (create-array "" 3) => "$q2" + (make-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. - (create-array '#at() 3) => #*000 - == - #At(#f #f #f) => #*000 + (make-array '#1at() 3) => #*000 | == #1At(#f #f #f) => #*000 @@ -3833,31 +4007,31 @@ PROTOTYPE arguments in the following procedures are interpreted according to the table: 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 + + () conventional vector #A | + +64i complex (double precision) #A:floC64b | + 64.0 double (double precision) #A:floR64b | + 32.0 float (single precision) #A:floR32b | + 32 unsigned integer (32-bit) #A:fixN32b | + -32 signed integer (32-bit) #A:fixZ32b | + -16 signed integer (16-bit) #A:fixZ16b | + #\a char (string) #A:char | + #t boolean (bit-vector) #A:bool | 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)' +#\A character and the contents list. For example, `'#1A:fixZ32b(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: 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 `list->uniform-array'. - - Function: list->uniform-array rank 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. @@ -3870,8 +4044,8 @@ 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-array-read! ura - - Function: uniform-array-read! ura 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 @@ -3882,14 +4056,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-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 @@ -3901,7 +4075,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 @@ -3913,29 +4087,29 @@ returns a uniform vector of signed integers. File: scm.info, Node: Bit Vectors, Next: Array Mapping, Prev: Uniform Array, Up: Arrays -Bit Vectors ------------ +5.4.3 Bit Vectors | +----------------- | Bit vectors can be written and read as a sequence of `0's and `1's prefixed by `#*'. - #At(#f #f #f #t #f #t #f) => #*0001010 + #1At(#f #f #f #t #f #t #f) => #*0001010 | Some of these operations will eventually be generalized to other uniform-arrays. - - Function: bit-count bool bv - Returns the number occurrences of BOOL in BV. + -- Function: bit-count bool bv | + Returns the number of 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. @@ -3946,7 +4120,7 @@ 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. @@ -3954,28 +4128,28 @@ uniform-arrays. File: scm.info, Node: Array Mapping, Prev: Bit Vectors, Up: Arrays -Array Mapping -------------- +5.4.4 Array Mapping | +------------------- | -`(require 'array-for-each)' +`(require 'array-for-each)' SCM has some extra functions in feature `array-for-each': - - Function: array-fill! array fill + -- Function: array-fill! array fill | Stores FILL in every element of ARRAY. The value returned is unspecified. - - Function: serial-array-copy! source destination - Same as `array-copy!' but guaranteed to copy in row-major order. + -- Function: serial-array:copy! destination source | + Same as `array:copy!' but guaranteed to copy in row-major order. | - - 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-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 @@ -3987,13 +4161,13 @@ SCM has some extra functions in feature `array-for-each': unspecified. Handling non-array arguments is a SCM extension of *Note - array-map!: (slib)Array Mapping + array-map!: (slib)Array Mapping. | - - 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-map prototype proc array1 array2 ... | + -- Function: array-map prototype proc array1 array2 ... | ARRAY2, ... must have the same number of dimensions as ARRAY1 and | have a range for each index which includes the range for the | corresponding index in ARRAY1. PROC is applied to each tuple of | @@ -4001,8 +4175,8 @@ SCM has some extra functions in feature `array-for-each': corresponding element in a new array of type PROTOTYPE. The new | array is returned. The order of application is unspecified. | | - - Function: scalar->array scalar array prototype - - Function: scalar->array scalar array + -- Function: scalar->array scalar array prototype | + -- Function: scalar->array scalar array | 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 @@ -4014,13 +4188,13 @@ SCM has some extra functions in feature `array-for-each': File: scm.info, Node: Records, Next: I/O-Extensions, Prev: Arrays, Up: Packages -Records -======= +5.5 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 + -- 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: @@ -4036,13 +4210,13 @@ see *Note Records: (slib)Records, with the following extension. File: scm.info, Node: I/O-Extensions, Next: Posix Extensions, Prev: Records, Up: Packages -I/O-Extensions -============== +5.6 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 @@ -4085,70 +4259,70 @@ I/O: (slib)Line I/O, and the following functions are defined: 10 st_ctime Last file status change time - - Function: getpid + -- 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: try-create-file name modes perms + -- 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 + -- 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 *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 | 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 filenames 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.). @@ -4161,9 +4335,9 @@ I/O: (slib)Line I/O, and the following functions are defined: "Link.scm" "Macro.scm" "Transcen.scm" - "Init5d9.scm" | + "Init5e1.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: @@ -4172,48 +4346,48 @@ 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. - - Function: getcwd + -- Function: getcwd | The function `getcwd' returns a string containing the absolute file 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: @@ -4239,8 +4413,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 @@ -4250,12 +4424,12 @@ 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 + -- 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 @@ -4276,30 +4450,30 @@ I/O: (slib)Line I/O, and the following functions are defined: File: scm.info, Node: Posix Extensions, Next: Unix Extensions, Prev: I/O-Extensions, Up: Packages -Posix Extensions -================ +5.7 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: broken-pipe port + -- 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 @@ -4307,16 +4481,16 @@ functions are defined: 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 + -- 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. - - Function: pipe + -- Function: pipe | Returns `(cons RD WD)' where RD and WD are the read and write (port) ends of a "pipe" respectively. - - Function: fork + -- Function: fork | Creates a copy of the process calling `fork'. Both processes return from `fork', but the calling ("parent") process's `fork' returns the "child" process's ID whereas the child process's @@ -4325,39 +4499,39 @@ functions are defined: For a discussion of "ID"s *Note Process Persona: (GNU C Library)Process Persona. - - Function: getppid + -- Function: getppid | Returns the process ID of the parent of the current process. For a process's own ID *Note getpid: I/O-Extensions. - - Function: getuid + -- Function: getuid | Returns the real user ID of this process. - - Function: getgid + -- Function: getgid | Returns the real group ID of this process. - - Function: getegid + -- Function: getegid | Returns the effective group ID of this process. - - Function: geteuid + -- 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 @@ -4396,7 +4570,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 @@ -4444,7 +4618,7 @@ Persona. information about the `errno' codes *Note Process Completion: (GNU C Library)Process Completion. - - Function: uname + -- Function: uname | You can use the `uname' procedure to find out some information about the type of computer your program is running on. @@ -4465,9 +4639,9 @@ 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 + -- 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: @@ -4489,16 +4663,16 @@ 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 + -- Function: setpwent #f | + -- Function: setpwent | Closes the pw table. - - Function: getgr name - - Function: getgr uid - - Function: getgr + -- 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: @@ -4510,69 +4684,69 @@ 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 + -- Function: setgrent #f | + -- Function: setgrent | Closes the group table. - - Function: getgroups + -- 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 -=============== +File: scm.info, Node: Unix Extensions, Next: Sequence Comparison, Prev: Posix Extensions, Up: Packages + | +5.8 Unix Extensions | +=================== | If `'unix' is provided (by linking in `unix.o'), the following functions are defined: 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 process are appended to FILENAME as it terminates. An argument of `#f' causes @@ -4581,30 +4755,41 @@ These "privileged" and symbolic link functions are not in Posix: `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. `mknod' returns a value of `#t' if it is successful and `#f' on failure. - - Function: sync + -- Function: sync | `sync' first commits inodes to buffers, and then buffers to disk. sync() only schedules the writes, so it may return before the actual writing is done. The value returned is unspecified. -File: scm.info, Node: Regular Expression Pattern Matching, Next: Line Editing, Prev: Unix Extensions, Up: Packages - -Regular Expression Pattern Matching -=================================== +File: scm.info, Node: Sequence Comparison, Next: Regular Expression Pattern Matching, Prev: Unix Extensions, Up: Packages + | +5.9 Sequence Comparison | +======================= | + | +`(require 'diff)' | + | +A blazing fast implementation of the sequence-comparison module in | +SLIB, see *Note Sequence Comparison: (slib)Sequence Comparison. | + | + +File: scm.info, Node: Regular Expression Pattern Matching, Next: Line Editing, Prev: Sequence Comparison, Up: Packages + | +5.10 Regular Expression Pattern Matching | +======================================== | These functions are defined in `rgx.c' using a POSIX or GNU "regex" library. If your computer does not support regex, a package is available via ftp from `ftp.gnu.org:/pub/gnu/regex-0.12.tar.gz'. For a description of regular expressions, *Note syntax: (regex)syntax. - - Function: regcomp PATTERN [FLAGS] + -- Function: regcomp PATTERN [FLAGS] | Compile a "regular expression". Return a compiled regular expression, or an integer error code suitable as an argument to `regerror'. @@ -4618,17 +4803,19 @@ description of regular expressions, *Note syntax: (regex)syntax. `i' ignore case.only when compiled with _GNU_SOURCE: + + `0' allows dot to match a null character. `f' enable GNU fastmaps. - - Function: regerror ERRNO + -- Function: regerror ERRNO | Returns a string describing the integer ERRNO returned when `regcomp' fails. - - Function: regexec RE STRING + -- Function: regexec RE STRING | Returns `#f' or a vector of integers. These integers are in doublets. The first of each doublet is the index of STRING of the start of the matching expression or sub-expression (delimited by @@ -4636,15 +4823,15 @@ description of regular expressions, *Note syntax: (regex)syntax. STRING of the end of that expression. `#f' is returned if the string does not match. - - Function: regmatch? RE STRING + -- Function: regmatch? RE STRING | Returns `#t' if the PATTERN such that REGEXP = (regcomp PATTERN) matches STRING as a POSIX extended regular expressions. Returns `#f' otherwise. - - Function: regsearch RE STRING [START [LEN]] - - Function: regsearchv RE STRING [START [LEN]] - - Function: regmatch RE STRING [START [LEN]] - - Function: regmatchv RE STRING [START [LEN]] + -- Function: regsearch RE STRING [START [LEN]] | + -- Function: regsearchv RE STRING [START [LEN]] | + -- Function: regmatch RE STRING [START [LEN]] | + -- Function: regmatchv RE STRING [START [LEN]] | `Regsearch' searches for the pattern within the string. `Regmatch' anchors the pattern and begins matching it against @@ -4674,7 +4861,9 @@ 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. @@ -4684,15 +4873,15 @@ description of regular expressions, *Note syntax: (regex)syntax. characters of STRING. If absent, the entire string may be examined. - - Function: string-split RE STRING - - Function: string-splitv RE STRING + -- Function: string-split RE STRING | + -- Function: string-splitv RE STRING | `String-split' splits a string into substrings that are separated by RE, returning a vector of substrings. `String-splitv' returns a vector of string positions that indicate where the substrings are located. - - Function: string-edit RE EDIT-SPEC STRING [COUNT] + -- Function: string-edit RE EDIT-SPEC STRING [COUNT] | Returns the edited string. EDIT-SPEC @@ -4708,8 +4897,8 @@ description of regular expressions, *Note syntax: (regex)syntax. File: scm.info, Node: Line Editing, Next: Curses, Prev: Regular Expression Pattern Matching, Up: Packages -Line Editing -============ +5.11 Line Editing | +================= | These procedures provide input line editing and recall. @@ -4725,22 +4914,22 @@ When `Iedline.scm' is loaded, if the current input port is the default input port and the environment variable EMACS is not defined, line-editing mode will be entered. - - Function: default-input-port + -- Function: default-input-port | Returns the initial `current-input-port' SCM was invoked with (stdin). - - Function: default-output-port + -- Function: default-output-port | Returns the initial `current-output-port' SCM was invoked with (stdout). - - Function: make-edited-line-port + -- Function: make-edited-line-port | Returns an input/output port that allows command line editing and retrieval of history. - - Function: line-editing + -- 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 @@ -4749,18 +4938,18 @@ line-editing mode will be entered. File: scm.info, Node: Curses, Next: Sockets, Prev: Line Editing, Up: Packages -Curses -====== +5.12 Curses | +=========== | These functions are defined in `crs.c' using the "curses" library. Unless otherwise noted these routines return `#t' for successful completion and `#f' for failure. - - Function: initscr + -- Function: initscr | Returns a port for a full screen window. This routine must be called to initialize curses. - - Function: endwin + -- Function: endwin | A program should call `endwin' before exiting or escaping from curses mode temporarily, to do a system call, for example. This routine will restore termio modes, move the cursor to the lower @@ -4780,21 +4969,21 @@ completion and `#f' for failure. File: scm.info, Node: Output Options Setting, Next: Terminal Mode Setting, Prev: Curses, Up: Curses -Output Options Setting ----------------------- +5.12.1 Output Options Setting | +----------------------------- | 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. @@ -4808,7 +4997,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 @@ -4816,7 +5005,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 @@ -4826,10 +5015,10 @@ 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 will hang until a key is pressed. @@ -4837,16 +5026,16 @@ necessary to turn these options off before calling `endwin'. File: scm.info, Node: Terminal Mode Setting, Next: Window Manipulation, Prev: Output Options Setting, Up: Curses -Terminal Mode Setting ---------------------- +5.12.2 Terminal Mode Setting | +---------------------------- | These routines set options within curses that deal with input. The options involve using ioctl(2) and therefore interact with curses routines. It is not necessary to turn these options off before calling `endwin'. The routines in this section all return an unspecified value. - - Function: cbreak - - Function: nocbreak + -- Function: cbreak | + -- Function: nocbreak | These two routines put the terminal into and out of `CBREAK' mode, respectively. In `CBREAK' mode, characters typed by the user are immediately available to the program and erase/kill character @@ -4858,11 +5047,11 @@ 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 - - Function: noraw + -- Function: raw | + -- Function: noraw | The terminal is placed into or out of `RAW' mode. `RAW' mode is similar to `CBREAK' mode, in that characters typed are immediately passed through to the user program. The differences are that in @@ -4872,8 +5061,8 @@ routines. It is not necessary to turn these options off before calling behavior of the `BREAK' key depends on other bits in the terminal driver that are not set by curses. - - Function: echo - - Function: noecho + -- Function: echo | + -- Function: noecho | These routines control whether characters typed by the user are echoed by `read-char' as they are typed. Echoing by the tty driver is always disabled, but initially `read-char' is in `ECHO' @@ -4883,16 +5072,16 @@ routines. It is not necessary to turn these options off before calling calling `noecho'. For a discussion of how these routines interact with `echo' and `noecho' *Note read-char: Input. - - Function: nl - - Function: nonl + -- Function: nl | + -- Function: nonl | These routines control whether <LFD> is translated into <RET> and `LFD' on output, and whether <RET> is translated into <LFD> on input. Initially, the translations do occur. By disabling these translations using `nonl', curses is able to make better use of the linefeed capability, resulting in faster cursor motion. - - Function: resetty - - Function: savetty + -- Function: resetty | + -- Function: savetty | These routines save and restore the state of the terminal modes. `savetty' saves the current state of the terminal in a buffer and `resetty' restores the state to what it was at the last call to @@ -4901,17 +5090,17 @@ routines. It is not necessary to turn these options off before calling File: scm.info, Node: Window Manipulation, Next: Output, Prev: Terminal Mode Setting, Up: Curses -Window Manipulation -------------------- +5.12.3 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 @@ -4921,13 +5110,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: refresh | + -- 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 @@ -4938,21 +5127,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 @@ -4962,7 +5151,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 @@ -4972,15 +5161,15 @@ Window Manipulation File: scm.info, Node: Output, Next: Input, Prev: Window Manipulation, Up: Curses -Output ------- +5.12.4 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 @@ -5003,51 +5192,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 @@ -5056,10 +5245,10 @@ These routines are used to "draw" text on windows File: scm.info, Node: Input, Next: Curses Miscellany, Prev: Output, Up: Curses -Input ------ +5.12.5 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' @@ -5071,23 +5260,23 @@ 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 File: scm.info, Node: Curses Miscellany, Prev: Input, Up: Curses -Curses Miscellany ------------------ +5.12.6 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 @@ -5100,26 +5289,26 @@ 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 as is. -File: scm.info, Node: Sockets, Prev: Curses, Up: Packages - -Sockets -======= +File: scm.info, Node: Sockets, Next: SCMDB, Prev: Curses, Up: Packages + | +5.13 Sockets | +============ | These procedures (defined in `socket.c') provide a Scheme interface to most of the C "socket" library. For more information on sockets, *Note @@ -5134,15 +5323,15 @@ Sockets: (libc)Sockets. File: scm.info, Node: Host and Other Inquiries, Next: Internet Addresses and Socket Names, Prev: Sockets, Up: Sockets -Host and Other Inquiries ------------------------- +5.13.1 Host and Other Inquiries | +------------------------------- | - - Constant: af_inet - - Constant: af_unix + -- Constant: af_inet | + -- Constant: af_unix | Integer family codes for Internet and Unix sockets, respectively. - - Function: gethost host-spec - - Function: gethost + -- 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: @@ -5156,16 +5345,16 @@ Host and Other Inquiries 4. list of integer addresses - - Function: sethostent stay-open - - Function: sethostent + -- 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 done using `UDP' datagrams. Otherwise, a connected `TCP' socket will be used. When called without an argument, the host table is closed. - - Function: getnet name-or-number - - Function: getnet + -- 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: @@ -5177,15 +5366,15 @@ Host and Other Inquiries 3. integer network number - - Function: setnetent stay-open - - Function: setnetent + -- 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 + -- 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: @@ -5195,16 +5384,16 @@ Host and Other Inquiries 3. integer protocol number - - Function: setprotoent stay-open - - Function: setprotoent + -- 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 closed between calls to getproto. Otherwise, the table stays open. When called without an argument, the protocol table is closed. - - Function: getserv name-or-port-number protocol - - Function: getserv + -- 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 aren't given. The information is: @@ -5217,8 +5406,8 @@ Host and Other Inquiries 3. protocol - - Function: setservent stay-open - - Function: setservent + -- 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 closed between calls to getserv. Otherwise, the table stays open. @@ -5227,53 +5416,53 @@ Host and Other Inquiries File: scm.info, Node: Internet Addresses and Socket Names, Next: Socket, Prev: Host and Other Inquiries, Up: Sockets -Internet Addresses and Socket Names ------------------------------------ +5.13.2 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. File: scm.info, Node: Socket, Prev: Internet Addresses and Socket Names, Up: Sockets -Socket ------- +5.13.3 Socket | +------------- | When a port is returned from one of these calls it is unbuffered. This allows both reading and writing to the same port to work. If you want @@ -5282,8 +5471,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 @@ -5292,8 +5481,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 @@ -5301,7 +5490,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: @@ -5313,34 +5502,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 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. @@ -5348,13 +5537,13 @@ The following example is not too complicated, yet shows the use of sockets for multiple connections without input blocking. ;;;; Scheme chat server - + ;;; This program implements a simple `chat' server which accepts ;;; connections from multiple clients, and sends to all clients any ;;; characters received from any client. - + ;;; To connect to chat `telnet localhost 8001' - + (require 'socket) (require 'i/o-extensions) @@ -5400,17 +5589,17 @@ You can use `telnet localhost 8001' to connect to the chat server, or you can use a client written in scheme: ;;;; Scheme chat client - + ;;; this program connects to socket 8001. It then sends all ;;; characters from current-input-port to the socket and sends all ;;; characters from the socket to current-output-port. - + (require 'socket) (require 'i/o-extensions) (define con (make-stream-socket af_inet)) (set! con (socket:connect con (inet:string->address "localhost") 8001)) - + (define (go) (define actives (wait-for-input (* 30 60) con (current-input-port))) (let ((cs (and actives (memq con actives) (read-char con))) @@ -5429,10 +5618,22 @@ you can use a client written in scheme: (newline))) +File: scm.info, Node: SCMDB, Prev: Sockets, Up: Packages + | +5.14 SCMDB | +========== | + | +`(require 'mysql)' | + | +"SCMDB" is an add-on for SCM that ports the MySQL C-library to SCM. | + | +It is available from: `http://www.dedecker.net/jessie/scmdb/' | + | + File: scm.info, Node: The Implementation, Next: Index, Prev: Packages, Up: Top - -The Implementation -****************** + | +6 The Implementation | +******************** | * Menu: @@ -5444,8 +5645,8 @@ The Implementation File: scm.info, Node: Data Types, Next: Operations, Prev: The Implementation, Up: The Implementation -Data Types -========== +6.1 Data Types | +============== | In the descriptions below it is assumed that `long int's are 32 bits in length. Acutally, SCM is written to work with any `long int' size @@ -5468,35 +5669,35 @@ basic flavors, Immediates and Cells: File: scm.info, Node: Immediates, Next: Cells, Prev: Data Types, Up: Data Types -Immediates ----------- +6.1.1 Immediates | +---------------- | 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. - - Immediate: inum + -- Immediate: inum | immediate 30 bit signed integer. An INUM is flagged by a `1' in 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 + -- Immediate Constant: INUM0 | is equivalent to `MAKINUM(0)'. Computations on INUMs are performed by converting the arguments to @@ -5509,91 +5710,91 @@ length, but reside in the low order bits. detected in a #if statement in `scmfig.h' and a signed right shift, `SRS', is constructed in terms of unsigned right shift. - - Immediate: ichr + -- 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. - - Immediate: iflags + -- Immediate: iflags | These are frequently used immediate constants. - - Immediate Constant: SCM BOOL_T + -- Immediate Constant: SCM BOOL_T | `#t' - - Immediate Constant: SCM BOOL_F + -- Immediate Constant: SCM BOOL_F | `#f' - - Immediate Constant: SCM EOL + -- Immediate Constant: SCM EOL | `()'. If `SICP' is `#define'd, `EOL' is `#define'd to be identical with `BOOL_F'. In this case, both print as `#f'. - - Immediate Constant: SCM EOF_VAL + -- Immediate Constant: SCM EOF_VAL | end of file token, `#<eof>'. - - Immediate Constant: SCM UNDEFINED + -- Immediate Constant: SCM UNDEFINED | `#<undefined>' used for variables which have not been defined and absent optional arguments. - - Immediate Constant: SCM UNSPECIFIED + -- Immediate Constant: SCM UNSPECIFIED | `#<unspecified>' is returned for those procedures whose return 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 + -- Variable: isymnames | An array of strings containing the external representations of all the ispcsym, isym, and iflag immediates. Defined in `repl.c'. - - Constant: NUM_ISPCSYM - - Constant: NUM_ISYMS + -- Constant: NUM_ISPCSYM | + -- Constant: NUM_ISYMS | The number of ispcsyms and ispcsyms+isyms, respectively. Defined in `scm.h'. - - Immediate: isym + -- Immediate: isym | `and', `begin', `case', `cond', `define', `do', `if', `lambda', `let', `let*', `letrec', `or', `quote', `set!', `#f', `#t', `#<undefined>', `#<eof>', `()', and `#<unspecified>'. - - CAR Immediate: ispcsym + -- CAR Immediate: ispcsym | special symbols: syntax-checked versions of first 14 isyms - - CAR Immediate: iloc + -- CAR Immediate: iloc | indexes to a variable's location in environment - - CAR Immediate: gloc + -- CAR Immediate: gloc | pointer to a symbol's value cell - - Immediate: CELLPTR + -- Immediate: CELLPTR | pointer to a cell (not really an immediate type, but here for completeness). Since cells are always 8 byte aligned, a pointer to a cell has the low order 3 bits `0'. @@ -5607,8 +5808,8 @@ A "CAR Immediate" is an Immediate point which can only occur in the File: scm.info, Node: Cells, Next: Header Cells, Prev: Immediates, Up: Data Types -Cells ------ +6.1.2 Cells | +----------- | "Cell"s represent all SCM objects other than immediates. A cell has a `CAR' and a `CDR'. Low-order bits in `CAR' identify the type of @@ -5616,7 +5817,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. @@ -5626,23 +5827,23 @@ 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 + -- 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 + -- Cell: tc3_closure | applicable object returned by (lambda (args) ...). `tc3_closure's have a pointer to the body of the procedure in the `CAR' and a pointer to the environment in the `CDR'. Bits 1 and 2 @@ -5652,15 +5853,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. @@ -5668,82 +5869,82 @@ is of type `SCM' and points to a cell (`CELLPTR'). File: scm.info, Node: Header Cells, Next: Subr Cells, Prev: Cells, Up: Data Types -Header Cells ------------- +6.1.3 Header Cells | +------------------ | "Header"s are Cells whose `CDR's point elsewhere in memory, such as to memory allocated by `malloc'. - - Header: spare + -- Header: spare | spare `tc7' type code - - Header: tc7_vector + -- 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. - - Header: tc7_ssymbol + -- Header: tc7_ssymbol | static scheme symbol (part of initial system) - - Header: tc7_msymbol + -- 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 + -- 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. - - Header: tc7_bvect + -- Header: tc7_bvect | uniform vector of booleans (bit-vector) - - Header: tc7_ivect + -- Header: tc7_ivect | uniform vector of integers - - Header: tc7_uvect + -- Header: tc7_uvect | uniform vector of non-negative integers - - Header: tc7_svect + -- Header: tc7_svect | uniform vector of short integers - - Header: tc7_fvect + -- Header: tc7_fvect | uniform vector of short inexact real numbers - - Header: tc7_dvect + -- Header: tc7_dvect | uniform vector of double precision inexact real numbers - - Header: tc7_cvect + -- Header: tc7_cvect | uniform vector of double precision inexact complex numbers - - Header: tc7_contin + -- Header: tc7_contin | applicable object produced by call-with-current-continuation - - Header: tc7_specfun + -- Header: tc7_specfun | subr that is treated specially within the evaluator `apply' and `call-with-current-continuation' are denoted by these @@ -5760,36 +5961,36 @@ memory allocated by `malloc'. invocation is currently not tail recursive when given 2 or more arguments. - - Function: makcclo proc len + -- 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. File: scm.info, Node: Subr Cells, Next: Ptob Cells, Prev: Header Cells, Up: Data Types -Subr Cells ----------- +6.1.4 Subr Cells | +---------------- | A "Subr" is a header whose `CDR' points to a C code procedure. Scheme primitive procedures are subrs. Except for the arithmetic `tc7_cxr's, the C code procedures will be passed arguments (and return results) of type `SCM'. - - Subr: tc7_asubr + -- Subr: tc7_asubr | associative C function of 2 arguments. Examples are `+', `-', `*', `/', `max', and `min'. - - Subr: tc7_subr_0 + -- Subr: tc7_subr_0 | C function of no arguments. - - Subr: tc7_subr_1 + -- Subr: tc7_subr_1 | C function of one argument. - - Subr: tc7_cxr + -- Subr: tc7_cxr | These subrs are handled specially. If inexact numbers are enabled, the `CDR' should be a function which takes and returns type `double'. Conversions are handled in the interpreter. @@ -5808,107 +6009,107 @@ type `SCM'. `cadddr', `cdaaar', `cdaadr', `cdadar', `cdaddr', `cddaar', `cddadr', `cdddar', and `cddddr' are defined this way. - - Subr: tc7_subr_3 + -- Subr: tc7_subr_3 | C function of 3 arguments. - - Subr: tc7_subr_2 + -- Subr: tc7_subr_2 | C function of 2 arguments. - - Subr: tc7_rpsubr + -- Subr: tc7_rpsubr | transitive relational predicate C function of 2 arguments. The C function should return either `BOOL_T' or `BOOL_F'. - - Subr: tc7_subr_1o + -- Subr: tc7_subr_1o | C function of one optional argument. If the optional argument is not present, `UNDEFINED' is passed in its place. - - Subr: tc7_subr_2o + -- Subr: tc7_subr_2o | C function of 1 required and 1 optional argument. If the optional argument is not present, `UNDEFINED' is passed in its place. - - Subr: tc7_lsubr_2 + -- Subr: tc7_lsubr_2 | C function of 2 arguments and a list of (rest of) `SCM' arguments. - - Subr: tc7_lsubr + -- Subr: tc7_lsubr | C function of list of `SCM' arguments. File: scm.info, Node: Ptob Cells, Next: Smob Cells, Prev: Subr Cells, Up: Data Types -Ptob Cells ----------- +6.1.5 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: +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: | - - ptob: tc16_inport + -- ptob: tc16_inport | input port. - - ptob: tc16_outport + -- ptob: tc16_outport | output port. - - ptob: tc16_ioport + -- ptob: tc16_ioport | input-output port. - - ptob: tc16_inpipe + -- ptob: tc16_inpipe | input pipe created by `popen()'. - - ptob: tc16_outpipe + -- ptob: tc16_outpipe | output pipe created by `popen()'. - - ptob: tc16_strport + -- ptob: tc16_strport | String port created by `cwos()' or `cwis()'. - - ptob: tc16_sfport + -- 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 + -- 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. File: scm.info, Node: Smob Cells, Next: Data Type Representations, Prev: Ptob Cells, Up: Data Types -Smob Cells ----------- +6.1.6 Smob Cells | +---------------- | -A "smob" is a miscellaneous datatype. The type code and GCMARK bit -occupy the lower order 16 bits of the `CAR' half of the cell. The rest -of the `CAR' can be used for sub-type or other information. The `CDR' +A "smob" is a miscellaneous datatype. The type code and GCMARK bit occupy | +the lower order 16 bits of the `CAR' half of the cell. The rest 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: - - smob: tc_free_cell + -- smob: tc_free_cell | unused cell on the freelist. - - smob: tc16_flo + -- smob: tc16_flo | single-precision float. Inexact number data types are subtypes of type `tc16_flo'. If the @@ -5920,14 +6121,14 @@ Defining Smobs::). These are the initial smobs: 3. `CDR' is a pointer to a `malloc'ed pair of doubles. - - smob: tc_dblr + -- smob: tc_dblr | double-precision float. - - smob: tc_dblc + -- smob: tc_dblc | double-precision complex. - - smob: tc16_bigpos - - smob: tc16_bigneg + -- smob: tc16_bigpos | + -- smob: tc16_bigneg | positive and negative bignums, respectively. Scm has large precision integers called bignums. They are stored @@ -5957,19 +6158,18 @@ 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 + -- smob: tc16_promise | made by DELAY. *Note Control features: (r5rs)Control features. - - smob: tc16_arbiter + -- smob: tc16_arbiter | synchronization object. *Note Process Synchronization::. - - smob: tc16_macro + -- smob: tc16_macro | macro expanding function. *Note Macro Primitives::. - - smob: tc16_array + -- smob: tc16_array | multi-dimensional array. *Note Arrays::. This type implements both conventional arrays (those with @@ -5984,8 +6184,8 @@ Defining Smobs::). These are the initial smobs: File: scm.info, Node: Data Type Representations, Prev: Smob Cells, Up: Data Types -Data Type Representations -------------------------- +6.1.7 Data Type Representations | +------------------------------- | IMMEDIATE: B,D,E,F=data bit, C=flag code, P=pointer address bit ................................ @@ -6001,7 +6201,7 @@ gloc PPPPPPPPPPPPPPPPPPPPPPPPPPPPP001 HEAP CELL: G=gc_mark; 1 during mark, 0 other times. 1s and 0s here indicate type. G missing means sys (not GC'd) - SIMPLE: + SIMPLE | cons ..........SCM car..............0 ...........SCM cdr.............G closure ..........SCM code...........011 ...........SCM env...........CCG HEADERs: @@ -6022,7 +6222,7 @@ cvect .........long length....G0110101 ........double *words........... contin .........long length....G0111101 .............*regs.............. specfun ................xxxxxxxxG1111111 ...........SCM name............. cclo ..short length..xxxxxx10G1111111 ...........SCM **elts........... - PTOBs: + PTOBs | port int portnum.CwroxxxxxxxxG0110111 ..........FILE *stream.......... | socket int portnum.C001xxxxxxxxG0110111 ..........FILE *stream.......... | inport int portnum.C011xxxxxxxxG0110111 ..........FILE *stream.......... | @@ -6032,7 +6232,7 @@ fport int portnum.C 00000000G0110111 ..........FILE *stream.......... | pipe int portnum.C 00000001G0110111 ..........FILE *stream.......... | strport 00000000000.0 00000010G0110111 ..........FILE *stream.......... | sfport int portnum.C 00000011G0110111 ..........FILE *stream.......... | - SUBRs: + SUBRs | spare 010001x1 spare 010011x1 subr_0 ..........int hpoff.....01010101 ...........SCM (*f)()........... @@ -6046,7 +6246,7 @@ subr_2o ..........int hpoff.....01101111 ...........SCM (*f)()........... lsubr_2 ..........int hpoff.....01110101 ...........SCM (*f)()........... lsubr ..........int hpoff.....01110111 ...........SCM (*f)()........... rpsubr ..........int hpoff.....01111101 ...........SCM (*f)()........... - SMOBs: + SMOBs | free_cell 000000000000000000000000G1111111 ...........*free_cell........000 flo 000000000000000000000001G1111111 ...........float num............ @@ -6064,8 +6264,8 @@ array ...short rank..cxxxxxxxxG1111111 ............*array.............. File: scm.info, Node: Operations, Next: Program Self-Knowledge, Prev: Data Types, Up: The Implementation -Operations -========== +6.2 Operations | +============== | * Menu: @@ -6087,8 +6287,8 @@ Operations File: scm.info, Node: Garbage Collection, Next: Memory Management for Environments, Prev: Operations, Up: Operations -Garbage Collection ------------------- +6.2.1 Garbage Collection | +------------------------ | The garbage collector is in the latter half of `sys.c'. The primary goal of "garbage collection" (or "GC") is to recycle those cells no @@ -6107,8 +6307,8 @@ heap. File: scm.info, Node: Marking Cells, Next: Sweeping the Heap, Prev: Garbage Collection, Up: Garbage Collection -Marking Cells -............. +6.2.1.1 Marking Cells | +..................... | The first step in garbage collection is to "mark" all heap objects in use. Each heap cell has a bit reserved for this purpose. For pairs @@ -6118,11 +6318,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 @@ -6130,13 +6330,13 @@ all accessible objects are marked. Those objects are `sys_protects[]' (for example, `dynwinds'), the current C-stack and the hash table for symbols, "symhash". - - Function: void gc_mark (SCM OBJ) + -- Function: void gc_mark (SCM OBJ) | The function `gc_mark()' is used for marking SCM cells. If OBJ is marked, `gc_mark()' returns. If OBJ is unmarked, gc_mark sets the mark bit in OBJ, then calls `gc_mark()' on any SCM components of OBJ. The last call to `gc_mark()' is tail-called (looped). - - Function: void mark_locations (STACKITEM X[], sizet LEN)) + -- Function: void mark_locations (STACKITEM X[], sizet LEN)) | The function `mark_locations' is used for marking segments of C-stack or saved segments of C-stack (marked continuations). The argument LEN is the size of the stack in units of size @@ -6153,8 +6353,8 @@ symbols, "symhash". File: scm.info, Node: Sweeping the Heap, Prev: Marking Cells, Up: Garbage Collection -Sweeping the Heap -................. +6.2.1.2 Sweeping the Heap | +......................... | After all found objects have been marked, the heap is swept. @@ -6164,7 +6364,7 @@ object from its type-header cell in the heap. This allows malloc objects to be freed when the associated heap object is garbage collected. - - Function: static void gc_sweep () + -- Function: static void gc_sweep () | The function `gc_sweep' scans through all heap segments. The mark bit is cleared from marked cells. Unmarked cells are spliced into FREELIST, where they can again be returned by invocations of @@ -6177,8 +6377,8 @@ collected. File: scm.info, Node: Memory Management for Environments, Next: Signals, Prev: Garbage Collection, Up: Operations -Memory Management for Environments ----------------------------------- +6.2.2 Memory Management for Environments | +---------------------------------------- | * "Ecache" was designed and implemented by Radey Shouman. @@ -6277,17 +6477,17 @@ literature is available. File: scm.info, Node: Signals, Next: C Macros, Prev: Memory Management for Environments, Up: Operations -Signals -------- +6.2.3 Signals | +------------- | - - Function: init_signals + -- Function: init_signals | (in `scm.c') initializes handlers for `SIGINT' and `SIGALRM' if they are supported by the C implementation. All of the signal 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 @@ -6299,14 +6499,14 @@ SCM does not use any signal masking system calls. These are not a portable feature. However, code can run uninterrupted by use of the C macros `DEFER_INTS' and `ALLOW_INTS'. - - Macro: DEFER_INTS + -- Macro: DEFER_INTS | sets the global variable `ints_disabled' to 1. If an interrupt occurs during a time when `ints_disabled' is 1, then `deferred_proc' is set to non-zero, one of the global variables `SIGINT_deferred' or `SIGALRM_deferred' is set to 1, and the handler returns. - - Macro: ALLOW_INTS + -- Macro: ALLOW_INTS | Checks the deferred variables and if set the appropriate handler is called. @@ -6318,10 +6518,10 @@ macros `DEFER_INTS' and `ALLOW_INTS'. File: scm.info, Node: C Macros, Next: Changing Scm, Prev: Signals, Up: Operations -C Macros --------- +6.2.4 C Macros | +-------------- | - - Macro: ASRTER cond arg pos subr + -- Macro: ASRTER 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 @@ -6366,15 +6566,15 @@ 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 `ASRTER', `ASRTGO' does is not active if the flag `RECKLESS' is defined. File: scm.info, Node: Changing Scm, Next: Defining Subrs, Prev: C Macros, Up: Operations -Changing Scm ------------- +6.2.5 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 @@ -6395,7 +6595,7 @@ or put this assignment somewhere in your routine: of the local `SCM' variable to _any_ procedure also protects it. The procedure `scm_protect_temp' is provided for this purpose. - - Function: void scm_protect_temp (SCM *PTR) + -- Function: void scm_protect_temp (SCM *PTR) | Forces the SCM object PTR to be saved on the C-stack, where it will be traced for GC. @@ -6404,7 +6604,7 @@ object, you must either make your pointer be the value cell of a symbol (see `errobj' for an example) or (permanently) add your pointer to `sys_protects' using: - - Function: SCM scm_gc_protect (SCM OBJ) + -- Function: SCM scm_gc_protect (SCM OBJ) | Permanently adds OBJ to a table of objects protected from garbage collection. `scm_gc_protect' returns OBJ. @@ -6466,7 +6666,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 `Init5d9.scm' which loads `Ifoo.scm' if your | + 8. put an `if' into `Init5e1.scm' which loads `Ifoo.scm' if your | package is included: (if (defined? twiddle-bits!) @@ -6494,7 +6694,7 @@ Special forms (new syntax) can be added to scm. 2. add a string with the new name in the corresponding place in `isymnames' in `repl.c'. - 3. add `case:' clause to `ceval()' near `i_quasiquote' (in `eval.c'). + 3. add `case' clause to `ceval()' near `i_quasiquote' (in `eval.c'). | New syntax can now be added without recompiling SCM by the use of the `procedure->syntax', `procedure->macro', `procedure->memoizing-macro', @@ -6503,8 +6703,8 @@ and `defmacro'. For details, *Note Syntax::. File: scm.info, Node: Defining Subrs, Next: Defining Smobs, Prev: Changing Scm, Up: Operations -Defining Subrs --------------- +6.2.6 Defining Subrs | +-------------------- | If "CCLO" is `#define'd when compiling, the compiled closure feature will be enabled. It is automatically enabled if dynamic linking is @@ -6514,7 +6714,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 @@ -6531,9 +6731,9 @@ use: /* A silly example, taking 2 required args, 1 optional, and a list of rest args */ - + #include <scm.h> - + SCM gsubr_21l(req1,req2,opt,rst) SCM req1,req2,opt,rst; { @@ -6548,7 +6748,7 @@ use: newline(cur_outp); return UNSPECIFIED; } - + void init_gsubr211() { make_gsubr("gsubr-2-1-l", 2, 1, 1, gsubr_21l); @@ -6557,8 +6757,8 @@ use: File: scm.info, Node: Defining Smobs, Next: Defining Ptobs, Prev: Defining Subrs, Up: Operations -Defining Smobs --------------- +6.2.7 Defining Smobs | +-------------------- | Here is an example of how to add a new type named `foo' to SCM. The following lines need to be added to your code: @@ -6581,9 +6781,9 @@ 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 - versions prior to 5c5. Only additional data specific to a - smob type need be marked by `smob.mark'. + 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'. | 2 functions are provided: @@ -6631,8 +6831,8 @@ than `malloc' *Note Allocating memory::. File: scm.info, Node: Defining Ptobs, Next: Allocating memory, Prev: Defining Smobs, Up: Operations -Defining Ptobs --------------- +6.2.8 Defining Ptobs | +-------------------- | "ptob"s are similar to smobs but define new types of port to which SCM procedures can read or write. The following functions are defined in @@ -6662,8 +6862,8 @@ memory::. File: scm.info, Node: Allocating memory, Next: Embedding SCM, Prev: Defining Ptobs, Up: Operations -Allocating memory ------------------ +6.2.9 Allocating memory | +----------------------- | SCM maintains a count of bytes allocated using malloc, and calls the garbage collector when that number exceeds a dynamically managed limit. @@ -6671,17 +6871,17 @@ In order for this to work properly, `malloc' and `free' should not be called directly to manage memory freeable by garbage collection. The following functions are provided for that purpose: - - Function: SCM must_malloc_cell (long LEN, SCM C, char *WHAT) - - Function: char * must_malloc (long LEN, char *WHAT) + -- Function: SCM must_malloc_cell (long LEN, SCM C, char *WHAT) | + -- 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 newly allocated cell whose `car' is C and whose `cdr' is a pointer to newly allocated memory. - - Function: void must_realloc_cell (SCM Z, long OLEN, long LEN, char + -- Function: void must_realloc_cell (SCM Z, long OLEN, long LEN, char | *WHAT) - - Function: char * must_realloc (char *WHERE, long OLEN, long LEN, + -- Function: char * must_realloc (char *WHERE, long OLEN, long LEN, | char *WHAT) `must_realloc_cell' takes as argument Z a cell whose `cdr' should be a pointer to a block of memory of length OLEN allocated with @@ -6701,7 +6901,7 @@ 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) + -- Function: void must_free (char *PTR, sizet LEN) | `must_free' is used to free a block of memory allocated by the above functions and pointed to by PTR. LEN is the length of the block in bytes, but this value is used only for debugging purposes. @@ -6711,22 +6911,22 @@ must be large enough. File: scm.info, Node: Embedding SCM, Next: Callbacks, Prev: Allocating memory, Up: Operations -Embedding SCM -------------- +6.2.10 Embedding SCM | +-------------------- | The file `scmmain.c' contains the definition of main(). When SCM is compiled as a library `scmmain.c' is not included in the library; a copy of `scmmain.c' can be modified to use SCM as an embedded library module. - - Function: int main (int ARGC, char **ARGV) + -- Function: int main (int ARGC, char **ARGV) | This is the top level C routine. The value of the ARGC argument is the number of command line arguments. The ARGV argument is a vector of C strings; its elements are the individual command line argument strings. A null pointer always follows the last element: `ARGV[ARGC]' is this null pointer. - - Variable: char *execpath + -- 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 @@ -6738,11 +6938,11 @@ up SCM as you want it. If you need more control than is possible through ARGV, here are descriptions of the functions which main() calls. - - Function: void init_sbrk (void) + -- Function: void init_sbrk (void) | Call this before SCM calls malloc(). Value returned from sbrk() is used to gauge how much storage SCM uses. - - Function: char * scm_find_execpath (int ARGC, char **ARGV, char + -- 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 @@ -6757,7 +6957,7 @@ and DIRSEP control scm_find_implpath()'s operation. If your application has an easier way to locate initialization code for SCM, then you can replace `scm_find_implpath'. - - Function: char * scm_find_implpath (char *EXECPATH) + -- Function: char * scm_find_implpath (char *EXECPATH) | Returns the full pathname of the Scheme initialization file or 0 if it cannot find it. @@ -6766,11 +6966,11 @@ 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 "Init5d9_scm"), and the directory separator string | + (default "Init5e1_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. - - Function: int init_buf0 (FILE *INPORT) + -- Function: int init_buf0 (FILE *INPORT) | Tries to determine whether INPORT (usually stdin) is an interactive input port which should be used in an unbuffered mode. If so, INPORT is set to unbuffered and non-zero is returned. @@ -6780,7 +6980,7 @@ SCM, then you can replace `scm_find_implpath'. Its value can be used as the last argument to scm_init_from_argv(). - - Function: void scm_init_from_argv (int ARGC, char **ARGV, char + -- Function: void scm_init_from_argv (int ARGC, char **ARGV, char | *SCRIPT_ARG, int IVERBOSE, int BUF0STDIN) Initializes SCM storage and creates a list of the argument strings PROGRAM-ARGUMENTS from ARGV. ARGC and ARGV must already be @@ -6792,15 +6992,15 @@ SCM, then you can replace `scm_find_implpath'. Call `init_signals' and `restore_signals' only if you want SCM to handle interrupts and signals. - - Function: void init_signals (void) + -- Function: void init_signals (void) | Initializes handlers for `SIGINT' and `SIGALRM' if they are supported by the C implementation. All of the signal handlers immediately reestablish themselves by a call to `signal()'. - - Function: void restore_signals (void) + -- Function: void restore_signals (void) | Restores the handlers in effect when `init_signals' was called. - - Function: SCM scm_top_level (char *INITPATH, SCM (*toplvl_fun)()) + -- Function: SCM scm_top_level (char *INITPATH, SCM (*toplvl_fun)()) | This is SCM's top-level. Errors longjmp here. TOPLVL_FUN is a callback function of zero arguments that is called by `scm_top_level' to do useful work - if zero, then `repl', which @@ -6824,7 +7024,7 @@ handle interrupts and signals. resignalled. If `toplvl_fun' can not recover from an error situation it may simply return. - - Function: void final_scm (int FREEALL) + -- Function: void final_scm (int FREEALL) | Calls all finalization routines registered with add_final(). If FREEALL is non-zero, then all memory which SCM allocated with malloc() will be freed. @@ -6839,7 +7039,7 @@ Use `apply' to call Scheme procedures from your C code. For example: apply(CDR(intern("srv:startup",sizeof("srv:startup")-1)), mksproc(srvproc), listofnull); - + func = CDR(intern(rpcname,strlen(rpcname))); retval = apply(func, cons(mksproc(srvproc), args), EOL); @@ -6852,13 +7052,13 @@ Here is a minimal embedding program `libtest.c': #include "scm.h" /* include patchlvl.h for SCM's INIT_FILE_NAME. */ #include "patchlvl.h" - + void libtest_init_user_scm() | { fputs("This is libtest_init_user_scm\n", stderr); fflush(stderr); | sysintern("*the-string*", makfrom0str("hello world\n")); } - + SCM user_main() { static int done = 0; @@ -6866,48 +7066,48 @@ Here is a minimal embedding program `libtest.c': scm_ldstr("(display *the-string*)"); return MAKINUM(EXIT_SUCCESS); } - + int main(argc, argv) int argc; char **argv; { SCM retval; char *implpath, *execpath; - + init_user_scm = libtest_init_user_scm; | execpath = dld_find_executable(argv[0]); 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, 0L, 0, 0); - + retval = scm_top_level(implpath, user_main); - + final_scm(!0); return (int)INUM(retval); } - + -| dld_find_executable(./libtest): /home/jaffer/scm/libtest - implpath: /home/jaffer/scm/Init5d9.scm | + implpath: /home/jaffer/scm/Init5e1.scm | This is libtest_init_user_scm | hello world File: scm.info, Node: Callbacks, Next: Type Conversions, Prev: Embedding SCM, Up: Operations -Callbacks ---------- +6.2.11 Callbacks | +---------------- | SCM now has routines to make calling back to Scheme procedures easier. The source code for these routines are found in `rope.c'. - - Function: int scm_ldfile (char *FILE) + -- 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 - `Init5d9.scm'. | + `Init5e1.scm'. | - - Function: int scm_ldprog (char *FILE) + -- Function: int scm_ldprog (char *FILE) | Loads the Scheme source file `(in-vicinity (program-vicinity) FILE)'. Returns 0 if successful, non-0 if not. @@ -6916,11 +7116,11 @@ The source code for these routines are found in `rope.c'. directory from which the calling code was loaded (*note Vicinity: (slib)Vicinity.). - - Function: SCM scm_evstr (char *STR) + -- Function: SCM scm_evstr (char *STR) | Returns the result of reading an expression from STR and evaluating it. - - Function: void scm_ldstr (char *STR) + -- Function: void scm_ldstr (char *STR) | Reads and evaluates all the expressions from STR. If you wish to catch errors during execution of Scheme code, then you @@ -6944,14 +7144,14 @@ Calls to procedures so wrapped will return even if an error occurs. File: scm.info, Node: Type Conversions, Next: Continuations, Prev: Callbacks, Up: Operations -Type Conversions ----------------- +6.2.12 Type Conversions | +----------------------- | These type conversion functions are very useful for connecting SCM and C code. Most are defined in `rope.c'. - - Function: SCM long2num (long N) - - Function: SCM ulong2num (unsigned long N) + -- Function: SCM long2num (long N) | + -- Function: SCM ulong2num (unsigned long N) | Return an object of type `SCM' corresponding to the `long' or `unsigned long' argument N. If N cannot be converted, `BOOL_F' is returned. Which numbers can be converted depends on whether SCM @@ -6960,15 +7160,15 @@ code. Most are defined in `rope.c'. To convert integer numbers of smaller types (`short' or `char'), use the macro `MAKINUM(n)'. - - Function: long num2long (SCM NUM, char *POS, char *S_CALLER) - - Function: unsigned long num2ulong (SCM NUM, char *POS, char + -- Function: long num2long (SCM NUM, char *POS, char *S_CALLER) | + -- Function: unsigned long num2ulong (SCM NUM, char *POS, char | *S_CALLER) - - Function: short num2short (SCM NUM, char *POS, char *S_CALLER) - - Function: unsigned short num2ushort (SCM NUM, char *POS, char + -- Function: short num2short (SCM NUM, char *POS, char *S_CALLER) | + -- Function: unsigned short num2ushort (SCM NUM, char *POS, char | *S_CALLER) - - Function: unsigned char num2uchar (SCM NUM, char *POS, char + -- Function: unsigned char num2uchar (SCM NUM, char *POS, char | *S_CALLER) - - Function: double num2dbl (SCM NUM, char *POS, char *S_CALLER) + -- Function: double num2dbl (SCM NUM, char *POS, char *S_CALLER) | These functions are used to check and convert `SCM' arguments to the named C type. The first argument NUM is checked to see it it is within the range of the destination type. If so, the converted @@ -6976,12 +7176,12 @@ 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 `num2dbl', - `num2long', and `num2ulong' (for when `SCM' is compiled without - bignums). To convert inexact numbers to exact numbers, *Note - inexact->exact: (r5rs)Numerical operations. + _Note_ Inexact numbers are accepted only by `num2dbl', `num2long', | + and `num2ulong' (for when `SCM' is compiled without bignums). To | + convert inexact numbers to exact numbers, *Note inexact->exact: + (r5rs)Numerical operations. | - - Function: unsigned long scm_addr (SCM ARGS, char *S_NAME) + -- Function: unsigned long scm_addr (SCM ARGS, char *S_NAME) | Returns a pointer (cast to an `unsigned long') to the storage corresponding to the location accessed by `aref(CAR(args),CDR(args))'. The string S_NAME is used in any @@ -6990,24 +7190,24 @@ code. Most are defined in `rope.c'. `scm_addr' is useful for performing C operations on strings or other uniform arrays (*note Uniform Array::). - - Function: unsigned long scm_base_addr(SCM RA, char *S_NAME) + -- Function: unsigned long scm_base_addr(SCM RA, char *S_NAME) | Returns a pointer (cast to an `unsigned long') to the beginning of storage of array RA. Note that if RA is a shared-array, the strorage accessed this way may be much larger than RA. - _Note:_ While you use a pointer returned from `scm_addr' or + _Note_ While you use a pointer returned from `scm_addr' or | `scm_base_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. *Note scm_gc_protect: Changing Scm. - - Function: SCM makfrom0str (char *SRC) - - Function: SCM makfromstr (char *SRC, sizet LEN) + -- Function: SCM makfrom0str (char *SRC) | + -- Function: SCM makfromstr (char *SRC, sizet LEN) | Return a newly allocated string `SCM' object copy of the null-terminated string SRC or the string SRC of length LEN, respectively. - - Function: SCM makfromstrs (int ARGC, char **ARGV) + -- Function: SCM makfromstrs (int ARGC, char **ARGV) | Returns a newly allocated `SCM' list of strings corresponding to the ARGC length array of null-terminated strings ARGV. If ARGV is less than `0', ARGV is assumed to be `NULL' terminated. @@ -7016,7 +7216,7 @@ code. Most are defined in `rope.c'. of SCM procedure calls to `program-arguments' (*note program-arguments: SCM Session.). - - Function: char ** makargvfrmstrs (SCM ARGS, char *S_NAME) + -- Function: char ** makargvfrmstrs (SCM ARGS, char *S_NAME) | Returns a `NULL' terminated list of null-terminated strings copied from the `SCM' list of strings ARGS. The string S_NAME is used in messages from error calls by `makargvfrmstrs'. @@ -7024,15 +7224,15 @@ code. Most are defined in `rope.c'. `makargvfrmstrs' is useful for constructing argument lists suitable for passing to `main' functions. - - Function: void must_free_argv (char **ARGV) + -- Function: void must_free_argv (char **ARGV) | Frees the storage allocated to create ARGV by a call to `makargvfrmstrs'. File: scm.info, Node: Continuations, Next: Evaluation, Prev: Type Conversions, Up: Operations -Continuations -------------- +6.2.13 Continuations | +-------------------- | The source files `continue.h' and `continue.c' are designed to function as an independent resource for programs wishing to use continuations, @@ -7049,45 +7249,45 @@ SCM uses the names `jump_buf', `setjump', and `longjump' in lieu of `jmp_buf', `setjmp', and `longjmp' to prevent name and declaration conflicts. - - Data type: CONTINUATION jmpbuf length stkbse other parent + -- Data type: CONTINUATION jmpbuf length stkbse other parent | is a `typedef'ed structure holding all the information needed to represent a continuation. The OTHER slot can be used to hold any data the user wishes to put there by defining the macro `CONTINUATION_OTHER'. - - Macro: SHORT_ALIGN + -- Macro: SHORT_ALIGN | If `SHORT_ALIGN' is `#define'd (in `scmfig.h'), then the it is assumed that pointers in the stack can be aligned on `short int' boundaries. - - Data type: STACKITEM + -- Data type: STACKITEM | is a pointer to objects of the size specified by `SHORT_ALIGN' being `#define'd or not. - - Macro: CHEAP_CONTINUATIONS + -- Macro: CHEAP_CONTINUATIONS | If `CHEAP_CONTINUATIONS' is `#define'd (in `scmfig.h') each `CONTINUATION' has size `sizeof CONTINUATION'. Otherwise, all but "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'. - - Macro: STACK_GROWS_UP + -- Macro: STACK_GROWS_UP | Expresses which way the stack grows by its being `#define'd or not. - - Variable: long thrown_value + -- Variable: long thrown_value | Gets set to the VALUE passed to `throw_to_continuation'. - - Function: long stack_size (STACKITEM *START) + -- Function: long stack_size (STACKITEM *START) | Returns the number of units of size `STACKITEM' which fit between START and the current top of stack. No check is done in this routine to ensure that START is actually in the current stack segment. - - Function: CONTINUATION * make_root_continuation (STACKITEM + -- Function: CONTINUATION * make_root_continuation (STACKITEM | *STACK_BASE) Allocates (`malloc') storage for a `CONTINUATION' of the current extent of stack. This newly allocated `CONTINUATION' is returned @@ -7096,7 +7296,7 @@ conflicts. `setjump(NEW_CONTINUATION->jmpbuf)' in order to complete the capture of this continuation. - - Function: CONTINUATION * make_continuation (CONTINUATION + -- Function: CONTINUATION * make_continuation (CONTINUATION | *PARENT_CONT) Allocates storage for the current `CONTINUATION', copying (or encapsulating) the stack state from `PARENT_CONT->stkbse' to the @@ -7106,11 +7306,11 @@ conflicts. `setjump(NEW_CONTINUATION->jmpbuf)' in order to complete the capture of this continuation. - - Function: void free_continuation (CONTINUATION *CONT) + -- Function: void free_continuation (CONTINUATION *CONT) | Frees the storage pointed to by CONT. Remember to free storage pointed to by `CONT->other'. - - Function: void throw_to_continuation (CONTINUATION *CONT, long + -- Function: void throw_to_continuation (CONTINUATION *CONT, long | VALUE, CONTINUATION *ROOT_CONT) Sets `thrown_value' to VALUE and returns from the continuation CONT. @@ -7131,8 +7331,8 @@ conflicts. File: scm.info, Node: Evaluation, Prev: Continuations, Up: Operations -Evaluation ----------- +6.2.14 Evaluation | +----------------- | SCM uses its type representations to speed evaluation. All of the `subr' types (*note Subr Cells::) are `tc7' types. Since the `tc7' @@ -7178,12 +7378,12 @@ with its cache footprint. In order to keep the size down, certain or because they are part of expensive operations) are instead calls to the C function `evalcar'. - - Variable: symhash + -- Variable: symhash | Top level symbol values are stored in the `symhash' table. `symhash' is an array of lists of `ISYM's and pairs of symbols and values. - - Immediate: ILOC + -- Immediate: ILOC | Whenever a symbol's value is found in the local environment the pointer to the symbol in the code is replaced with an immediate object (`ILOC') which specifies how many environment frames down @@ -7201,7 +7401,7 @@ Adding `#define TEST_FARLOC' to `eval.c' causes `FARLOC's to be generated for all local identifiers; this is useful only for testing memoization. - - Immediate: GLOC + -- Immediate: GLOC | Pointers to symbols not defined in local environments are changed to one plus the value cell address in symhash. This incremented pointer is called a `GLOC'. The low order bit is normally @@ -7218,8 +7418,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. @@ -7229,7 +7429,7 @@ then be replaced with an `ILOC' or `GLOC'. EXPRESSION will not be referenced again. The C function `eval' is safe from this problem. - - Function: SCM eval (SCM EXPRESSION) + -- Function: SCM eval (SCM EXPRESSION) | Returns the result of evaluating EXPRESSION in the top-level environment. `eval' copies `expression' so that memoization does not modify `expression'. @@ -7237,8 +7437,8 @@ then be replaced with an `ILOC' or `GLOC'. File: scm.info, Node: Program Self-Knowledge, Next: Improvements To Make, Prev: Operations, Up: The Implementation -Program Self-Knowledge -====================== +6.3 Program Self-Knowledge | +========================== | * Menu: @@ -7249,8 +7449,8 @@ Program Self-Knowledge File: scm.info, Node: File-System Habitat, Next: Executable Pathname, Prev: Program Self-Knowledge, Up: Program Self-Knowledge -File-System Habitat -------------------- +6.3.1 File-System Habitat | +------------------------- | Where should software reside? Although individually a minor annoyance, cumulatively this question represents many thousands of frustrated user @@ -7279,7 +7479,7 @@ for which this information is either not available or unrelated to the locations of support files, then a higher level interface will be needed. - - Function: char * find_impl_file (char *EXEC_PATH, char + -- Function: char * find_impl_file (char *EXEC_PATH, char | *GENERIC_NAME, char *INITNAME, char *SEP) Given the pathname of this executable (EXEC_PATH), test for the existence of INITNAME in the implementation-vicinity of this @@ -7322,10 +7522,10 @@ needed. File: scm.info, Node: Executable Pathname, Next: Script Support, Prev: File-System Habitat, Up: Program Self-Knowledge -Executable Pathname -------------------- +6.3.2 Executable Pathname | +------------------------- | -For purposes of finding `Init5d9.scm', dumping an executable, and | +For purposes of finding `Init5e1.scm', dumping an executable, and | dynamic linking, a SCM session needs the pathname of its executable image. @@ -7336,7 +7536,7 @@ 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. - - Function: char * dld_find_executable (const char *COMMAND) + -- Function: char * dld_find_executable (const char *COMMAND) | `dld_find_executable' returns the absolute path name of the file that would be executed if COMMAND were given as a command. It looks up the environment variable PATH, searches in each of the @@ -7353,10 +7553,10 @@ the full pathname for the associated executable file. ... } - *Note:* If the current process is executed using the `execve' - call without passing the correct path name as argument 0, - `dld_find_executable (argv[0]) ' will also fail to locate the - executable file. + *Note@:* If the current process is executed using the | + `execve' call without passing the correct path name as | + argument 0, `dld_find_executable (argv[0]) ' will also fail | + to locate the executable file. | `dld_find_executable' returns zero if `command' is not found in any of the directories listed in `PATH'. @@ -7364,25 +7564,25 @@ the full pathname for the associated executable file. File: scm.info, Node: Script Support, Prev: Executable Pathname, Up: Program Self-Knowledge -Script Support --------------- +6.3.3 Script Support | +-------------------- | Source code for these C functions is in the file `script.c'. *Note Scripting:: for a description of script argument processing. `script_find_executable' is only defined on unix systems. - - Function: char * script_find_executable (const char *NAME) + -- Function: char * script_find_executable (const char *NAME) | `script_find_executable' returns the path name of the executable which is invoked by the script file NAME; NAME if it is a binary executable (not a script); or 0 if NAME does not exist or is not executable. - - Function: char ** script_process_argv (int ARGC; char **ARGV) + -- Function: char ** script_process_argv (int ARGC; char **ARGV) | Given an "main" style argument vector ARGV and the number of arguments, ARGC, `script_process_argv' returns a newly allocated argument vector in which the second line of the script being - invoked is substituted for the corresponding meta-argument. + invoked is substituted for the corresponding meta-argument. If the script does not have a meta-argument, or if the file named by the argument following a meta-argument cannot be opened for @@ -7391,14 +7591,14 @@ Scripting:: for a description of script argument processing. `script_process_argv' correctly processes argument vectors of nested script invocations. - - Function: int script_count_argv (char **ARGV) + -- Function: int script_count_argv (char **ARGV) | Returns the number of argument strings in ARGV. File: scm.info, Node: Improvements To Make, Prev: Program Self-Knowledge, Up: The Implementation -Improvements To Make -==================== +6.4 Improvements To Make | +======================== | * Allow users to set limits for `malloc()' storage. @@ -7450,8 +7650,8 @@ Improvements To Make File: scm.info, Node: VMS Dynamic Linking, Prev: Improvements To Make, Up: Improvements To Make | -VMS Dynamic Linking -------------------- +6.4.1 VMS Dynamic Linking | +------------------------- | George Carrette (gjc@mitech.com) outlines how to dynamically link on VMS. There is already some code in `dynl.c' to do this, but someone @@ -7479,7 +7679,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. @@ -7502,18 +7702,18 @@ with a VMS system needs to finish and debug it. made read-only. I have a DCL command procedure to do this if you want it. - 4. Now MAIN.EXE would be linked thusly: + 4. Now MAIN.EXE would be linked thusly: $ DEFINE LISPRTL USER$DISK:[JAFFER]LISPRTL.EXE - + $LINK MAIN.OBJ,SYS$INPUT:/OPT SYS$LIBRARY:VAXCRTL/SHARE LISPRTL/SHARE Note the definition of the `LISPRTL' logical name. Without such a - definition you will need to copy `LISPRTL.EXE' over to - `SYS$SHARE:' (aka `SYS$LIBRARY:') in order to invoke the main - program once it is linked. + definition you will need to copy `LISPRTL.EXE' over to `SYS$SHARE' | + (aka `SYS$LIBRARY') in order to invoke the main program once it is | + linked. | 5. Now say you have a file of optional subrs, `MYSUBRS.C'. And there is a routine `INIT_MYSUBRS' that must be called before using it. @@ -7575,855 +7775,972 @@ Procedure and Macro Index This is an alphabetical list of all the procedures and macros in SCM. + * Menu: -* #!: Unix Scheme Scripts. +* #!: Unix Scheme Scripts. (line 40) | * #': Common-Lisp Read Syntax. + (line 50) | * #+: Common-Lisp Read Syntax. + (line 16) | * #-: Common-Lisp Read Syntax. + (line 26) | * #.: Common-Lisp Read Syntax. + (line 39) | * #;text-till-end-of-line: Documentation and Comments. -* #?column: Load Syntax. | -* #?file: Load Syntax. | -* #?line: Load Syntax. | + (line 31) | +* #?column: Load Syntax. (line 12) | +* #?file: Load Syntax. (line 16) | +* #?line: Load Syntax. (line 11) | * #\token: Common-Lisp Read Syntax. + (line 7) | * #|: Common-Lisp Read Syntax. -* $abs: Numeric. -* $acos: Numeric. -* $acosh: Numeric. -* $asin: Numeric. -* $asinh: Numeric. -* $atan: Numeric. -* $atan2: Numeric. -* $atanh: Numeric. -* $cos: Numeric. -* $cosh: Numeric. -* $exp: Numeric. -* $expt: Numeric. -* $log: Numeric. -* $log10: Numeric. -* $sin: Numeric. -* $sinh: Numeric. -* $sqrt: Numeric. -* $tan: Numeric. -* $tanh: Numeric. -* -: SCM Options. -* ---: SCM Options. -* ---c-source-files=: Build Options. -* ---compiler-options=: Build Options. -* ---defines=: Build Options. -* ---features=: Build Options. -* ---help: SCM Options. -* ---initialization=: Build Options. -* ---libraries=: Build Options. -* ---linker-options=: Build Options. -* ---no-init-file: SCM Options. -* ---object-files=: Build Options. -* ---outname=: Build Options. -* ---platform=: Build Options. -* ---scheme-initial=: Build Options. -* ---type=: Build Options. -* ---version: SCM Options. -* --batch-dialect=: Build Options. -* --script-name=: Build Options. -* -a: SCM Options. -* -b: SCM Options. -* -c <1>: SCM Options. -* -c: Build Options. -* -d: SCM Options. -* -D: Build Options. -* -e: SCM Options. -* -f: SCM Options. -* -F: Build Options. -* -f: Build Options. -* -h <1>: SCM Options. -* -h: Build Options. -* -i <1>: SCM Options. -* -i: Build Options. -* -j: Build Options. -* -l <1>: SCM Options. -* -l: Build Options. -* -m: SCM Options. -* -no-init-file: SCM Options. -* -o <1>: SCM Options. -* -o: Build Options. -* -p <1>: SCM Options. -* -p: Build Options. -* -q: SCM Options. -* -r: SCM Options. -* -s <1>: SCM Options. -* -s: Build Options. -* -t: Build Options. -* -u: SCM Options. -* -v: SCM Options. -* -w: Build Options. -* @apply: Environment Frames. -* @copy-tree: Storage. + (line 29) | +* $abs: Numeric. (line 38) | +* $acos: Numeric. (line 45) | +* $acosh: Numeric. (line 51) | +* $asin: Numeric. (line 44) | +* $asinh: Numeric. (line 50) | +* $atan: Numeric. (line 46) | +* $atan2: Numeric. (line 60) | +* $atanh: Numeric. (line 52) | +* $cos: Numeric. (line 42) | +* $cosh: Numeric. (line 48) | +* $exp: Numeric. (line 39) | +* $expt: Numeric. (line 63) | +* $log: Numeric. (line 40) | +* $log10: Numeric. (line 57) | +* $sin: Numeric. (line 41) | +* $sinh: Numeric. (line 47) | +* $sqrt: Numeric. (line 37) | +* $tan: Numeric. (line 43) | +* $tanh: Numeric. (line 49) | +* -: SCM Options. (line 108) | +* ---: SCM Options. (line 109) | +* ---c-source-files=: Build Options. (line 133) | +* ---compiler-options=: Build Options. (line 118) | +* ---defines=: Build Options. (line 111) | +* ---features=: Build Options. (line 191) | +* ---help: SCM Options. (line 20) | +* ---initialization=: Build Options. (line 141) | +* ---libraries=: Build Options. (line 103) | +* ---linker-options=: Build Options. (line 121) | +* ---no-init-file: SCM Options. (line 17) | +* ---object-files=: Build Options. (line 137) | +* ---outname=: Build Options. (line 97) | +* ---platform=: Build Options. (line 12) | +* ---scheme-initial=: Build Options. (line 125) | +* ---type=: Build Options. (line 146) | +* ---version: SCM Options. (line 23) | +* --batch-dialect=: Build Options. (line 164) | +* --script-name=: Build Options. (line 186) | +* -a: SCM Options. (line 9) | +* -b: SCM Options. (line 98) | +* -c <1>: SCM Options. (line 46) | +* -c: Build Options. (line 132) | +* -d: SCM Options. (line 42) | +* -D: Build Options. (line 110) | +* -e: SCM Options. (line 45) | +* -f: SCM Options. (line 37) | +* -F: Build Options. (line 190) | +* -f: Build Options. (line 68) | +* -h <1>: SCM Options. (line 33) | +* -h: Build Options. (line 163) | +* -i <1>: SCM Options. (line 88) | +* -i: Build Options. (line 140) | +* -j: Build Options. (line 136) | +* -l <1>: SCM Options. (line 36) | +* -l: Build Options. (line 102) | +* -m: SCM Options. (line 75) | +* -no-init-file: SCM Options. (line 16) | +* -o <1>: SCM Options. (line 52) | +* -o: Build Options. (line 96) | +* -p <1>: SCM Options. (line 62) | +* -p: Build Options. (line 11) | +* -q: SCM Options. (line 71) | +* -r: SCM Options. (line 26) | +* -s <1>: SCM Options. (line 103) | +* -s: Build Options. (line 124) | +* -t: Build Options. (line 145) | +* -u: SCM Options. (line 82) | +* -v: SCM Options. (line 66) | +* -w: Build Options. (line 185) | +* @apply: Environment Frames. (line 54) | +* @copy-tree: Storage. (line 16) | * @macroexpand1: Syntactic Hooks for Hygienic Macros. -* _exclusive: Opening and Closing. -* _ionbf: Opening and Closing. -* _tracked: Opening and Closing. -* abort: Internal State. -* access: I/O-Extensions. -* acct: Unix Extensions. -* acons: Storage. -* acosh: Numeric. + (line 107) | +* _exclusive: Opening and Closing. (line 41) | +* _ionbf: Opening and Closing. (line 28) | +* _tracked: Opening and Closing. (line 35) | +* abort: Internal State. (line 15) | +* access: I/O-Extensions. (line 181) | +* acct: Unix Extensions. (line 34) | +* acons: Storage. (line 21) | +* acosh: Numeric. (line 33) | * add-alias: Configure Module Catalog. -* add-finalizer: Storage. + (line 33) | +* add-finalizer: Storage. (line 36) | * add-link: Configure Module Catalog. + (line 12) | * add-source: Configure Module Catalog. -* alarm: Interrupts. -* alarm-interrupt: Interrupts. -* ALLOW_INTS: Signals. -* alrm_signal: Signals. -* ARGC: Cells. -* arithmetic-error: Interrupts. -* array->list: Conventional Arrays. -* array-contents: Conventional Arrays. -* array-equal?: Array Mapping. -* array-fill!: Array Mapping. -* array-map: Array Mapping. | -* array-map!: Array Mapping. -* array-prototype: Uniform Array. -* array?: Uniform Array. -* asinh: Numeric. -* ASRTER: C Macros. -* ASRTGO: C Macros. -* atanh: Numeric. -* bit-count: Bit Vectors. -* bit-count*: Bit Vectors. -* bit-invert!: Bit Vectors. -* bit-position: Bit Vectors. -* bit-set*!: Bit Vectors. -* boot-tail <1>: Dump. -* boot-tail: SCM Session. -* box: Curses Miscellany. -* broken-pipe: Posix Extensions. -* call-with-outputs: Port Redirection. -* CAR: Cells. + (line 41) | +* alarm: Interrupts. (line 24) | +* alarm-interrupt: Interrupts. (line 50) | +* ALLOW_INTS: Signals. (line 33) | +* alrm_signal: Signals. (line 14) | +* ARGC: Cells. (line 57) | +* arithmetic-error: Interrupts. (line 69) | +* array->list: Conventional Arrays. (line 60) | +* array-contents: Conventional Arrays. (line 64) | +* array-equal?: Array Mapping. (line 18) | +* array-fill!: Array Mapping. (line 11) | +* array-map: Array Mapping. (line 43) | +* array-map!: Array Mapping. (line 25) | +* array-prototype: Uniform Array. (line 50) | +* array?: Uniform Array. (line 46) | +* asinh: Numeric. (line 32) | +* ASRTER: C Macros. (line 7) | +* ASRTGO: C Macros. (line 52) | +* atanh: Numeric. (line 34) | +* bit-count: Bit Vectors. (line 15) | +* bit-count*: Bit Vectors. (line 37) | +* bit-invert!: Bit Vectors. (line 23) | +* bit-position: Bit Vectors. (line 18) | +* bit-set*!: Bit Vectors. (line 26) | +* boot-tail <1>: Dump. (line 38) | +* boot-tail: SCM Session. (line 25) | +* box: Curses Miscellany. (line 21) | +* broken-pipe: Posix Extensions. (line 27) | +* call-with-outputs: Port Redirection. (line 26) | +* CAR: Cells. (line 23) | * cbreak: Terminal Mode Setting. -* CCLO_LENGTH: Header Cells. -* CDR: Cells. -* char: Type Conversions. -* char-ready: Port Properties. -* char-ready? <1>: Socket. -* char-ready?: Port Properties. + (line 12) | +* CCLO_LENGTH: Header Cells. (line 101) | +* CDR: Cells. (line 24) | +* char: Type Conversions. (line 27) | +* char-ready: Port Properties. (line 39) | +* char-ready? <1>: Socket. (line 66) | +* char-ready?: Port Properties. (line 37) | * char:sharp: Modifying Read Syntax. | -* CHARS: Header Cells. -* chdir: I/O-Extensions. -* CHEAP_CONTINUATIONS: Continuations. -* chmod: I/O-Extensions. -* chown: Posix Extensions. + (line 23) | +* CHARS: Header Cells. (line 35) | +* chdir: I/O-Extensions. (line 145) | +* CHEAP_CONTINUATIONS: Continuations. (line 37) | +* chmod: I/O-Extensions. (line 160) | +* chown: Posix Extensions. (line 255) | * clearok: Output Options Setting. -* close-port <1>: Window Manipulation. -* close-port <2>: Posix Extensions. -* close-port: Opening and Closing. -* closedir: I/O-Extensions. -* CLOSEDP: Ptob Cells. -* CLOSUREP: Cells. -* CODE: Cells. + (line 11) | +* close-port <1>: Window Manipulation. (line 24) | +* close-port <2>: Posix Extensions. (line 35) | +* close-port: Opening and Closing. (line 55) | +* closedir: I/O-Extensions. (line 101) | +* CLOSEDP: Ptob Cells. (line 43) | +* CLOSUREP: Cells. (line 49) | +* CODE: Cells. (line 52) | * comment: Documentation and Comments. -* CONSP: Cells. -* copy-tree: Storage. -* cosh: Numeric. -* could-not-open: Interrupts. -* current-error-port: Port Redirection. -* current-input-port: Port Properties. -* current-time: Time. -* default-input-port: Line Editing. -* default-output-port: Line Editing. -* defconst: Define and Set. -* DEFER_INTS: Signals. -* defined?: Define and Set. -* defmacro: Defmacro. -* defsyntax: Macro Primitives. -* defvar: Define and Set. -* directory-for-each: I/O-Extensions. -* display: Output. -* dld_find_executable: Executable Pathname. -* dump: Dump. -* duplicate-port: I/O-Extensions. -* dyn:call: Dynamic Linking. -* dyn:link: Dynamic Linking. -* dyn:main-call: Dynamic Linking. -* dyn:unlink: Dynamic Linking. + (line 23) | +* CONSP: Cells. (line 35) | +* copy-tree: Storage. (line 15) | +* cosh: Numeric. (line 28) | +* could-not-open: Interrupts. (line 66) | +* current-error-port: Port Redirection. (line 7) | +* current-input-port: Port Properties. (line 43) | +* current-time: Time. (line 24) | +* default-input-port: Line Editing. (line 21) | +* default-output-port: Line Editing. (line 25) | +* defconst: Define and Set. (line 22) | +* DEFER_INTS: Signals. (line 26) | +* defined?: Define and Set. (line 7) | +* defmacro: Defmacro. (line 6) | +* defsyntax: Macro Primitives. (line 36) | +* defvar: Define and Set. (line 13) | +* directory-for-each: I/O-Extensions. (line 105) | +* display: Output. (line 9) | +* dld_find_executable: Executable Pathname. (line 18) | +* dump: Dump. (line 33) | +* duplicate-port: I/O-Extensions. (line 78) | +* dyn:call: Dynamic Linking. (line 79) | +* dyn:link: Dynamic Linking. (line 71) | +* dyn:main-call: Dynamic Linking. (line 91) | +* dyn:unlink: Dynamic Linking. (line 106) | * echo: Terminal Mode Setting. -* ed: Editing Scheme Code. -* enclose-array: Conventional Arrays. -* end-of-program: Interrupts. -* endwin: Curses. -* ENV: Cells. -* errno: Errors. -* error: Errors. -* eval: Evaluation. -* EVAL: Evaluation. -* eval: Eval and Load. -* eval-string: Eval and Load. -* exec-self: Internal State. -* execl: I/O-Extensions. -* execlp: I/O-Extensions. -* execpath: Internal State. -* execv: I/O-Extensions. -* execvp: I/O-Extensions. -* exit: SCM Session. + (line 39) | +* ed: Editing Scheme Code. (line 7) | +* enclose-array: Conventional Arrays. (line 39) | +* end-of-program: Interrupts. (line 67) | +* endwin: Curses. (line 15) | +* ENV: Cells. (line 53) | +* errno: Errors. (line 92) | +* error: Errors. (line 113) | +* eval: Evaluation. (line 102) | +* EVAL: Evaluation. (line 91) | +* eval: Eval and Load. (line 21) | +* eval-string: Eval and Load. (line 24) | +* exec-self: Internal State. (line 27) | +* execl: I/O-Extensions. (line 207) | +* execlp: I/O-Extensions. (line 208) | +* execpath: Internal State. (line 78) | +* execv: I/O-Extensions. (line 218) | +* execvp: I/O-Extensions. (line 219) | +* exit: SCM Session. (line 19) | * extended-environment: Syntactic Hooks for Hygienic Macros. -* file-position: I/O-Extensions. -* file-set-position: I/O-Extensions. -* fileno: I/O-Extensions. -* final_scm: Embedding SCM. -* find_impl_file: File-System Habitat. -* force-output: Window Manipulation. -* fork: Posix Extensions. -* FPORTP: Ptob Cells. -* free_continuation: Continuations. -* freshline: Port Properties. -* gc: Internal State. -* gc-hook: Storage. -* gc_mark: Marking Cells. -* GCCDR: Marking Cells. -* GCTYP16: Marking Cells. -* gentemp: Defmacro. -* get-internal-real-time: Time. -* get-internal-run-time: Time. -* getcwd: I/O-Extensions. -* getegid: Posix Extensions. -* geteuid: Posix Extensions. -* getgid: Posix Extensions. -* getgr: Posix Extensions. -* getgroups: Posix Extensions. + (line 113) | +* file-position: I/O-Extensions. (line 56) | +* file-set-position: I/O-Extensions. (line 61) | +* fileno: I/O-Extensions. (line 177) | +* final_scm: Embedding SCM. (line 117) | +* find_impl_file: File-System Habitat. (line 35) | +* force-output: Window Manipulation. (line 30) | +* fork: Posix Extensions. (line 44) | +* FPORTP: Ptob Cells. (line 53) | +* frame->environment: Debugging Continuations. | + (line 18) | +* frame-eval: Debugging Continuations. | + (line 27) | +* frame-trace: Debugging Continuations. | + (line 10) | +* free_continuation: Continuations. (line 79) | +* freshline: Port Properties. (line 26) | +* gc: Internal State. (line 57) | +* gc-hook: Storage. (line 28) | +* gc_mark: Marking Cells. (line 27) | +* GCCDR: Marking Cells. (line 15) | +* GCTYP16: Marking Cells. (line 19) | +* gentemp: Defmacro. (line 6) | +* get-internal-real-time: Time. (line 17) | +* get-internal-run-time: Time. (line 10) | +* getcwd: I/O-Extensions. (line 150) | +* getegid: Posix Extensions. (line 63) | +* geteuid: Posix Extensions. (line 66) | +* getgid: Posix Extensions. (line 60) | +* getgr: Posix Extensions. (line 224) | +* getgroups: Posix Extensions. (line 245) | * gethost: Host and Other Inquiries. -* getlogin: SCM Session. + (line 11) | +* getlogin: SCM Session. (line 33) | * getnet: Host and Other Inquiries. + (line 34) | * getpeername: Internet Addresses and Socket Names. -* getpid: I/O-Extensions. -* getppid: Posix Extensions. + (line 33) | +* getpid: I/O-Extensions. (line 53) | +* getppid: Posix Extensions. (line 53) | * getproto: Host and Other Inquiries. -* getpw: Posix Extensions. + (line 54) | +* getpw: Posix Extensions. (line 193) | * getserv: Host and Other Inquiries. + (line 73) | * getsockname: Internet Addresses and Socket Names. -* getuid: Posix Extensions. -* getyx: Input. -* hang-up: Interrupts. -* ICHR: Immediates. -* ICHRP: Immediates. + (line 29) | +* getuid: Posix Extensions. (line 57) | +* getyx: Input. (line 24) | +* hang-up: Interrupts. (line 68) | +* ICHR: Immediates. (line 51) | +* ICHRP: Immediates. (line 48) | * identifier->symbol: Syntactic Hooks for Hygienic Macros. + (line 37) | * identifier-equal?: Syntactic Hooks for Hygienic Macros. + (line 89) | * identifier?: Syntactic Hooks for Hygienic Macros. + (line 13) | * idlok: Output Options Setting. -* IFLAGP: Immediates. -* IMP: Immediates. + (line 18) | +* IFLAGP: Immediates. (line 83) | +* IMP: Immediates. (line 11) | * inet:address->string: Internet Addresses and Socket Names. + (line 11) | * inet:local-network-address: Internet Addresses and Socket Names. + (line 19) | * inet:make-address: Internet Addresses and Socket Names. + (line 23) | * inet:network: Internet Addresses and Socket Names. + (line 15) | * inet:string->address: Internet Addresses and Socket Names. -* init_buf0: Embedding SCM. -* init_sbrk: Embedding SCM. -* init_signals <1>: Embedding SCM. -* init_signals: Signals. -* initscr: Curses. -* INPORTP: Ptob Cells. -* int_signal: Signals. -* integer->line-number: Line Numbers. -* INUM: Immediates. -* INUMP: Immediates. -* isatty?: Port Properties. -* ISYMCHARS: Immediates. -* ISYMNUM: Immediates. -* ISYMP: Immediates. -* kill: Posix Extensions. + (line 7) | +* init_buf0: Embedding SCM. (line 63) | +* init_sbrk: Embedding SCM. (line 31) | +* init_signals <1>: Embedding SCM. (line 85) | +* init_signals: Signals. (line 7) | +* initscr: Curses. (line 11) | +* INPORTP: Ptob Cells. (line 37) | +* int_signal: Signals. (line 13) | +* integer->line-number: Line Numbers. (line 37) | +* INUM: Immediates. (line 26) | +* INUMP: Immediates. (line 21) | +* isatty?: Port Properties. (line 33) | +* ISYMCHARS: Immediates. (line 93) | +* ISYMNUM: Immediates. (line 89) | +* ISYMP: Immediates. (line 86) | +* kill: Posix Extensions. (line 85) | * leaveok: Output Options Setting. -* LENGTH: Header Cells. -* line-editing: Line Editing. -* line-number: Eval and Load. -* line-number->integer: Line Numbers. -* line-number?: Line Numbers. -* link: Posix Extensions. -* list->uniform-array: Uniform Array. -* load: Dynamic Linking. -* load-string: Eval and Load. + (line 32) | +* LENGTH: Header Cells. (line 22) | +* line-editing: Line Editing. (line 33) | +* line-number: Eval and Load. (line 34) | +* line-number->integer: Line Numbers. (line 41) | +* line-number?: Line Numbers. (line 44) | +* link: Posix Extensions. (line 248) | +* list->uniform-array: Uniform Array. (line 54) | +* load: Dynamic Linking. (line 28) | +* load-string: Eval and Load. (line 29) | * load:sharp: Modifying Read Syntax. | -* logaref: Uniform Array. -* logaset!: Uniform Array. -* long: Type Conversions. -* long2num: Type Conversions. -* lstat: Unix Extensions. -* macroexpand: Defmacro. -* macroexpand-1: Defmacro. -* main: Embedding SCM. -* makargvfrmstrs: Type Conversions. -* makcclo: Header Cells. + (line 17) | +* logaref: Uniform Array. (line 86) | +* logaset!: Uniform Array. (line 98) | +* long: Type Conversions. (line 22) | +* long2num: Type Conversions. (line 10) | +* lstat: Unix Extensions. (line 23) | +* macroexpand: Defmacro. (line 6) | +* macroexpand-1: Defmacro. (line 6) | +* main: Embedding SCM. (line 12) | +* makargvfrmstrs: Type Conversions. (line 76) | +* makcclo: Header Cells. (line 96) | * make-arbiter: Process Synchronization. -* make-edited-line-port: Line Editing. + (line 35) | +* make-edited-line-port: Line Editing. (line 29) | * make-exchanger: Process Synchronization. -* make-soft-port: Soft Ports. -* make-stream-socket: Socket. -* make-stream-socketpair: Socket. -* make_continuation: Continuations. -* make_gsubr: Defining Subrs. -* make_root_continuation: Continuations. -* makfrom0str: Type Conversions. -* makfromstr: Type Conversions. -* makfromstrs: Type Conversions. -* MAKICHR: Immediates. -* MAKIFLAG: Immediates. -* MAKINUM: Immediates. -* MAKISYM: Immediates. -* MAKSPCSYM: Immediates. -* mark_locations: Marking Cells. -* milli-alarm: Interrupts. -* mkdir: I/O-Extensions. -* mknod: Unix Extensions. -* must_free: Allocating memory. -* must_free_argv: Type Conversions. -* must_malloc: Allocating memory. -* must_malloc_cell: Allocating memory. -* must_realloc: Allocating memory. -* must_realloc_cell: Allocating memory. -* mvwin: Window Manipulation. -* NCONSP: Cells. -* NEWCELL: Cells. -* newwin: Window Manipulation. -* nice: Unix Extensions. -* NIMP: Immediates. -* NINUMP: Immediates. + (line 12) | +* make-soft-port: Soft Ports. (line 10) | +* make-stream-socket: Socket. (line 14) | +* make-stream-socketpair: Socket. (line 24) | +* make_continuation: Continuations. (line 70) | +* make_gsubr: Defining Subrs. (line 15) | +* make_root_continuation: Continuations. (line 61) | +* makfrom0str: Type Conversions. (line 61) | +* makfromstr: Type Conversions. (line 62) | +* makfromstrs: Type Conversions. (line 67) | +* MAKICHR: Immediates. (line 54) | +* MAKIFLAG: Immediates. (line 103) | +* MAKINUM: Immediates. (line 29) | +* MAKISYM: Immediates. (line 100) | +* MAKSPCSYM: Immediates. (line 97) | +* mark_locations: Marking Cells. (line 33) | +* milli-alarm: Interrupts. (line 30) | +* mkdir: I/O-Extensions. (line 131) | +* mknod: Unix Extensions. (line 43) | +* must_free: Allocating memory. (line 43) | +* must_free_argv: Type Conversions. (line 84) | +* must_malloc: Allocating memory. (line 14) | +* must_malloc_cell: Allocating memory. (line 13) | +* must_realloc: Allocating memory. (line 24) | +* must_realloc_cell: Allocating memory. (line 22) | +* mvwin: Window Manipulation. (line 41) | +* NCONSP: Cells. (line 36) | +* NEWCELL: Cells. (line 13) | +* newwin: Window Manipulation. (line 7) | +* nice: Unix Extensions. (line 29) | +* NIMP: Immediates. (line 12) | +* NINUMP: Immediates. (line 22) | * nl: Terminal Mode Setting. + (line 50) | * nocbreak: Terminal Mode Setting. + (line 13) | * nodelay: Output Options Setting. + (line 53) | * noecho: Terminal Mode Setting. + (line 40) | * nonl: Terminal Mode Setting. + (line 51) | * noraw: Terminal Mode Setting. -* NSTRINGP: Header Cells. -* num2dbl: Type Conversions. -* num2long: Type Conversions. -* num2short: Type Conversions. -* NVECTORP: Header Cells. -* open-file: Opening and Closing. -* open-input-pipe: Posix Extensions. -* open-output-pipe: Posix Extensions. -* open-pipe: Posix Extensions. -* open-ports: Opening and Closing. -* opendir: I/O-Extensions. -* OPENP: Ptob Cells. -* OPFPORTP: Ptob Cells. -* OPINFPORTP: Ptob Cells. -* OPINPORTP: Ptob Cells. -* OPOUTFPORTP: Ptob Cells. -* OPOUTPORTP: Ptob Cells. -* OPPORTP: Ptob Cells. -* out-of-storage: Interrupts. -* OUTPORTP: Ptob Cells. -* overlay: Window Manipulation. -* overwrite: Window Manipulation. -* perror: Errors. -* pi*: Numeric. -* pi/: Numeric. -* pipe: Posix Extensions. -* port-closed?: Port Properties. -* port-column: Port Properties. -* port-filename: Port Properties. -* port-line: Port Properties. -* port-type: Port Properties. -* PORTP: Ptob Cells. + (line 29) | +* NSTRINGP: Header Cells. (line 45) | +* num2dbl: Type Conversions. (line 28) | +* num2long: Type Conversions. (line 20) | +* num2short: Type Conversions. (line 23) | +* NVECTORP: Header Cells. (line 17) | +* open-file: Opening and Closing. (line 7) | +* open-input-pipe: Posix Extensions. (line 17) | +* open-output-pipe: Posix Extensions. (line 22) | +* open-pipe: Posix Extensions. (line 10) | +* open-ports: Opening and Closing. (line 48) | +* opendir: I/O-Extensions. (line 88) | +* OPENP: Ptob Cells. (line 42) | +* OPFPORTP: Ptob Cells. (line 54) | +* OPINFPORTP: Ptob Cells. (line 55) | +* OPINPORTP: Ptob Cells. (line 35) | +* OPOUTFPORTP: Ptob Cells. (line 56) | +* OPOUTPORTP: Ptob Cells. (line 36) | +* OPPORTP: Ptob Cells. (line 34) | +* out-of-storage: Interrupts. (line 65) | +* OUTPORTP: Ptob Cells. (line 38) | +* overlay: Window Manipulation. (line 46) | +* overwrite: Window Manipulation. (line 47) | +* perror: Errors. (line 101) | +* pi*: Numeric. (line 21) | +* pi/: Numeric. (line 24) | +* pipe: Posix Extensions. (line 40) | +* port-closed?: Port Properties. (line 7) | +* port-column: Port Properties. (line 19) | +* port-filename: Port Properties. (line 14) | +* port-line: Port Properties. (line 18) | +* port-type: Port Properties. (line 10) | +* PORTP: Ptob Cells. (line 33) | +* pp: Debugging Scheme Code. | + (line 79) | +* pprint: Debugging Scheme Code. | + (line 66) | * print: Debugging Scheme Code. + (line 58) | * print-args: Debugging Scheme Code. -* procedure->identifier-macro: Macro Primitives. -* procedure->macro: Macro Primitives. -* procedure->memoizing-macro: Macro Primitives. -* procedure->syntax: Macro Primitives. + (line 84) | +* procedure->identifier-macro: Macro Primitives. (line 14) | +* procedure->macro: Macro Primitives. (line 12) | +* procedure->memoizing-macro: Macro Primitives. (line 13) | +* procedure->syntax: Macro Primitives. (line 7) | * procedure-documentation: Documentation and Comments. -* profile-alarm: Interrupts. -* profile-alarm-interrupt: Interrupts. -* program-arguments: SCM Session. -* putenv: I/O-Extensions. -* qase: Define and Set. -* quit: SCM Session. + (line 7) | +* profile-alarm: Interrupts. (line 32) | +* profile-alarm-interrupt: Interrupts. (line 52) | +* program-arguments: SCM Session. (line 30) | +* putenv: I/O-Extensions. (line 223) | +* qase: Define and Set. (line 45) | +* quit: SCM Session. (line 17) | * raw: Terminal Mode Setting. -* read-char <1>: Input. -* read-char: Port Properties. -* read-for-load: Line Numbers. | -* read-numbered: Line Numbers. -* read:sharp: Modifying Read Syntax. | -* readdir: I/O-Extensions. -* readlink: Unix Extensions. -* record-printer-set!: Records. -* redirect-port!: I/O-Extensions. -* refresh: Window Manipulation. + (line 28) | +* read-char <1>: Input. (line 7) | +* read-char: Port Properties. (line 40) | +* read-for-load: Line Numbers. (line 47) | +* read-numbered: Line Numbers. (line 26) | +* read:sharp: Modifying Read Syntax. + (line 7) | +* readdir: I/O-Extensions. (line 92) | +* readlink: Unix Extensions. (line 19) | +* record-printer-set!: Records. (line 10) | +* redirect-port!: I/O-Extensions. (line 83) | +* refresh: Window Manipulation. (line 29) | * regcomp: Regular Expression Pattern Matching. + (line 12) | * regerror: Regular Expression Pattern Matching. + (line 34) | * regexec: Regular Expression Pattern Matching. + (line 38) | * regmatch: Regular Expression Pattern Matching. + (line 53) | * regmatch?: Regular Expression Pattern Matching. + (line 46) | * regmatchv: Regular Expression Pattern Matching. + (line 54) | * regsearch: Regular Expression Pattern Matching. + (line 51) | * regsearchv: Regular Expression Pattern Matching. + (line 52) | * release-arbiter: Process Synchronization. -* rename-file: I/O-Extensions. + (line 43) | +* rename-file: I/O-Extensions. (line 155) | * renamed-identifier: Syntactic Hooks for Hygienic Macros. + (line 26) | * renaming-transformer: Syntactic Hooks for Hygienic Macros. -* reopen-file: I/O-Extensions. -* require: Dynamic Linking. + (line 142) | +* reopen-file: I/O-Extensions. (line 74) | +* require: Dynamic Linking. (line 11) | * resetty: Terminal Mode Setting. -* restart: Internal State. -* restore_signals: Embedding SCM. -* rewinddir: I/O-Extensions. -* rmdir: I/O-Extensions. -* room: Internal State. + (line 58) | +* restart: Internal State. (line 18) | +* restore_signals: Embedding SCM. (line 90) | +* rewinddir: I/O-Extensions. (line 97) | +* rmdir: I/O-Extensions. (line 140) | +* room: Internal State. (line 61) | * savetty: Terminal Mode Setting. -* scalar->array: Array Mapping. -* scm_evstr: Callbacks. -* scm_find_execpath: Embedding SCM. -* scm_find_implpath: Embedding SCM. -* scm_gc_protect: Changing Scm. -* scm_init_from_argv: Embedding SCM. -* scm_ldfile: Callbacks. -* scm_ldprog: Callbacks. -* scm_ldstr: Callbacks. -* scm_protect_temp: Changing Scm. -* scm_top_level: Embedding SCM. -* script_count_argv: Script Support. -* script_find_executable: Script Support. -* script_process_argv: Script Support. -* scroll: Output. + (line 59) | +* scalar->array: Array Mapping. (line 51) | +* scm_evstr: Callbacks. (line 24) | +* scm_find_execpath: Embedding SCM. (line 36) | +* scm_find_implpath: Embedding SCM. (line 50) | +* scm_gc_protect: Changing Scm. (line 35) | +* scm_init_from_argv: Embedding SCM. (line 74) | +* scm_ldfile: Callbacks. (line 10) | +* scm_ldprog: Callbacks. (line 15) | +* scm_ldstr: Callbacks. (line 28) | +* scm_protect_temp: Changing Scm. (line 26) | +* scm_top_level: Embedding SCM. (line 93) | +* scope-trace: Debugging Continuations. | + (line 23) | +* script_count_argv: Script Support. (line 31) | +* script_find_executable: Script Support. (line 12) | +* script_process_argv: Script Support. (line 18) | +* scroll: Output. (line 79) | * scrollok: Output Options Setting. -* serial-array-copy!: Array Mapping. -* serial-array-map!: Array Mapping. -* set!: Define and Set. -* setegid: Posix Extensions. -* seteuid: Posix Extensions. -* setgid: Posix Extensions. -* setgrent: Posix Extensions. + (line 40) | +* serial-array-map!: Array Mapping. (line 39) | +* serial-array:copy!: Array Mapping. (line 15) | +* set!: Define and Set. (line 31) | +* setegid: Posix Extensions. (line 77) | +* seteuid: Posix Extensions. (line 81) | +* setgid: Posix Extensions. (line 73) | +* setgrent: Posix Extensions. (line 238) | * sethostent: Host and Other Inquiries. + (line 26) | * setnetent: Host and Other Inquiries. + (line 47) | * setprotoent: Host and Other Inquiries. -* setpwent: Posix Extensions. + (line 65) | +* setpwent: Posix Extensions. (line 217) | * setservent: Host and Other Inquiries. -* setuid: Posix Extensions. -* short: Type Conversions. -* SHORT_ALIGN: Continuations. -* SIDEVAL: Evaluation. -* sinh: Numeric. + (line 87) | +* setuid: Posix Extensions. (line 69) | +* short: Type Conversions. (line 25) | +* SHORT_ALIGN: Continuations. (line 28) | +* SIDEVAL: Evaluation. (line 92) | +* sinh: Numeric. (line 27) | * socket-name:address: Internet Addresses and Socket Names. + (line 43) | * socket-name:family: Internet Addresses and Socket Names. + (line 37) | * socket-name:port-number: Internet Addresses and Socket Names. -* socket:accept: Socket. -* socket:bind: Socket. -* socket:connect: Socket. -* socket:listen: Socket. -* socket:shutdown: Socket. -* stack-trace: Errors. -* STACK_GROWS_UP: Continuations. -* stack_size: Continuations. -* stat: I/O-Extensions. -* STREAM: Ptob Cells. + (line 40) | +* socket:accept: Socket. (line 72) | +* socket:bind: Socket. (line 51) | +* socket:connect: Socket. (line 45) | +* socket:listen: Socket. (line 59) | +* socket:shutdown: Socket. (line 33) | +* stack-trace: Errors. (line 132) | +* STACK_GROWS_UP: Continuations. (line 48) | +* stack_size: Continuations. (line 54) | +* stat: I/O-Extensions. (line 10) | +* STREAM: Ptob Cells. (line 46) | * string-edit: Regular Expression Pattern Matching. + (line 104) | * string-split: Regular Expression Pattern Matching. + (line 96) | * string-splitv: Regular Expression Pattern Matching. -* STRINGP: Header Cells. -* subwin: Window Manipulation. -* SYMBOLP: Header Cells. -* symlink: Unix Extensions. -* sync: Unix Extensions. + (line 97) | +* STRINGP: Header Cells. (line 44) | +* subwin: Window Manipulation. (line 14) | +* SYMBOLP: Header Cells. (line 32) | +* symlink: Unix Extensions. (line 12) | +* sync: Unix Extensions. (line 50) | * syntax-quote: Syntactic Hooks for Hygienic Macros. -* syntax-rules: Syntax-Rules. -* tanh: Numeric. + (line 123) | +* syntax-rules: Syntax-Rules. (line 6) | +* tanh: Numeric. (line 29) | * the-macro: Syntactic Hooks for Hygienic Macros. -* throw_to_continuation: Continuations. -* ticks: Interrupts. -* ticks-interrupt: Interrupts. -* touchline: Window Manipulation. -* touchwin: Window Manipulation. + (line 129) | +* throw_to_continuation: Continuations. (line 84) | +* ticks: Interrupts. (line 7) | +* ticks-interrupt: Interrupts. (line 17) | +* touchline: Window Manipulation. (line 55) | +* touchwin: Window Manipulation. (line 54) | * trace: Debugging Scheme Code. -* transpose-array: Conventional Arrays. + (line 41) | +* transpose-array: Conventional Arrays. (line 21) | * try-arbiter: Process Synchronization. -* try-create-file: I/O-Extensions. -* try-load <1>: Line Numbers. -* try-load: Eval and Load. -* try-open-file: Opening and Closing. -* ttyname: Posix Extensions. -* TYP16: Cells. -* TYP3: Cells. -* TYP7: Cells. -* UCHARS: Header Cells. -* ulong2num: Type Conversions. -* umask: I/O-Extensions. -* uname: Posix Extensions. -* unctrl: Curses Miscellany. -* uniform-array-read!: Uniform Array. -* uniform-array-write: Uniform Array. + (line 39) | +* try-create-file: I/O-Extensions. (line 67) | +* try-load <1>: Line Numbers. (line 12) | +* try-load: Eval and Load. (line 7) | +* try-open-file: Opening and Closing. (line 8) | +* ttyname: Posix Extensions. (line 262) | +* TYP16: Cells. (line 29) | +* TYP3: Cells. (line 27) | +* TYP7: Cells. (line 28) | +* UCHARS: Header Cells. (line 36) | +* ulong2num: Type Conversions. (line 11) | +* umask: I/O-Extensions. (line 172) | +* uname: Posix Extensions. (line 172) | +* unctrl: Curses Miscellany. (line 30) | +* uniform-array-read!: Uniform Array. (line 67) | +* uniform-array-write: Uniform Array. (line 79) | * untrace: Debugging Scheme Code. -* user-interrupt: Interrupts. -* usr:lib: Dynamic Linking. -* utime: I/O-Extensions. -* vector-set-length!: Storage. -* VECTORP: Header Cells. -* VELTS: Header Cells. -* verbose: Internal State. -* virtual-alarm: Interrupts. -* virtual-alarm-interrupt: Interrupts. -* vms-debug: SCM Session. -* void: Sweeping the Heap. -* wadd: Output. -* wait-for-input: Port Properties. -* waitpid: Posix Extensions. -* warn: Errors. -* wclear: Output. -* wclrtobot: Output. -* wclrtoeol: Output. -* wdelch: Output. -* wdeleteln: Output. -* werase: Output. -* winch: Input. -* winsch: Output. -* winsertln: Output. -* with-error-to-file: Port Redirection. -* with-error-to-port: Port Redirection. -* with-input-from-port: Port Redirection. -* with-output-to-port: Port Redirection. -* wmove: Window Manipulation. -* wstandend: Curses Miscellany. -* wstandout: Curses Miscellany. -* x:lib: Dynamic Linking. + (line 49) | +* user-interrupt: Interrupts. (line 49) | +* usr:lib: Dynamic Linking. (line 18) | +* utime: I/O-Extensions. (line 167) | +* vector-set-length!: Storage. (line 7) | +* VECTORP: Header Cells. (line 16) | +* VELTS: Header Cells. (line 21) | +* verbose: Internal State. (line 33) | +* virtual-alarm: Interrupts. (line 31) | +* virtual-alarm-interrupt: Interrupts. (line 51) | +* vms-debug: SCM Session. (line 41) | +* void: Sweeping the Heap. (line 15) | +* wadd: Output. (line 11) | +* wait-for-input: Port Properties. (line 55) | +* waitpid: Posix Extensions. (line 124) | +* warn: Errors. (line 109) | +* wclear: Output. (line 41) | +* wclrtobot: Output. (line 47) | +* wclrtoeol: Output. (line 51) | +* wdelch: Output. (line 54) | +* wdeleteln: Output. (line 61) | +* werase: Output. (line 38) | +* winch: Input. (line 19) | +* winsch: Output. (line 67) | +* winsertln: Output. (line 74) | +* with-error-to-file: Port Redirection. (line 10) | +* with-error-to-port: Port Redirection. (line 21) | +* with-input-from-port: Port Redirection. (line 19) | +* with-output-to-port: Port Redirection. (line 20) | +* wmove: Window Manipulation. (line 65) | +* wstandend: Curses Miscellany. (line 8) | +* wstandout: Curses Miscellany. (line 7) | +* x:lib: Dynamic Linking. (line 23) | Variable Index ************** 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*: Eval and Load. -* *load-reader*: Line Numbers. -* *scm-version*: Internal State. -* *slib-load-reader*: Line Numbers. -* *syntax-rules*: SCM Variables. +* $pi: Numeric. (line 14) | +* *argv*: SCM Variables. (line 25) | +* *execpath: Embedding SCM. (line 19) | +* *interactive* <1>: Internal State. (line 7) | +* *interactive*: SCM Variables. (line 36) | +* *load-pathname*: Eval and Load. (line 15) | +* *load-reader*: Line Numbers. (line 50) | +* *scm-version*: Internal State. (line 66) | +* *slib-load-reader*: Line Numbers. (line 51) | +* *syntax-rules*: SCM Variables. (line 30) | * af_inet: Host and Other Inquiries. + (line 7) | * af_unix: Host and Other Inquiries. -* BOOL_F: Immediates. -* BOOL_T: Immediates. -* EDITOR: SCM Variables. -* EOF_VAL: Immediates. -* EOL: Immediates. -* errobj: Errors. -* HOME: SCM Variables. -* internal-time-units-per-second: Time. -* INUM0: Immediates. -* isymnames: Immediates. -* most-negative-fixnum: Numeric. -* most-positive-fixnum: Numeric. -* NUM_ISPCSYM: Immediates. -* NUM_ISYMS: Immediates. -* open_both: Opening and Closing. -* open_read: Opening and Closing. -* open_write: Opening and Closing. -* pi: Numeric. -* SCHEME_LIBRARY_PATH: SCM Variables. -* SCM_INIT_PATH: SCM Variables. -* symhash: Evaluation. -* thrown_value: Continuations. -* UNDEFINED: Immediates. -* UNSPECIFIED: Immediates. + (line 8) | +* BOOL_F: Immediates. (line 64) | +* BOOL_T: Immediates. (line 61) | +* EDITOR: SCM Variables. (line 18) | +* EOF_VAL: Immediates. (line 71) | +* EOL: Immediates. (line 67) | +* errobj: Errors. (line 82) | +* HOME: SCM Variables. (line 14) | +* internal-time-units-per-second: Time. (line 7) | +* INUM0: Immediates. (line 32) | +* isymnames: Immediates. (line 106) | +* most-negative-fixnum: Numeric. (line 11) | +* most-positive-fixnum: Numeric. (line 7) | +* NUM_ISPCSYM: Immediates. (line 110) | +* NUM_ISYMS: Immediates. (line 111) | +* open_both: Opening and Closing. (line 20) | +* open_read: Opening and Closing. (line 18) | +* open_write: Opening and Closing. (line 19) | +* pi: Numeric. (line 15) | +* SCHEME_LIBRARY_PATH: SCM Variables. (line 11) | +* SCM_INIT_PATH: SCM Variables. (line 7) | +* symhash: Evaluation. (line 51) | +* thrown_value: Continuations. (line 51) | +* UNDEFINED: Immediates. (line 74) | +* UNSPECIFIED: Immediates. (line 78) | Type Index ********** This is an alphabetical list of data types and feature names in SCM. + * Menu: * #! <1>: MS-DOS Compatible Scripts. -* #!: Unix Scheme Scripts. -* array-for-each: Array Mapping. -* CELLPTR: Immediates. -* CONTINUATION: Continuations. -* curses: Dynamic Linking. -* dump: Dump. -* FARLOC: Evaluation. -* GLOC: Evaluation. -* gloc: Immediates. -* i/o-extensions: Socket. -* ichr: Immediates. -* iflags: Immediates. -* ILOC: Evaluation. -* iloc: Immediates. -* inum: Immediates. -* ispcsym: Immediates. -* isym: Immediates. -* meta-argument <1>: Script Support. -* meta-argument: Unix Scheme Scripts. -* ptob: Ptob Cells. -* regex: Dynamic Linking. -* rev2-procedures: Dynamic Linking. -* rev3-procedures: Dynamic Linking. + (line 15) | +* #!: Unix Scheme Scripts. (line 11) | +* array-for-each: Array Mapping. (line 6) | +* CELLPTR: Immediates. (line 129) | +* CONTINUATION: Continuations. (line 22) | +* curses: Dynamic Linking. (line 49) | +* dump: Dump. (line 6) | +* FARLOC: Evaluation. (line 63) | +* GLOC: Evaluation. (line 74) | +* gloc: Immediates. (line 126) | +* i/o-extensions: Socket. (line 10) | +* ichr: Immediates. (line 45) | +* iflags: Immediates. (line 58) | +* ILOC: Evaluation. (line 56) | +* iloc: Immediates. (line 123) | +* inum: Immediates. (line 16) | +* ispcsym: Immediates. (line 120) | +* isym: Immediates. (line 115) | +* meta-argument <1>: Script Support. (line 21) | +* meta-argument: Unix Scheme Scripts. (line 11) | +* ptob: Ptob Cells. (line 6) | +* regex <1>: Sequence Comparison. (line 6) | +* regex: Dynamic Linking. (line 64) | +* rev2-procedures: Dynamic Linking. (line 37) | +* rev3-procedures: Dynamic Linking. (line 38) | * Scheme Script <1>: MS-DOS Compatible Scripts. -* Scheme Script: Unix Scheme Scripts. + (line 15) | +* Scheme Script: Unix Scheme Scripts. (line 11) | * Scheme-Script <1>: MS-DOS Compatible Scripts. -* Scheme-Script: Unix Scheme Scripts. -* smob: Smob Cells. -* socket: Socket. -* spare: Header Cells. -* STACKITEM: Continuations. -* tc16_arbiter: Smob Cells. -* tc16_array: Smob Cells. -* tc16_bigneg: Smob Cells. -* tc16_bigpos: Smob Cells. -* tc16_flo: Smob Cells. -* tc16_inpipe: Ptob Cells. -* tc16_inport: Ptob Cells. -* tc16_ioport: Ptob Cells. -* tc16_macro: Smob Cells. -* tc16_outpipe: Ptob Cells. -* tc16_outport: Ptob Cells. -* tc16_promise: Smob Cells. -* tc16_sfport: Ptob Cells. -* tc16_strport: Ptob Cells. -* tc3_closure: Cells. -* tc3_cons: Cells. -* tc7_asubr: Subr Cells. -* tc7_bvect: Header Cells. -* tc7_contin: Header Cells. -* tc7_cvect: Header Cells. -* tc7_cxr: Subr Cells. -* tc7_dvect: Header Cells. -* tc7_fvect: Header Cells. -* tc7_ivect: Header Cells. -* tc7_lsubr: Subr Cells. -* tc7_lsubr_2: Subr Cells. -* tc7_msymbol: Header Cells. -* tc7_rpsubr: Subr Cells. -* tc7_specfun: Header Cells. -* tc7_ssymbol: Header Cells. -* tc7_string: Header Cells. -* tc7_subr_0: Subr Cells. -* tc7_subr_1: Subr Cells. -* tc7_subr_1o: Subr Cells. -* 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. -* tc_dblr: Smob Cells. -* tc_free_cell: Smob Cells. -* turtle-graphics: Dynamic Linking. -* unexec: Dump. + (line 15) | +* Scheme-Script: Unix Scheme Scripts. (line 11) | +* smob: Smob Cells. (line 6) | +* socket: Socket. (line 87) | +* spare: Header Cells. (line 10) | +* STACKITEM: Continuations. (line 33) | +* tc16_arbiter: Smob Cells. (line 72) | +* tc16_array: Smob Cells. (line 78) | +* tc16_bigneg: Smob Cells. (line 37) | +* tc16_bigpos: Smob Cells. (line 36) | +* tc16_flo: Smob Cells. (line 18) | +* tc16_inpipe: Ptob Cells. (line 21) | +* tc16_inport: Ptob Cells. (line 12) | +* tc16_ioport: Ptob Cells. (line 18) | +* tc16_macro: Smob Cells. (line 75) | +* tc16_outpipe: Ptob Cells. (line 24) | +* tc16_outport: Ptob Cells. (line 15) | +* tc16_promise: Smob Cells. (line 69) | +* tc16_sfport: Ptob Cells. (line 30) | +* tc16_strport: Ptob Cells. (line 27) | +* tc3_closure: Cells. (line 39) | +* tc3_cons: Cells. (line 32) | +* tc7_asubr: Subr Cells. (line 12) | +* tc7_bvect: Header Cells. (line 55) | +* tc7_contin: Header Cells. (line 76) | +* tc7_cvect: Header Cells. (line 73) | +* tc7_cxr: Subr Cells. (line 22) | +* tc7_dvect: Header Cells. (line 70) | +* tc7_fvect: Header Cells. (line 67) | +* tc7_ivect: Header Cells. (line 58) | +* tc7_lsubr: Subr Cells. (line 62) | +* tc7_lsubr_2: Subr Cells. (line 59) | +* tc7_msymbol: Header Cells. (line 29) | +* tc7_rpsubr: Subr Cells. (line 47) | +* tc7_specfun: Header Cells. (line 79) | +* tc7_ssymbol: Header Cells. (line 26) | +* tc7_string: Header Cells. (line 41) | +* tc7_subr_0: Subr Cells. (line 16) | +* tc7_subr_1: Subr Cells. (line 19) | +* tc7_subr_1o: Subr Cells. (line 51) | +* tc7_subr_2: Subr Cells. (line 44) | +* tc7_subr_2o: Subr Cells. (line 55) | +* tc7_subr_3: Subr Cells. (line 41) | +* tc7_svect: Header Cells. (line 64) | +* tc7_uvect: Header Cells. (line 61) | +* tc7_vector: Header Cells. (line 13) | +* tc_dblc: Smob Cells. (line 33) | +* tc_dblr: Smob Cells. (line 30) | +* tc_free_cell: Smob Cells. (line 15) | +* turtle-graphics: Dynamic Linking. (line 56) | +* unexec: Dump. (line 6) | This is an alphabetical list of concepts introduced in this manual. Concept Index ************* + * Menu: * !#: MS-DOS Compatible Scripts. + (line 8) | * !#.exe: MS-DOS Compatible Scripts. + (line 8) | * #!: MS-DOS Compatible Scripts. + (line 8) | * #!.bat: MS-DOS Compatible Scripts. -* array <1>: Conventional Arrays. -* array: Build Options. -* array-for-each: Build Options. -* arrays: Build Options. -* bignums: Build Options. -* byte: Build Options. | -* callbacks: Callbacks. -* careful-interrupt-masking: Build Options. -* cautious: Build Options. -* cheap-continuations: Build Options. -* compiled-closure: Build Options. -* continuations: Continuations. -* curses: Build Options. -* debug: Build Options. + (line 8) | +* array <1>: Conventional Arrays. (line 9) | +* array: Build Options. (line 195) | +* array-for-each: Build Options. (line 198) | +* arrays: Build Options. (line 201) | +* bignums: Build Options. (line 204) | +* byte: Build Options. (line 207) | +* callbacks: Callbacks. (line 6) | +* careful-interrupt-masking: Build Options. (line 210) | +* cautious: Build Options. (line 216) | +* cheap-continuations: Build Options. (line 225) | +* compiled-closure: Build Options. (line 234) | +* continuations: Continuations. (line 6) | +* curses: Build Options. (line 237) | +* debug: Build Options. (line 240) | +* differ: Build Options. (line 245) | * documentation string: Documentation and Comments. -* dump: Build Options. -* dynamic-linking: Build Options. + (line 13) | +* dump: Build Options. (line 248) | +* dynamic-linking: Build Options. (line 251) | * ecache: Memory Management for Environments. -* edit-line: Build Options. -* Embedding SCM: Embedding SCM. -* engineering-notation: Build Options. + (line 6) | +* edit-line: Build Options. (line 254) | +* Embedding SCM: Embedding SCM. (line 6) | +* engineering-notation: Build Options. (line 257) | * environments: Memory Management for Environments. + (line 6) | * exchanger: Process Synchronization. -* Exrename: Bibliography. + (line 6) | +* Exrename: Bibliography. (line 26) | * Extending Scm: Compiling and Linking Custom Files. + (line 13) | * foo.c: Compiling and Linking Custom Files. -* 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. + (line 13) | +* generalized-c-arguments: Build Options. (line 262) | +* graphics: Packages. (line 23) | +* hobbit: Packages. (line 23) | +* i/o-extensions: Build Options. (line 265) | +* IEEE: Bibliography. (line 7) | +* inexact: Build Options. (line 269) | +* JACAL: Bibliography. (line 49) | +* lit: Build Options. (line 272) | +* macro: Build Options. (line 275) | * memory management: Memory Management for Environments. -* mysql: Build Options. -* no-heap-shrink: Build Options. + (line 6) | +* mysql: Build Options. (line 279) | +* no-heap-shrink: Build Options. (line 282) | * NO_ENV_CACHE: Memory Management for Environments. -* none: Build Options. -* posix: Posix Extensions. -* Posix: Posix Extensions. -* posix: Build Options. -* R4RS: Bibliography. -* R5RS: Bibliography. -* reckless: Build Options. -* record: Build Options. -* regex: Build Options. -* rev2-procedures: Build Options. -* rope <1>: Type Conversions. -* rope: Callbacks. -* 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: Unix Extensions. -* Unix: Unix Extensions. -* 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. + (line 89) | +* none: Build Options. (line 287) | +* posix: Posix Extensions. (line 6) | +* Posix: Posix Extensions. (line 6) | +* posix: Build Options. (line 290) | +* R4RS: Bibliography. (line 11) | +* R5RS: Bibliography. (line 18) | +* reckless: Build Options. (line 295) | +* record: Build Options. (line 300) | +* regex: Build Options. (line 304) | +* rev2-procedures: Build Options. (line 307) | +* rope <1>: Type Conversions. (line 6) | +* rope: Callbacks. (line 6) | +* SchemePrimer: Bibliography. (line 39) | +* SICP: Build Options. (line 313) | +* sicp: Build Options. (line 311) | +* SICP: Bibliography. (line 30) | +* signals: Signals. (line 6) | +* Simply: Bibliography. (line 35) | +* single-precision-only: Build Options. (line 325) | +* SLIB: Bibliography. (line 43) | +* socket: Build Options. (line 331) | +* stack-limit: Build Options. (line 335) | +* tick-interrupts: Build Options. (line 342) | +* turtlegr: Build Options. (line 345) | +* unix: Unix Extensions. (line 6) | +* Unix: Unix Extensions. (line 6) | +* unix: Build Options. (line 349) | +* wb: Build Options. (line 353) | +* windows: Build Options. (line 356) | +* X: Packages. (line 23) | +* x <1>: Packages. (line 23) | +* x: Build Options. (line 359) | +* xlib: Packages. (line 23) | +* Xlib: Packages. (line 23) | +* xlib: Build Options. (line 362) | +* xlibscm: Packages. (line 23) | +* Xlibscm: Packages. (line 23) | Tag Table: Node: Top217 -Node: Overview1471 -Node: SCM Features1782 -Node: SCM Authors3794 -Node: Copying4687 -Node: Bibliography7776 -Node: Installing SCM9644 -Node: Making SCM10159 -Node: SLIB11076 -Node: Building SCM12984 -Node: Invoking Build13558 -Node: Build Options15882 -Node: Compiling and Linking Custom Files31338 -Node: Installing Dynamic Linking33321 -Node: Configure Module Catalog35099 -Node: Saving Images37096 -Node: Automatic C Preprocessor Definitions37771 -Node: Problems Compiling41545 -Node: Problems Linking43198 -Node: Problems Running43463 -Node: Testing45571 -Node: Reporting Problems48635 -Node: Operational Features49477 -Node: Invoking SCM49841 -Node: SCM Options51487 -Node: Invocation Examples55906 -Node: SCM Variables56858 -Node: SCM Session58315 -Node: Editing Scheme Code59830 -Node: Debugging Scheme Code61891 -Node: Errors65514 -Node: Memoized Expressions69813 -Node: Internal State72177 -Node: Scripting75309 -Node: Unix Scheme Scripts75603 -Node: MS-DOS Compatible Scripts78663 -Node: Unix Shell Scripts80641 -Node: The Language82786 -Node: Standards Compliance83404 -Node: Storage85801 -Node: Time88267 -Node: Interrupts89244 -Node: Process Synchronization92854 -Node: Files and Ports94391 -Node: Opening and Closing94724 -Node: Port Properties97193 -Node: Port Redirection99852 -Node: Soft Ports101326 -Node: Eval and Load103105 -Node: Line Numbers104507 -Node: Lexical Conventions107446 -Node: Common-Lisp Read Syntax107764 -Node: Load Syntax110587 -Node: Documentation and Comments112063 -Node: Modifying Read Syntax113388 -Node: Syntax115499 -Node: Define and Set116395 -Node: Defmacro119928 -Node: Syntax-Rules121006 -Node: Macro Primitives122815 -Node: Environment Frames124447 -Node: Syntactic Hooks for Hygienic Macros126853 -Node: Packages133814 -Node: Dynamic Linking134616 -Node: Dump139225 -Node: Numeric143234 -Node: Arrays144961 -Node: Conventional Arrays145171 -Node: Uniform Array148868 -Node: Bit Vectors153661 -Node: Array Mapping154948 -Node: Records157791 -Node: I/O-Extensions158654 -Node: Posix Extensions167248 -Node: Unix Extensions176757 -Node: Regular Expression Pattern Matching178659 -Node: Line Editing182609 -Node: Curses183955 -Node: Output Options Setting184878 -Node: Terminal Mode Setting187527 -Node: Window Manipulation190605 -Node: Output194065 -Node: Input197691 -Node: Curses Miscellany198718 -Node: Sockets200142 -Node: Host and Other Inquiries200481 -Node: Internet Addresses and Socket Names203590 -Node: Socket205139 -Node: The Implementation212376 -Node: Data Types212635 -Node: Immediates213456 -Node: Cells217792 -Node: Header Cells219884 -Node: Subr Cells222925 -Node: Ptob Cells225143 -Node: Smob Cells226682 -Node: Data Type Representations229869 -Node: Operations234567 -Node: Garbage Collection235153 -Node: Marking Cells235774 -Node: Sweeping the Heap237876 -Node: Memory Management for Environments238821 -Node: Signals243378 -Node: C Macros244922 -Node: Changing Scm246045 -Node: Defining Subrs250493 -Node: Defining Smobs252370 -Node: Defining Ptobs255416 -Node: Allocating memory256593 -Node: Embedding SCM258906 -Node: Callbacks266761 -Node: Type Conversions268564 -Node: Continuations272586 -Node: Evaluation276800 -Node: Program Self-Knowledge281963 -Node: File-System Habitat282209 -Node: Executable Pathname285809 -Node: Script Support287427 -Node: Improvements To Make288745 -Node: VMS Dynamic Linking290984 -Node: Index295773 +Node: Overview1536 +Node: SCM Features1989 +Node: SCM Authors4143 +Node: Copying5180 +Node: The SCM License5992 +Node: SIOD copyright11557 +Node: Bibliography13107 +Node: Installing SCM15109 +Node: Making SCM15754 +Node: SLIB16819 +Node: Building SCM18877 +Node: Invoking Build19585 +Node: Build Options22040 +Node: Compiling and Linking Custom Files39431 +Node: Installing Dynamic Linking41522 +Node: Configure Module Catalog43406 +Node: Saving Images45624 +Node: Automatic C Preprocessor Definitions46431 +Node: Problems Compiling50361 +Node: Problems Linking52136 +Node: Problems Running52527 +Node: Testing54761 +Node: Reporting Problems58062 +Node: Operational Features59026 +Node: Invoking SCM59588 +Node: SCM Options61368 +Node: Invocation Examples67150 +Node: SCM Variables68222 +Node: SCM Session70260 +Node: Editing Scheme Code72358 +Node: Debugging Scheme Code74649 +Node: Debugging Continuations80426 +Node: Errors87427 +Node: Memoized Expressions92326 +Node: Internal State94798 +Node: Scripting98885 +Node: Unix Scheme Scripts99319 +Node: MS-DOS Compatible Scripts102600 +Node: Unix Shell Scripts104740 +Node: The Language107016 +Node: Standards Compliance107768 +Node: Storage110334 +Node: Time113210 +Node: Interrupts114573 +Node: Process Synchronization118905 +Node: Files and Ports120751 +Node: Opening and Closing121212 +Node: Port Properties124312 +Node: Port Redirection127860 +Node: Soft Ports129689 +Node: Eval and Load131650 +Node: Line Numbers133499 +Node: Lexical Conventions136895 +Node: Common-Lisp Read Syntax137333 +Node: Load Syntax140333 +Node: Documentation and Comments141730 +Node: Modifying Read Syntax143385 +Node: Syntax145660 +Node: Define and Set146702 +Node: Defmacro150533 +Node: Syntax-Rules151743 +Node: Macro Primitives153671 +Node: Environment Frames155625 +Node: Syntactic Hooks for Hygienic Macros158186 +Node: Packages165692 +Node: Dynamic Linking166822 +Node: Dump171974 +Node: Numeric176337 +Node: Arrays180022 +Node: Conventional Arrays180378 +Node: Uniform Array184368 +Node: Bit Vectors189849 +Node: Array Mapping191571 +Node: Records194838 +Node: I/O-Extensions195880 +Node: Posix Extensions205962 +Node: Unix Extensions217519 +Node: Sequence Comparison219966 +Node: Regular Expression Pattern Matching220814 +Node: Line Editing225399 +Node: Curses227122 +Node: Output Options Setting228310 +Node: Terminal Mode Setting231348 +Node: Window Manipulation235160 +Node: Output239259 +Node: Input243747 +Node: Curses Miscellany245089 +Node: Sockets246858 +Node: Host and Other Inquiries247434 +Node: Internet Addresses and Socket Names251582 +Node: Socket253599 +Node: SCMDB261367 +Node: The Implementation262229 +Node: Data Types262689 +Node: Immediates263648 +Node: Cells269986 +Node: Header Cells273065 +Node: Subr Cells277878 +Node: Ptob Cells280896 +Node: Smob Cells283832 +Node: Data Type Representations287795 +Node: Operations292828 +Node: Garbage Collection293552 +Node: Marking Cells294295 +Node: Sweeping the Heap296714 +Node: Memory Management for Environments297826 +Node: Signals302473 +Node: C Macros304436 +Node: Changing Scm305798 +Node: Defining Subrs310460 +Node: Defining Smobs312471 +Node: Defining Ptobs315703 +Node: Allocating memory317010 +Node: Embedding SCM319539 +Node: Callbacks327837 +Node: Type Conversions329939 +Node: Continuations334522 +Node: Evaluation339275 +Node: Program Self-Knowledge344895 +Node: File-System Habitat345255 +Node: Executable Pathname348997 +Node: Script Support350834 +Node: Improvements To Make352348 +Node: VMS Dynamic Linking354705 +Node: Index359712 End Tag Table |