t3x.org / sketchy / sk10.html
SketchyLISP
Reference
  Copyright (C) 2006
Nils M Holm

10 Meta Commands

10.1 Entering Meta Commands

A meta command is entered by typing a colon (:) followed by the command itself on an empty line and without any parentheses left open. Meta commands are specific to SketchyLISP and have no counterparts in R5RS Scheme.

Meta commands must be entered at the SketchyLISP prompt. They will not be recognized in programs.

It is normally not necessary to enter the complete name of a meta command. For example the :show-version meta command may be abbreviated as :show-v or :sv. The first variant includes enough characters to make the command unambiguous, and the second one uses the first character of the command plus the first character after the dash in it.

Many commands can be abbreviated to one character, so you can type :l file instead of :load file and :q to quit.

10.2 :arrow-mode

:arrow-mode 0|1|2 (default: 0)

Specify how to interpret => operators at the top level.

When this option is set to 0, => is an ordinary symbol name.

When this option is set to 1, the => operator introduces a comment, just like ;. Arrow comments allow to enter (or paste) expressions of the form

(+ 1 2 3) => 6

without making the interpreter complain about the =>.

When this option is set to 2, the => operator verifies that the normal form of the most recently evaluated expression is equal to the from on its right. As long as this is the case, nothing special happens:

(cons 'a 'b) => (a . b)   ; everything fine

When the normal form of the lefthand side is not equal to the righthand side of =>, though, an error is reported:

(cons 'a 'b) => foo
=> (a . b)
* 3: REPL: Verification failed; expected: foo

Because this option can break R5RS compliance, it is by default set to zero.

10.3 :closure-form

:closure-form 0|1|2 (default: 0)

The closure form determines how much of a closure will be printed by write, display and the interpreter itself. By default, only the argument list of a closure will be included:

(letrec ((x 'foo))
  (lambda (y) (cons y x)))
=> #<closure (y)>

With :closure-form 1 set, the body of the closure will be included, too, so the normal form of above expression would print as:

#<closure (y) (cons x y)>

Using the :closure-form 2, the lexical context of the closure is included as well:

#<closure (y) (cons x y) ((x . foo) (cons . #<primitive cons>))>

Setting :closure-form 1 or :closure-form 0 is normally a good idea, because closures may contain self-referential structures that take infinite time to print.

10.4 :dump-image

:dump-image file

Dump the complete workspace of the interpreter to the given file. The image can be re-loaded by passing the name of the image file to the interpreter at startup time:

sketchy image-file-name

10.5 :dump-symbols

:dump-symbols [package]

Dump the symbol table of the given package. If no package name is specified, dump the symbols of the default package. This commands also prints the names of all packages created so far. The currently open package is suffixed with the string [open].

10.6 :gc

:gc

Run garbage collection and print some statistics.

10.7 :load

:load file [symbol ...]

Load the content of file. :Load attempts to locate the given file using the following method:

If file begins with a dot (.) or a slash (/) or a tilde (~), file is passed directly to the require function.

Otherwise the following locations are tried:

The SKETCHYSRC environment variable is a colon-separated list of paths. :Load tries to open file (with and without the .scm suffix) in all directories specified in this variable before giving up.

See the description of the require function for further details.

If one or more symbols follow file, they will be silently discarded. This feature serves documentary purposes.

10.8 :quit

:quit

Quit.

10.9 :r5rs-apply

:r5rs-apply on|off (default: off)

When this option is on, the apply function no longer accepts special form handlers (such as and, define, etc) as its first argument. When it is off, SketchyLISP allows you to write code like

(apply and '(#t #t #t))

which does not work in R5RS Scheme, because and is syntax and not a procedure. If you want R5RS-compliant behaviour, use :r5rs-apply on.

10.10 :require

:require file [symbol ...]

Load the content of the given file, if the symbol file is not bound.

:Require uses :load to locate and load the given file.

See the descriptions of the require function and the :load meta command for further details.

10.11 :show-license

:show-license

Print the terms of use.

10.12 :show-version

:show-version

Print version info.

10.13 :statistics

:statistics on|off (default: off)

Switch statistics mode on or off. In statistics mode, the total number of reduction steps and the number of nodes allocated during the reduction will print after each evaluation. Here is an example:

(cons 'a 'b)
=> (a . b)
6 reduction steps
25 nodes allocated

These statistics are not easy to interpret and do not provide much more than a rough basis for comparing algorithms. In the above example the six reduction steps are the following:

(cons (quote a) (quote b))
cons
(quote a)
quote
(quote b)
quote

The process allocates 25 nodes (which are roughly equivalent to atoms), because the interpreter itself allocates temporary storage during reduction.

10.14 :trace

:trace [name]

Turn trace mode on/off. In trace mode, the interpreter will print each application of the specified function after reducing the arguments but before reducing the function Symbol. Each trace line will be prefixed with a plus sign (+). To turn off tracing, use :trace without any argument.