Skip to content

Latest commit

 

History

History
3742 lines (2209 loc) · 44.3 KB

api.md

File metadata and controls

3742 lines (2209 loc) · 44.3 KB

API Index

135 forms available: * ** + - / < <= = > >= abs and apply atom? bang body butlast capitalize car cdr colon comma comment comp complement concat concat2 cond cons constantly dec def defmacro defn doc dotimes downcase drop enumerate error errors eval even? every exclaim exit filter flatten foreach forms fuse gensym help identity if if-not inc interpose is isqrt juxt lambda last len let let* list list* list? load loop macroexpand-1 map mapcat max min neg? not not= nth number? odd? or partial period pos? print printl println progn punctuate punctuate-atom quote randalpha randchoice randigits randint range readlist reduce rem remove repeat repeatedly reverse screen-clear screen-end screen-get-key screen-size screen-start screen-write second set! shell shuffle sleep some sort sort-by source split swallow syntax-quote take test tosentence true? try upcase version when when-not while with-screen zero?

Operators

*

Multiply 0 or more numbers

Type: native function

Arity: 0+

Args: (() . xs)

Examples

> (* 1 2 3)
;;=>
6
> (*)
;;=>
1

**

Exponentiation operator

Type: function

Arity: 2

Args: (n m)

Examples

> (** 1 0)
;;=>
1
> (** 2 4)
;;=>
16
> (** 10 10)
;;=>
10000000000

+

Add 0 or more numbers

Type: native function

Arity: 0+

Args: (() . xs)

Examples

> (+ 1 2 3)
;;=>
6
> (+)
;;=>
0

-

Subtract 0 or more numbers from the first argument

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (- 1 1)
;;=>
0
> (- 5 2 1)
;;=>
2
> (- 99)
;;=>
-99

/

Divide the first argument by the rest

Type: native function

Arity: 2+

Args: (numerator denominator1 . more)

Examples

> (/ 1 2)
;;=>
0
> (/ 12 2 3)
;;=>
2
> (/ 1 0)
;;=>
ERROR: ((builtin function /) (division by zero))

<

Return t if the arguments are in strictly increasing order, () otherwise

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (< 1 2)
;;=>
t
> (< 1 1)
;;=>
()
> (< 1)
;;=>
t
> (apply < (range 100))
;;=>
t

<=

Return t if the arguments are in increasing or equal order, () otherwise

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (<= 1 2)
;;=>
t
> (<= 1 1)
;;=>
t
> (<= 1)
;;=>
t

=

Return t if the arguments are equal, () otherwise

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (= 1 1)
;;=>
t
> (= 1 2)
;;=>
()
> (apply = (repeat 10 t))
;;=>
t

>

Return t if the arguments are in strictly decreasing order, () otherwise

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (> 1 2)
;;=>
()
> (> 1 1)
;;=>
()
> (> 1)
;;=>
t

>=

Return t if the arguments are in decreasing or equal order, () otherwise

Type: native function

Arity: 1+

Args: (x . xs)

Examples

> (>= 1 2)
;;=>
()
> (>= 1 1)
;;=>
t

abs

Return absolute value of x

Type: function

Arity: 1

Args: (x)

Examples

> (abs 1)
;;=>
1
> (abs -100)
;;=>
100

and

Boolean and

Type: special form

Arity: 0+

Args: (() . xs)

Examples

(and)
;;=>
true
> (and t t)
;;=>
true
> (and t t ())
;;=>
()
> (and () (/ 1 0))
;;=>
()

apply

Apply a function to a list of arguments

Type: native function

Arity: 2

Args: (f args)

Examples

> (apply + (repeat 10 1))
;;=>
10
> (apply * (cdr (range 10)))
;;=>
362880

atom?

Return t if the argument is an atom, () otherwise

Type: native function

Arity: 1

Args: (x)

Examples

> (atom? 1)
;;=>
()
> (atom? (quote one))
;;=>
t

bang

Add an exclamation point at end of atom

Type: function

Arity: 1

Args: (a)

Examples

> (bang (quote Bang))
;;=>
Bang!

body

Return the body of a lambda function

Type: native function

Arity: 1

Args: (f)

Examples

> (body (lambda (x) (+ x 1)))
;;=>
((+ x 1))

butlast

Return everything but the last element

Type: function

Arity: 1

Args: (l)

Examples

> (butlast ())
;;=>
()
> (butlast (range 3))
;;=>
(0 1)

capitalize

Return the atom argument, capitalized

Type: function

Arity: 1

Args: (a)

Examples

> (capitalize (quote hello))
;;=>
Hello

car

Return the first element of a list

Type: native function

Arity: 1

Args: (x)

Examples

> (car (quote (one two)))
;;=>
one
> (car ())
;;=>
()

cdr

Return a list with the first element removed

Type: native function

Arity: 1

Args: (x)

Examples

> (cdr (quote (one two)))
;;=>
(two)
> (cdr ())
;;=>
()

colon

Add a colon at end of atom

Type: function

Arity: 1

Args: (a)

Examples

> (colon (quote remember-this))
;;=>
remember-this:

comma

Add a comma at end of atom

Type: function

Arity: 1

Args: (a)

Examples

> (comma (quote hello))
;;=>
hello,

comment

Ignore the expressions in the block

Type: macro

Arity: 0+

Args: (() . body)

Examples

> (comment twas brillig, and the slithy toves did gyre and gimble in the wabe)
;;=>
()

comp

Function composition -- return a function which applies a series of functions in reverse order

Type: function

Arity: 0+

Args: (() . fs)

Examples

> ((comp) (quote hello))
;;=>
hello
> ((comp split) (quote hello))
;;=>
(h e l l o)
> ((comp len split) (quote hello))
;;=>
5
> ((comp (partial apply +) (partial map len) (partial map split)) (quote (hello world)))
;;=>
10

complement

Return the logical complement of the supplied function

Type: function

Arity: 1

Args: (f)

Examples

> ((complement even?) 1)
;;=>
t
> (map (complement odd?) (range 5))
;;=>
(t () t () t)

concat

Concatenenate any number of lists

Type: function

Arity: 0+

Args: (() . lists)

Examples

> (concat (range 3) (quote (wow)) (reverse (range 3)))
;;=>
(0 1 2 wow 2 1 0)

concat2

Concatenate two lists

Type: function

Arity: 2

Args: (a b)

Examples

> (concat2 () ())
;;=>
()
> (concat2 (quote (1 2)) (quote (3 4)))
;;=>
(1 2 3 4)

cond

Fundamental branching construct

Type: special form

Arity: 0+

Args: (() . pairs)

Examples

> (cond)
;;=> ()
> (cond (t 1) (t 2) (t 3))
;;=> 1
> (cond (() 1) (t 2))
;;=> 2

cons

Add an element to the front of a (possibly empty) list

Type: native function

Arity: 2

Args: (x xs)

Examples

> (cons 1 (quote (one two)))
;;=>
(1 one two)
> (cons 1 ())
;;=>
(1)
> (cons 1 2)
;;=>
(1 . 2)

constantly

Given a value, return a function which always returns that value

Type: function

Arity: 1

Args: (x)

Examples

> (map (constantly t) (range 10))
;;=>
(t t t t t t t t t t)

dec

Return the supplied integer argument, minus one

Type: function

Arity: 1

Args: (n)

Examples

> (dec 2)
;;=>
1
> (dec -1)
;;=>
-2

def

Set a value

Type: special form

Arity: 2

Args: (name value)

Examples

> (def a 1)
;;=>
1
> a
;;=>
1

defmacro

Create and name a macro

Type: special form

Arity: 2+

Args: (name args . body)

Examples

> (defmacro ignore-car (l)
    (doc (ignore first element of list,
                 treat rest as normal expression)
         (examples
           (ignore-car (adorable + 1 2 3))
           (ignore-car (deplorable - 4 4))))
    (cdr l))
;;=>
()
> (ignore-car (hilarious * 2 3 4))
;;=>
24
	

defn

Create and name a function

Type: special form

Arity: 2+

Args: (name args . body)

Examples

> (defn add (x y) (+ x y))
;;=>
()
> (add 1 2)
;;=>
3
> (defn add (x y)
    (doc (add two numbers)
         (examples
           (add 1 2)))
    (+ x y))
;;=>
()
> (doc add)
;;=>
((add two numbers) (examples (add 1 2)))

doc

Return the doclist for a function

Type: native function

Arity: 1

Args: (x)

Examples

> (doc (lambda (x) (doc (does stuff) (and other stuff)) (+ x 1)))
;;=>
((does stuff) (and other stuff))

dotimes

Execute body for each value in a list

Type: macro

Arity: 1+

Args: (n . body)

downcase

Return a new atom with all characters in lower case

Type: native function

Arity: 1

Args: (x)

Examples

> (downcase (quote Hello))
;;=>
hello
> (downcase (quote HELLO))
;;=>
hello

drop

Drop n items from a list, then return the rest

Type: function

Arity: 2

Args: (n l)

Examples

> (drop 3 (range 10))
;;=>
(3 4 5 6 7 8 9)

enumerate

Returning list of (i, x) pairs where i is the index (from zero) and x is the original element from l

Type: function

Arity: 1

Args: (l)

Examples

> (enumerate (quote (a b c)))
;;=>
((0 a) (1 b) (2 c))

error

Raise an error

Type: special form

Arity: 1

Args: (l)

Examples

> (defn ensure-list (x)
    (when-not (list? x)
      (error '(ensure-list argument not a list!))))
;;=>
()
> (ensure-list 3)
;;=>
ERROR in '(ensure-list 3)':
(ensure-list argument not a list!)

errors

Error checking, for tests

Type: special form

Arity: 1+

Args: (expected . body)

Examples

> (errors '(is not a function)
    (1))
;;=>
()
> (errors '(is not a function)
    (+))
;;=>
ERROR in '(errors (quote (is not a function)) (+))':
error not found in ((quote (is not a function)) (+))

eval

Evaluate an expression

Type: native function

Arity: 1

Args: (x)

Examples

> (eval (quote (one two)))
;;=>
ERROR: ((builtin function eval) (evaluating function object) (unknown symbol: one))
> (eval (quote (+ 1 2)))
;;=>
3

even?

Return true if the supplied integer argument is even

Type: function

Arity: 1

Args: (n)

Examples

> (map even? (range 5))
;;=>
(t () t () t)

every

Return t if f applied to every element in l is truthy, else ()

Type: function

Arity: 2

Args: (f l)

Examples

> (every odd? (quote (1 3 5)))
;;=>
t
> (every odd? (quote (1 2 3 5)))
;;=>
()

exclaim

Return l as a sentence... emphasized!

Type: function

Arity: 1

Args: (l)

Examples

> (exclaim (quote (well, hello)))
;;=>
(Well, hello!)
> (exclaim (quote (help)))
;;=>
(Help!)
> (exclaim (quote (begone, fiend)))
;;=>
(Begone, fiend!)

exit

Exit the program

Type: native function

Arity: 0

Args: ()

filter

Keep only values for which function f is true

Type: function

Arity: 2

Args: (f l)

Examples

> (filter odd? (range 5))
;;=>
(1 3)

flatten

Return a (possibly nested) list, flattened

Type: function

Arity: 1

Args: (l)

Examples

> (flatten (quote (this is a (really (nested) list))))
;;=>
(this is a really nested list)

foreach

Execute body for each value in a list

Type: macro

Arity: 2+

Args: (x xs . body)

forms

Return available operators, as a list

Type: native function

Arity: 0

Args: ()

fuse

Fuse a list of numbers or atoms into a single atom

Type: native function

Arity: 1

Args: (x)

Examples

> (fuse (quote (A B C)))
;;=>
ABC
> (fuse (reverse (range 10)))
;;=>
9876543210

gensym

Return a new symbol

Type: native function

Arity: 0+

Args: (() . more)

help

Print a help message

Type: native function

Arity: 0

Args: ()

identity

Return the argument

Type: function

Arity: 1

Args: (x)

if

Simple conditional with two branches

Type: macro

Arity: 3

Args: (condition then else)

Examples

> (if t 111 333)
;;=>
111
> (if () (quote abc) (quote def))
;;=>
def

if-not

Simple (inverted) conditional with two branches

Type: macro

Arity: 3

Args: (condition then else)

Examples

> (if-not (odd? 3) (quote (help, they broke three)) (quote (three is odd)))
;;=>
(three is odd)

inc

Return the supplied integer argument, plus one

Type: function

Arity: 1

Args: (n)

interpose

Interpose x between all elements of l

Type: function

Arity: 2

Args: (x l)

Examples

> (interpose BANG (range 5))
;;=>
(0 ! 1 ! 2 ! 3 ! 4)

is

Assert a condition is truthy, or show failing code

Type: macro

Arity: 1

Args: (condition)

Examples

> (is t)
;;=>
()
> (is (car (cons () (quote (this one should fail)))))
;;=>
ERROR: ((assertion failed: (car (cons () (quote (this one should fail))))))

isqrt

Integer square root

Type: native function

Arity: 1

Args: (x)

Examples

> (isqrt 4)
;;=>
2
> (isqrt 5)
;;=>
2

juxt

Create a function which combines multiple operations into a single list of results

Type: function

Arity: 0+

Args: (() . fs)

Examples

> ((juxt inc dec) 0)
;;=>
(1 -1)
> (map (juxt inc dec) (range 3))
;;=>
((1 -1) (2 0) (3 1))
> (map (juxt even? odd? zero?) (quote (-2 -1 0 1 2)))
;;=>
((t () ()) (() t ()) (t () t) (() t ()) (t () ()))
> (map (juxt) (range 3))
;;=>
(() () ())

lambda

Create a function

Type: special form

Arity: 1+

Args: (args . more)

Examples

> ((lambda () t))
;;=>
t
> ((lambda (x) (+ 5 x)) 5)
;;=>
10
> ((lambda my-length (x)
     (if-not x
       0
       (+ 1 (my-length (cdr x)))))
    (range 20))
;;=>
20

last

Return the last item in a list

Type: function

Arity: 1

Args: (l)

Examples

> (last (range 10))
;;=>
9
> (last (split (quote ATOM!)))
;;=>
!

len

Return the length of a list

Type: native function

Arity: 1

Args: (x)

Examples

> (len (range 10))
;;=>
10

let

Create a local scope with bindings

Type: special form

Arity: 1+

Args: (binding-pairs . body)

Examples

> (let ((a 1)
        (b 2))
    (+ a b))
;;=>
3

let*

Let form with ability to refer to previously-bound pairs in the binding list

Type: macro

Arity: 1+

Args: (pairs . body)

Examples

> (let* ((a 1) (b (inc a))) (+ a b))
;;=>
3

list

Return a list of the given arguments

Type: native function

Arity: 0+

Args: (() . xs)

Examples

> (list 1 2 3)
;;=>
(1 2 3)
> (list)
;;=>
()

list*

Create a list by consing everything but the last arg onto the last

Type: function

Arity: 0+

Args: (() . args)

Examples

> (list* 1 2 (quote (3)))
;;=>
(1 2 3)
> (list* 1 2 (quote (3 4)))
;;=>
(1 2 3 4)
> (list*)
;;=>
()

list?

Return t if the argument is a list, () otherwise

Type: native function

Arity: 1

Args: (x)

Examples

> (list? (range 10))
;;=>
t
> (list? 1)
;;=>
()

load

Load and execute a file

Type: native function

Arity: 1

Args: (filename)

loop

Loop forever

Type: special form

Arity: 1+

Args: ()

Examples

> (loop
    (printl '(Help me, I am looping forever!))
    (sleep 1000))
;; Prints =>
Help me, I am looping forever!
Help me, I am looping forever!
Help me, I am looping forever!
...

macroexpand-1

Expand a macro

Type: native function

Arity: 1

Args: (x)

Examples

> (macroexpand-1 (quote (+ x 1)))
;;=>
(+ x 1)
> (macroexpand-1 (quote (if () 1 2)))
;;=>
(cond (() 1) (t 2))

map

Apply the supplied function to every element in the supplied list

Type: function

Arity: 2

Args: (f l)

Examples

> (map odd? (range 5))
;;=>
(() t () t ())
> (map true? (quote (foo t () t 3)))
;;=>
(() t () t ())

mapcat

Map a function onto a list and concatenate results

Type: function

Arity: 2

Args: (f l)

Examples

> (map list (range 5))
;;=>
((0) (1) (2) (3) (4))
> (mapcat list (range 5))
;;=>
(0 1 2 3 4)
> (map range (range 5))
;;=>
(() (0) (0 1) (0 1 2) (0 1 2 3))
> (mapcat range (range 5))
;;=>
(0 0 1 0 1 2 0 1 2 3)

max

Find maximum of one or more numbers

Type: function

Arity: 0+

Args: (() . args)

Examples

> (max -5)
;;=>
-5
> (max 2 3)
;;=>
3
> (apply max (range 10))
;;=>
9

min

Find minimum of one or more numbers

Type: function

Arity: 0+

Args: (() . args)

Examples

> (min -5)
;;=>
-5
> (min 2 3)
;;=>
2
> (apply min (range 10))
;;=>
0

neg?

Return true iff the supplied integer argument is less than zero

Type: function

Arity: 1

Args: (n)

Examples

> (map neg? (map (lambda (x) (- x 5)) (range 10)))
;;=>
(t t t t t () () () () ())

not

Return t if the argument is nil, () otherwise

Type: native function

Arity: 1

Args: (x)

Examples

> (not ())
;;=>
t
> (not t)
;;=>
()
> (not (range 10))
;;=>
()

not=

Complement of = function

Type: function

Arity: 0+

Args: (() . terms)

Examples

> (not= 1 2)
;;=>
t
> (not= (quote a) (quote a))
;;=>
()

nth

Find the nth value of a list, starting from zero

Type: function

Arity: 2

Args: (n l)

Examples

> (nth 3 (quote (one two three four five)))
;;=>
four
> (nth 1000 (range 2))
;;=>
()

number?

Return true if the argument is a number, else ()

Type: native function

Arity: 1

Args: (x)

Examples

> (number? 1)
;;=>
t
> (number? t)
;;=>
()
> (number? +)
;;=>
()

odd?

Return true if the supplied integer argument is odd

Type: function

Arity: 1

Args: (n)

Examples

> (map even? (range 5))
;;=>
(t () t () t)

or

Boolean or

Type: special form

Arity: 0+

Args: (() . xs)

Examples

> (or)
;; => false
> (or t t)
;; => true
> (or t t ())
;; => t

partial

Partial function application

Type: function

Arity: 1+

Args: (f . args)

Examples

> ((partial + 1) 1)
;;=>
2
> ((partial + 2 3) 4 5)
;;=>
14

period

Add a period at end of atom

Type: function

Arity: 1

Args: (a)

Examples

> (period (quote Woot))
;;=>
Woot.

pos?

Return true iff the supplied integer argument is greater than zero

Type: function

Arity: 1

Args: (n)

Examples

> (map pos? (map (lambda (x) (- x 5)) (range 10)))
;;=>
(() () () () () () t t t t)

print

Print the arguments

Type: native function

Arity: 0+

Args: (() . xs)

printl

Print a list argument, without parentheses

Type: native function

Arity: 1

Args: (x)

println

Print the arguments and a newline

Type: native function

Arity: 0+

Args: (() . xs)

progn

Execute multiple statements, returning the last

Type: macro

Arity: 0+

Args: (() . body)

Examples

> (progn)
;;=>
()
> (progn 1 2 3)
;;=>
3

punctuate

Return x capitalized, with punctuation determined by the supplied function

Type: function

Arity: 2

Args: (f x)

punctuate-atom

Add a punctuation mark at end of atom

Type: function

Arity: 2

Args: (a mark)

Examples

> (punctuate-atom (quote list) (quote *))
;;=>
list*
> (punctuate-atom (quote list) COLON)
;;=>
list:

quote

Quote an expression

Type: special form

Arity: 1

Args: (x)

Examples

> (quote foo)
foo
> (quote (1 2 3))
(1 2 3)
> '(1 2 3)
(1 2 3)

randalpha

Return a list of random (English/Latin/unaccented) lower-case alphabetic characters

Type: function

Arity: 1

Args: (n)

randchoice

Return an element at random from the supplied list

Type: function

Arity: 1

Args: (l)

randigits

Return a random integer between 0 and the argument minus 1

Type: function

Arity: 1

Args: (n)

randint

Return a random integer between 0 and the argument minus 1

Type: native function

Arity: 1

Args: (x)

range

List of integers from 0 to n

Type: function

Arity: 1

Args: (n)

Examples

> (range 10)
;;=>
(0 1 2 3 4 5 6 7 8 9)
> (len (range 100))
;;=>
100

readlist

Read a list from stdin

Type: native function

Arity: 0

Args: ()

reduce

Successively apply a function against a list of arguments

Type: function

Arity: 2+

Args: (f x . args)

Examples

> (reduce * (cdr (range 10)))
;;=>
362880
> (reduce (lambda (acc x) (cons x acc)) () (range 10))
;;=>
(9 8 7 6 5 4 3 2 1 0)

rem

Return remainder when second arg divides first

Type: native function

Arity: 2

Args: (x y)

Examples

> (rem 5 2)
;;=>
1
> (rem 4 2)
;;=>
0
> (rem 1 0)
;;=>
ERROR: ((builtin function rem) (division by zero))

remove

Keep only values for which function f is false / the empty list

Type: function

Arity: 2

Args: (f l)

Examples

> (remove odd? (range 5))
;;=>
(0 2 4)

repeat

Return a list of length n whose elements are all x

Type: function

Arity: 2

Args: (n x)

Examples

> (repeat 5 (quote repetitive))
;;=>
(repetitive repetitive repetitive repetitive repetitive)

repeatedly

Return a list of length n whose elements are made from calling f repeatedly

Type: function

Arity: 2

Args: (n f)

Examples

> (repeatedly 3 (lambda () (range 5)))
;;=>
((0 1 2 3 4) (0 1 2 3 4) (0 1 2 3 4))

reverse

Reverse a list

Type: function

Arity: 1

Args: (l)

Examples

> (= (quote (c b a)) (reverse (quote (a b c))))
;;=>
t

screen-clear

Clear the screen

Type: native function

Arity: 0

Args: ()

screen-end

Stop screen for text UIs, return to console mode

Type: native function

Arity: 0

Args: ()

screen-get-key

Return a keystroke as an atom

Type: native function

Arity: 0

Args: ()

screen-size

Return the screen size: width, height

Type: native function

Arity: 0

Args: ()

screen-start

Start screen for text UIs

Type: native function

Arity: 0

Args: ()

screen-write

Write a string to the screen

Type: native function

Arity: 3

Args: (x y list)

second

Return the second element of a list, or () if not enough elements

Type: function

Arity: 1

Args: (l)

Examples

> (second ())
;;=>
()
> (second (quote (a)))
;;=>
()
> (second (quote (a b)))
;;=>
b
> (second (quote (1 2 3)))
;;=>
2

set!

Update a value in an existing binding

Type: special form

Arity: 2

Args: (name value)

Examples

> (def a 1)
;;=>
1
> a
;;=>
1
> (set! a 2)
;;=>
2
> a
;;=>
2

shell

Run a shell subprocess, and return stdout, stderr, and exit code

Type: native function

Arity: 1

Args: (cmd)

shuffle

Return a (quickly!) shuffled list

Type: native function

Arity: 1

Args: (xs)

sleep

Sleep for the given number of milliseconds

Type: native function

Arity: 1

Args: (ms)

some

Return f applied to first element for which that result is truthy, else ()

Type: function

Arity: 2

Args: (f l)

Examples

> (some even? (quote (1 3 5 7 9 11 13)))
;;=>
()
> (some even? (quote (1 3 5 7 9 1000 11 13)))
;;=>
t

sort

Sort a list

Type: native function

Arity: 1

Args: (xs)

Examples

> (sort (quote (3 2 1)))
;;=>
(1 2 3)
> (sort (quote ()))
;;=>
()
> (sort (quote (c b a)))
;;=>
(a b c)

sort-by

Sort a list by a function

Type: native function

Arity: 2

Args: (f xs)

Examples

> (sort-by first (quote ((3) (2) (1))))
;;=>
((1) (2) (3))
> (sort-by first (quote ()))
;;=>
()
> (sort-by second (quote ((quux 333) (zip 222) (afar 111))))
;;=>
((afar 111) (zip 222) (quux 333))

source

Show source for a function

Type: native function

Arity: 1

Args: (form)

Examples

> (source map)
;;=>
(lambda (f l) (when l (cons (f (car l)) (map f (cdr l)))))
> (source +)
;;=>
ERROR: ((builtin function source) (cannot get source of builtin function <builtin: +>))

split

Split an atom or number into a list of single-digit numbers or single-character atoms

Type: native function

Arity: 1

Args: (x)

Examples

> (split 123)
;;=>
(1 2 3)
> (split (quote abc))
;;=>
(a b c)

swallow

Swallow errors thrown in body, return t if any occur

Type: special form

Arity: 0+

Args: (() . body)

Examples

> (swallow
	(error '(boom)))
;;=>
t
> (swallow 1 2 3)
;;=>
()

syntax-quote

Syntax-quote an expression

Type: special form

Arity: 1

Args: (x)

Examples

> (syntax-quote foo)
foo
> (syntax-quote (1 2 3 4))
(1 2 3 4)
> (syntax-quote (1 (unquote (+ 1 1)) (splicing-unquote (list 3 4))))
(1 2 3 4)
> `(1 ~(+ 1 1) ~@(list 3 4))
(1 2 3 4)

take

Take up to n items from the supplied list

Type: function

Arity: 2

Args: (n l)

Examples

> (take 3 (range 10))
;;=>
(0 1 2)

test

Run tests

Type: special form

Arity: 0+

Args: (() . body)

tosentence

Return l as a sentence... capitalized, with a period at the end

Type: function

Arity: 1

Args: (l)

Examples

> (tosentence (quote (to be, or not to be, that is the question)))
;;=>
(To be, or not to be, that is the question.)

true?

Return t if the argument is t

Type: function

Arity: 1

Args: (x)

Examples

> (true? 3)
;;=>
()
> (true? t)
;;=>
t

try

Try to evaluate body, catch errors and handle them

Type: special form

Arity: 0+

Args: (() . body)

Examples

> (try (error '(boom)))
;;=>
ERROR:
((boom))
> (try
    (error '(boom))
    (catch e
      (printl e)))
;;=>
(boom)
> (try (/ 1 0) (catch e (len e)))
2
>

upcase

Return the uppercase version of the given atom

Type: native function

Arity: 1

Args: (x)

Examples

> (upcase (quote abc))
;;=>
ABC

version

Return the version of the interpreter

Type: native function

Arity: 0

Args: ()

Examples

> (version)
;;=>
(0 0 57 dirty)

when

Simple conditional with single branch

Type: macro

Arity: 1+

Args: (condition . body)

Examples

> (when () (/ 1 0))
;;=>
()
> (when t (quote (the sun rises in the east)))
;;=>
(the sun rises in the east)

when-not

Complement of the when macro

Type: macro

Arity: 1+

Args: (condition . body)

Examples

> (when-not () (quote (do all the things)))
;;=>
(do all the things)
> (when-not t (error (quote (oh no mister bill))))
;;=>
()

while

Loop for as long as condition is true

Type: macro

Arity: 1+

Args: (condition . body)

Examples

> (while () (launch-missiles))
;;=>
()

with-screen

Prepare for and clean up after screen operations

Type: macro

Arity: 0+

Args: (() . body)

zero?

Return true iff the supplied argument is zero

Type: function

Arity: 1

Args: (n)

Examples

> (zero? (quote zero))
;;=>
()
> (zero? (- 1 1))
;;=>
t