ref: 68d73b20607c501fc3991db97145ec0c7c63e384
parent: 53a7a77b8461376e1067fd59aa5821c411a57fa5
author: Sigrid Solveig Haflínudóttir <sigrid@ftrv.se>
date: Sat Apr 26 00:02:05 EDT 2025
add more documentation of available system functions
--- a/boot/sl.boot
+++ b/boot/sl.boot
@@ -13,42 +13,56 @@
#fn("z0700}2:" #(aset!) 6) NIL NIL NIL NIL NIL NIL NIL NIL NIL NIL NIL #fn("n3012082>1|:" #(#fn("n1A061:" 6)) 7) NIL NIL NIL NIL NIL NIL NIL NIL #fn("z0700}2:" #(aref) 6) NIL NIL)*properties* #table(*formals-list* #table(identity ((x)) bound? ((symbol)) sym-set-doc ((symbol
- doc-seq . formals-list)) list? ((a)) io-eof? ((io)) < ((a . rest)) cadr ((cell)) sym (term) nan? ((v)) for ((min
- max fn)) fixnum? ((v)) exit (((status NIL))) > ((a . rest)) + (rest) div0 ((a b)) __finish ((status)) lz-unpack ((data
- :to destination)
- (data :size decompressed-bytes)) defstruct ((name docs… options… (slot-1 DEFAULT) slot-2 slot-3)
- (name (:type 'vec) (:named T) (:constructor T) (:conc-name
- T)
- (:predicate T) . slots)) compare ((x y)) buffer (NIL) num? ((v)) add-exit-hook ((fun)) rand-float (NIL) builtin? ((v)) set-car! ((cell
- new-first)) cons? ((v)) doc-group ((group-name doc)) 1+ ((n)) aref ((sequence subscript0 . rest)) zero? ((x)) vec (rest) >= ((a . rest)) sym? ((v)) void? ((x)) proper-list? ((a)) length= ((seq
+ doc-seq . formals-list)) odd? ((x)) list? ((a)) io-eof? ((io)) < ((a . rest)) cadr ((cell)) sym (term) nan? ((v)) for ((min
+ max fn)) fixnum? ((v)) exit (((status NIL))) assoc ((key lst)) > ((a . rest)) + (rest) div0 ((a
+ b)) __finish ((status)) lz-unpack ((data :to destination)
+ (data :size decompressed-bytes)) defstruct ((name docs…
+ options… (slot-1 DEFAULT) slot-2 slot-3)
+ (name (:type 'vec)
+ (:named T) (:constructor T) (:conc-name T) (:predicate T) . slots)) compare ((x y)) buffer (NIL) num? ((v)) add-exit-hook ((fun)) assoc-list (kvs) rand-float (NIL) assert ((expr)) builtin? ((v)) set-car! ((cell
+ new-first)) cons? ((v)) doc-group ((group-name doc)) 1+ ((n)) even? ((x)) aref ((sequence
+ subscript0 . rest)) zero? ((x)) vec (rest) >= ((a . rest)) sym? ((v)) void? ((x)) proper-list? ((a)) length= ((seq
n)) positive? ((x)) doc-for ((term . doc)) aset! ((sequence subscripts… new-value)) car ((lst)) <= ((a . rest)) str (term) cons ((first
- second)) - ((a . rest)) remprop ((symbol key)) negative? ((x)) rand (NIL) void (rest) file ((path
- (:read NIL) (:write NIL) (:create NIL) (:truncate NIL) (:append NIL))) rand-double (NIL) 1- ((n)) atom? ((value)) cdr ((lst)) vec? ((v)) / ((x . rest)) equal? ((a
- b)) eqv? ((a b)) io? ((term)) eof-object? ((term)) list (rest) apply ((fn arg . rest)) help ((term
- (kind NIL) (:print-header help-print-header))) rand-u32 (NIL) = ((a . rest)) rand-u64 (NIL) not ((v)) separate-doc-from-body ((body
+ second)) - ((a . rest)) remprop ((symbol key)) negative? ((x)) rand (NIL) void (rest) assert-fail ((expr . what)) file ((path
+ (:read NIL) (:write NIL) (:create NIL) (:truncate NIL) (:append NIL))) rand-double (NIL) assv ((key
+ lst)) 1- ((n)) atom? ((value)) cdr ((lst)) vec? ((v)) / ((x . rest)) equal? ((a b)) min ((x0 . xs)) eqv? ((a
+ b)) io? ((term)) eof-object? ((term)) list (rest) apply ((fn arg . rest)) help ((term (kind
+ NIL)
+ (:print-header help-print-header))) memv ((item lst)) max ((x0 . xs)) rand-u32 (NIL) = ((a . rest)) rand-u64 (NIL) not ((v)) separate-doc-from-body ((body
(doc NIL))) set-cdr! ((cell new-second)) fn? ((v)) help-print-header ((term sigs (:kind NIL)
(:lpad ""))) lz-pack ((data
- (level 0))) *prompt* (NIL) eq? ((a b)) getprop ((symbol key (def NIL))) vm-stats (NIL) * (rest) putprop ((symbol
- key val)) io->str ((io))) *doc* #table(identity "Return `x`." bound? "Return `T` if `symbol` has a value associated with it, `NIL` otherwise." sym-set-doc "Set the documentation for the symbol." list? "Return `T` if the value is either `NIL` or a cons cell, `NIL`\notherwise." io-eof? "Return `T` if `io` is currently in the \"end of file\" state, `NIL`\notherwise." (doc
- group io) "I/O functionality." < "Return `T` if the arguments are in strictly increasing order (next\none is greater than the previous one). With a single argument\nthe result is always `T`." cadr "Shorthand for `(car (cdr cell))`, that is, _first element of the\nsecond element_.\n\nExamples:\n\n (cadr '(1 2 3)) → 2\n (cadr '(1)) → NIL\n (cadr NIL) → NIL" sym "Return a symbol with the name being the concatenation of terms\nformatted as strings.\n\nThis is equivalent to `(sym (str terms…))`.\n\nExamples:\n\n (sym \"a\" 'b 1) → ab1" (doc
- group builtin) "Built-in operators." nan? "Return `T` if `v` is a floating point representation of NaN, either\nnegative or positive, `NIL` otherwise." NIL "An empty list. Can be used as the opposite of T in boolean\nexpressions.\n\nExamples:\n\n (not NIL) → T\n (if NIL 'yes 'no) → no\n (car NIL) → NIL\n (cdr NIL) → NIL" for "Call the function `fn` with a single integer argument, starting from\n`min` and ending with `max`.\n\nExamples:\n\n (for 0 2 (λ (i) (print (- 2 i)))) → 210" (doc
- group vm) "VM-related functions." exit "Terminate the process with the specified status. Does not return.\nThe status is expected to be a string in case of an error.\n\nExamples:\n\n (exit) ; exit with status 0 (nil on Plan 9)\n (exit \"error\") ; exit with status 1 (\"error\" on Plan 9)" fixnum? "Return `T` if `v` is of a fixnum type, `NIL` otherwise." > "Return `T` if the arguments are in strictly decreasing order (previous\none is greater than the next one)." + "Return sum of the arguments or `0` when none specified." div0 "Return the quotient of two numbers. For non-integers this is\nequivalent to `(div0 (floor a) (floor b))`. The result is always an\ninteger.\n\nExamples:\n\n (div0 7 2) → 3\n (div0 10 -2) → -5\n (div0 6.9 1.9) → 6" (doc
- group prop) "Dealing with symbols' properties." lz-unpack "Return decompressed data previously compressed using lz-pack.\n\nEither destination for the decompressed data or the expected size of\nthe decompressed data must be specified. In the latter case a new\narray is allocated." __finish "A function called right before exit by the VM." defstruct "Defines a structure type with a specific name and slots.\n\nThe default underlying type is a \"named\" vector (`:type vec`), where\nthe first element is the name of the structure's type, the rest are\nthe keyworded slot values. A list with slot values alone can be used\ninstead by adding `:type list` option. The list will not contain the\nname of the struct by default, which can be enabled with `:named T`\noption.\n\nAs an example, the following declaration\n\n (defstruct blah \"Return stuff.\" :doc-group stuff a b (c 1 :read-only T))\n\nGenerates the default constructor for a structure of three slots, with\nthe third (`c`) having a specific default value and being read-only.\n\n (make-blah (:a NIL) (:b NIL) (:c 1))\n (blah-a s)\n (blah-b s)\n (blah-c s)\n\nSlot's options, if any, should be specified after its default value.\nSupported options are:\n\n ; mark the slot as read-only\n ; its value can be read, but trying to modify it will throw an error\n … :read-only T\n\nThe constructor can be changed in several ways:\n\n ; disable the constructor altogether\n (defstruct blah :constructor NIL a b c)\n ; only change its name\n (defstruct blah :constructor blargh a b c)\n ; rename AND avoid using keywords\n (defstruct blah :constructor (blah a b c) a b c)\n\nThe option `:conc-name` specifies the slot accessor prefix, which\ndefaults to `structname-`. Prefix can be disabled entirely with\n`:conc-name NIL`.\n\nDefault predicate can be disabled or its name, which defaults to\n`structname?`, changed:\n\n ; use \"blargh?\" instead of \"blah?\"\n (defstruct blah :predicate blargh? a b c)\n ; without predicate\n (defstruct blah :predicate NIL a b c)" (doc
- group rand) "Random numbers generation." (doc group compare) "Comparison operators." compare "Return -1 if `x` is less than `y`, 0 if equal, and `1` if `y` is\ngreater than `x`.\n\nExamples:\n\n (compare 'a 'b) → -1\n (compare 1 1) → 0\n (compare \"b\" \"a\") → 1" buffer "Return an in-memory buffer for I/O, of `io` type.\n\nA buffer can be used for both reading and writing at the same\ntime." num? "Return `T` if `v` is of a numerical type, `NIL` otherwise.\n\nNumerical types include floating point, fixnum, bignum, etc.\nNote: ironically, a NaN value is considered a number by this function\nsince it's only testing the _type_ of the value." add-exit-hook "Puts an one-argument function on top of the list of exit hooks.\n\nOn shutdown each exit hook is called with the exit status as a single\nargument, which is (usually) `NIL` on success and a string describing\nan error otherwise." rand-float "Return a random float on [0.0, 1.0] interval." builtin? "Return `T` if `v` is a built-in function implemented in C, `NIL`\notherwise.\n\nExamples:\n\n (builtin? map) → T\n (builtin? macroexpand) → NIL" set-car! "Modify a cons cell (a list) in-place by putting `new-first` as its\nfirst element (head of the list). Return the modified cons\ncell (list).\n\nExamples:\n\n (def q '(1 2 3 4 5))\n (set-car! q 0) → (0 6 7)\n q → (0 6 7)" doc-group "Define documentation for a group." cons? "Return `T` if `v` is a cons cell, `NIL` otherwise.\n\nExamples:\n\n (cons? 0) → NIL\n (cons? NIL) → NIL\n (cons? '(1)) → T" 1+ "Equivalent to `(+ n 1)`." aref "Return the sequence element specified by the subscripts. The sequence\ncan be an array, vector, a list. Multi-dimensional sequences\nof variating types are also supported.\n\nExamples:\n\n (def a '((1 #(2 (3)) 4)))\n (aref a 0) → (1 (2 (3)) 4)\n (aref a 1) → index 1 out of bounds\n (aref a 0 0) → 1\n (aref a 0 1 0) → 2\n (aref a 0 2) → 4" *properties* "All properties of symbols recorded with `putprop` are recorded in this\ntable." vec "Return a vector constructed of the arguments.\n\nExamples:\n\n (vec) → #() ; empty vector\n (vec 1 2.5 \"a\" 'b) → #(1 2.5 \"a\" b)" >= "Return `T` if the arguments are in non-increasing order (previous\none is greater than or equal to the next one)." sym? "Return `T` if `v` is a symbol, `NIL` otherwise." void? "Return `T` if `x` is `#<void>`, `NIL` otherwise." zero? "Return `T` if `x` is zero." proper-list? "Return `T` is the value is a proper list. That is, a non-circular\nlist with the last element being `NIL`, as opposed to a dotted list.\n\nExamples:\n\n (proper-list? NIL) → T\n (proper-list? '(1)) → T\n (proper-list? '(1 . 2) → NIL\n (def l '(1))\n (set-cdr! l l) → #0=(1 . #0#)\n (length l) → +inf.0\n (proper-list? l) → NIL" length= "Perform a bounded length test.\n\nUse this instead of `(= (length seq) n)`, since it avoids unnecessary\nwork and always terminates." positive? "Return `T` if `x` is greater than zero." doc-for "Define documentation for a top level term.\n\nIf `term` is a function signature and `doc` is not specified, just\nthe signature will be included in the documentation, without\nreplacing any previously defined.\n\nFirst `doc` argument is supposed to be a string with the description\nof the term. The following arguments are expected to be optional tag\npairings that provide grouping for multiple symbols and \"see also\"\nreferences.\n\nUseful in cases where setting the documentation for a term can't\n(or not preferred to) be made during the definition of said term.\nOne of those reasons is that the term is a built-in function\nimplemented in C.\n\nExamples:\n\n (doc-for (func arg (arg2 0))\n \"Return something about the `arg` and `arg2`. This is a short\n description.\n\n This is the longer description, following the short one.\n\n Examples:\n\n (func 0) → T\n
\ No newline at end of file
- group list) "Working with lists." Instructions "VM instructions mapped to their encoded byte representation." file "Open a file for I/O.\n\nAn `io` object is returned. Without any modes specified the file\nis opened in read-only mode." rand-double "Return a random double on interval [0.0, 1.0]." 1- "Equivalent to `(- n 1)`." cdr "Return the second element of a cons cell (tail of a list) or `NIL` if\nnot available.\n\nExamples:\n\n (cdr NIL) → NIL\n (cdr '(1 2 3)) → (2 3)\n (cdr '(1 . 2)) → 2" (doc
- group string) "String-related functionality." atom? "Return `T` if `v` is a _not_ a cons cell, `NIL` otherwise. This is\nthe opposite of `cons?`.\n\nThe term \"atom\" comes from the idea of being indivisible.\n\nExamples:\n\n (atom? \"a\") → T\n (atom? NIL) → T\n (atom? '(1)) → NIL" vec? "Return `T` if `v` is a vector, `NIL` otherwise." equal? "Return `T` if both `a` and `b` are of the same value. For non-leaf\ntypes (cons cell and vector), the equality test is performed\nthroughout the whole structure of the values.\n\nExamples:\n\n (equal? 0.0 0) → NIL\n (equal? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (equal? a b) → T\n (def a '(1))\n (def b '(1))\n (equal? a b) → T" / "Return the division of the arguments. With only one argument the\nresult of `1/x` is returned. If the result is integer-valued, it is\nreturned as an integer.\n\nExamples:\n\n (/ 2) → 0.5\n (/ 7 2 2) → 1.75\n (/ 10 -2) → -5 ; a fixnum\n (/ 6.9 1.9) → 3.6315…" eqv? "Return `T` if both `a` and `b` are of the same value and primitive\n(leaf) type, `NIL` otherwise. Neither cons cell nor vector are not\nconsidered primitive types as they may define deep structures.\n\nExamples:\n\n (eqv? 0.0 0) → NIL\n (eqv? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eqv? a b) → T\n (def a '(1))\n (def b '(1))\n (eqv? a b) → NIL" io? "Return `T` if `term` is of `io` type, `NIL` otherwise." eof-object? "Return `T` if `term` is `#<eof>`, `NIL` otherwise.\n\nThis object is returned by I/O functions to signal end of file,\nwhere applicable." list "Return a list constructed of the arguments.\n\nExamples:\n\n (list) → NIL ; empty list\n (list 1 2.5 \"a\" 'b) → (1 2.5 \"a\" b)" apply "Return the result of applying a function to a list of arguments.\n\nThe last argument must always be a list which gets spliced as\narguments to the function.\n\nExamples:\n\n (apply + 1 2 '(3 4 5)) → 15\n (apply vec '(1 2 3)) → #(3 4 5)\n (apply arr 'u8 '(3 4 5)) → #vu8(3 4 5)" help "Display documentation the specified term, if available.\n\nThe optional parameter `kind` can be set to `group` to show\ndocumentation for the specified group instead of a single term.\nAll available documentation groups can be displayed with `(help\ngroups)`." (doc
- group doc) "Writing and reading documentation." rand-u32 "Return a random integer on interval [0, 2³²-1]." = "Numerical equality test. Return `T` if all numbers are equal,\n`NIL` otherwise." rand-u64 "Return a random integer on interval [0, 2⁶⁴-1]." (doc
- group sys) "OS-specific functions." not "Return `T` if `v` is `NIL`, `T` otherwise." set-cdr! "Modify a cons cell (a list) in-place by putting `new-second` as its\nsecond element (tail of the list). Return the modified cons\ncell (list).\n\nExamples:\n\n (def q '(1 2 3 4 5))\n (set-cdr! q '(6 7)) → (1 6 7)\n q → (1 6 7)" separate-doc-from-body "Take a list of terms and return a pair `(doc . body)`, where the first\nelement contains a list of documentation-related terms, and the second\ncontains the rest of the terms." fn? "Return `T` if `v` is a function, `NIL` otherwise.\n\nExamples:\n\n (fn? map) → T\n (fn? macroexpand) → T" help-print-header "Format and print signature(s) of the term for `(help term)` output." lz-pack "Return data compressed using Lempel-Ziv.\n\nThe data must be an array, returned value will have the same type.\nThe optional `level` is between `0` and `10`. With `level` set to\n`0` a simple LZSS using hashing will be performed. Levels between\n`1` and `9` offer a trade-off between time/space and ratio. Level\n`10` is optimal but very slow." arg-counts "VM instructions mapped to their expected arguments count." *prompt* "Function called by REPL to signal the user input is required.\n\nDefault function prints `#;> `." eq? "Return `T` if `a` and `b` are the same object, `NIL` otherwise.\n\nExamples:\n\n (eq? 0.0 0) → NIL\n (eq? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eq? a b) → NIL\n (def a '(1))\n (def b '(1))\n (eq? a b) → NIL" getprop "Return a property value associated with the symbol or `def` if\nmissing." vm-stats "Print various VM-related information, such as the number of GC\ncalls so far, heap and stack size, etc." (doc
- group compress) "Compression." * "Return product of the arguments or `1` when none specified." putprop "Associate a property value with the symbol." io->str "Return an in-memory `io` buffer converted to a string.") *doc-extra* #table(bound? ((:doc-group . builtin)) sym-set-doc ((:doc-group . doc)) io-eof? ((:doc-group . io)) < ((:doc-group . compare)
- (:doc-group . builtin)) cadr ((:doc-group . list) (:doc-group . builtin)) nan? ((:doc-group . builtin)) NIL ((:doc-see . T)) for ((:doc-group . builtin)) fixnum? ((:doc-group . builtin)) exit ((:doc-group . sys)) > ((:doc-group . compare)) + ((:doc-group . builtin)) div0 ((:doc-group . builtin)) lz-unpack ((:doc-group . compress)) compare ((:doc-group . builtin)) buffer ((:doc-group . io)) num? ((:doc-group . builtin)) rand-float ((:doc-group . rand)) builtin? ((:doc-group . builtin)) set-car! ((:doc-group . list)
- (:doc-group . builtin)) cons? ((:doc-group . builtin)) doc-group ((:doc-group . doc)) aref ((:doc-group . builtin)) *properties* ((:doc-group . prop)) vec ((:doc-group . builtin)) >= ((:doc-group . compare)) sym? ((:doc-group . builtin)) zero? ((:doc-group . compare)) length= ((:doc-group . list)) positive? ((:doc-group . compare)) doc-for ((:doc-group . doc)) aset! ((:doc-group . builtin)) T ((:doc-see)) car ((:doc-group . list)
+ (level 0))) *prompt* (NIL) member ((item lst)) eq? ((a b)) getprop ((symbol key (def NIL))) vm-stats (NIL) * (rest) putprop ((symbol
+ key val)) io->str ((io))) *doc* #table(sym-set-doc "Set the documentation for the symbol." io-eof? "Return `T` if `io` is currently in the \"end of file\" state, `NIL`\notherwise." cadr "Shorthand for `(car (cdr cell))`, that is, _first element of the\nsecond element_.\n\nExamples:\n\n (cadr '(1 2 3)) → 2\n (cadr '(1)) → NIL\n (cadr NIL) → NIL" nan? "Return `T` if `v` is a floating point representation of NaN, either\nnegative or positive, `NIL` otherwise." fixnum? "Return `T` if `v` is of a fixnum type, `NIL` otherwise." exit "Terminate the process with the specified status. Does not return.\nThe status is expected to be a string in case of an error.\n\nExamples:\n\n (exit) ; exit with status 0 (nil on Plan 9)\n (exit \"error\") ; exit with status 1 (\"error\" on Plan 9)" __finish "A function called right before exit by the VM." div0 "Return the quotient of two numbers. For non-integers this is\nequivalent to `(div0 (floor a) (floor b))`. The result is always an\ninteger.\n\nExamples:\n\n (div0 7 2) → 3\n (div0 10 -2) → -5\n (div0 6.9 1.9) → 6" (doc
+ group prop) "Dealing with symbols' properties." lz-unpack "Return decompressed data previously compressed using lz-pack.\n\nEither destination for the decompressed data or the expected size of\nthe decompressed data must be specified. In the latter case a new\narray is allocated." defstruct "Defines a structure type with a specific name and slots.\n\nThe default underlying type is a \"named\" vector (`:type vec`), where\nthe first element is the name of the structure's type, the rest are\nthe keyworded slot values. A list with slot values alone can be used\ninstead by adding `:type list` option. The list will not contain the\nname of the struct by default, which can be enabled with `:named T`\noption.\n\nAs an example, the following declaration\n\n (defstruct blah \"Return stuff.\" :doc-group stuff a b (c 1 :read-only T))\n\nGenerates the default constructor for a structure of three slots, with\nthe third (`c`) having a specific default value and being read-only.\n\n (make-blah (:a NIL) (:b NIL) (:c 1))\n (blah-a s)\n (blah-b s)\n (blah-c s)\n\nSlot's options, if any, should be specified after its default value.\nSupported options are:\n\n ; mark the slot as read-only\n ; its value can be read, but trying to modify it will throw an error\n … :read-only T\n\nThe constructor can be changed in several ways:\n\n ; disable the constructor altogether\n (defstruct blah :constructor NIL a b c)\n ; only change its name\n (defstruct blah :constructor blargh a b c)\n ; rename AND avoid using keywords\n (defstruct blah :constructor (blah a b c) a b c)\n\nThe option `:conc-name` specifies the slot accessor prefix, which\ndefaults to `structname-`. Prefix can be disabled entirely with\n`:conc-name NIL`.\n\nDefault predicate can be disabled or its name, which defaults to\n`structname?`, changed:\n\n ; use \"blargh?\" instead of \"blah?\"\n (defstruct blah :predicate blargh? a b c)\n ; without predicate\n (defstruct blah :predicate NIL a b c)" (doc
+ group compare) "Comparison operators." buffer "Return an in-memory buffer for I/O, of `io` type.\n\nA buffer can be used for both reading and writing at the same\ntime." num? "Return `T` if `v` is of a numerical type, `NIL` otherwise.\n\nNumerical types include floating point, fixnum, bignum, etc.\nNote: ironically, a NaN value is considered a number by this function\nsince it's only testing the _type_ of the value." assoc-list "Return an association list built of the arguments.\n\nEvery two arguments are expected to be a key and a value associated\nwith that key.\n\nExamples:\n\n (assoc-list 'a 0 'b 1) → ((a . 0) (b . 1))" assert "Throw an exception if `expr` evaluates to `NIL`. Return `T` in any\nother case.\n\nExamples:\n\n (def s \"abc\")\n (assert (= (length s) 3)) → T\n (assert (eq? (str-rune s 0) #\\x)) → assertion failed: ..." builtin? "Return `T` if `v` is a built-in function implemented in C, `NIL`\notherwise.\n\nExamples:\n\n (builtin? map) → T\n (builtin? macroexpand) → NIL" set-car! "Modify a cons cell (a list) in-place by putting `new-first` as its\nfirst element (head of the list). Return the modified cons\ncell (list).\n\nExamples:\n\n (def q '(1 2 3 4 5))\n (set-car! q 0) → (0 6 7)\n q → (0 6 7)" (doc
+ group debug) "Debugging utilities." 1+ "Equivalent to `(+ n 1)`." vec "Return a vector constructed of the arguments.\n\nExamples:\n\n (vec) → #() ; empty vector\n (vec 1 2.5 \"a\" 'b) → #(1 2.5 \"a\" b)" positive? "Return `T` if `x` is greater than zero." *builtins* "VM instructions as closures." str "Return concatenation of terms formatted as strings.\n\nThis is equivalent to `(princ terms…)`, except the string is\nreturned, rather than printed.\n\nExamples:\n\n (str \"a\" 'b 1 #(0)) → \"ab1#(0)\"" remprop "Remove a property value associated with the symbol." negative? "Return `T` if `x` is negative." void "Return the constant `#<void>` while ignoring any arguments.\n\n`#<void>` is mainly used when a function has side effects but does not\nproduce any meaningful value to return, so even though `T` or `NIL` could\nbe returned instead, in case of `#<void>` alone, REPL will not print\nit." assert-fail "Throw an \"assertion failed\" exception if evaluating `expr` itself does\nnot result in an exception thrown. Return `T` otherwise.\n\nTo test for a specific exception type, an optional `what` argument can\nbe used.\n\nExamples:\n\n (def s \"abc\")\n (assert-fail (= (length s) 3)) → assertion failed: ...\n (assert-fail (= s 1) type-error) → T" (doc
+ group list) "Working with lists." file "Open a file for I/O.\n\nAn `io` object is returned. Without any modes specified the file\nis opened in read-only mode." rand-double "Return a random double on interval [0.0, 1.0]." 1- "Equivalent to `(- n 1)`." cdr "Return the second element of a cons cell (tail of a list) or `NIL` if\nnot available.\n\nExamples:\n\n (cdr NIL) → NIL\n (cdr '(1 2 3)) → (2 3)\n (cdr '(1 . 2)) → 2" atom? "Return `T` if `v` is a _not_ a cons cell, `NIL` otherwise. This is\nthe opposite of `cons?`.\n\nThe term \"atom\" comes from the idea of being indivisible.\n\nExamples:\n\n (atom? \"a\") → T\n (atom? NIL) → T\n (atom? '(1)) → NIL" / "Return the division of the arguments. With only one argument the\nresult of `1/x` is returned. If the result is integer-valued, it is\nreturned as an integer.\n\nExamples:\n\n (/ 2) → 0.5\n (/ 7 2 2) → 1.75\n (/ 10 -2) → -5 ; a fixnum\n (/ 6.9 1.9) → 3.6315…" equal? "Return `T` if both `a` and `b` are of the same value. For non-leaf\ntypes (cons cell and vector), the equality test is performed\nthroughout the whole structure of the values.\n\nExamples:\n\n (equal? 0.0 0) → NIL\n (equal? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (equal? a b) → T\n (def a '(1))\n (def b '(1))\n (equal? a b) → T" apply "Return the result of applying a function to a list of arguments.\n\nThe last argument must always be a list which gets spliced as\narguments to the function.\n\nExamples:\n\n (apply + 1 2 '(3 4 5)) → 15\n (apply vec '(1 2 3)) → #(3 4 5)\n (apply arr 'u8 '(3 4 5)) → #vu8(3 4 5)" separate-doc-from-body "Take a list of terms and return a pair `(doc . body)`, where the first\nelement contains a list of documentation-related terms, and the second\ncontains the rest of the terms." = "Numerical equality test. Return `T` if all numbers are equal,\n`NIL` otherwise." rand-u64 "Return a random integer on interval [0, 2⁶⁴-1]." (doc
+ group sys) "OS-specific functions." not "Return `T` if `v` is `NIL`, `T` otherwise." set-cdr! "Modify a cons cell (a list) in-place by putting `new-second` as its\nsecond element (tail of the list). Return the modified cons\ncell (list).\n\nExamples:\n\n (def q '(1 2 3 4 5))\n (set-cdr! q '(6 7)) → (1 6 7)\n q → (1 6 7)" fn? "Return `T` if `v` is a function, `NIL` otherwise.\n\nExamples:\n\n (fn? map) → T\n (fn? macroexpand) → T" lz-pack "Return data compressed using Lempel-Ziv.\n\nThe data must be an array, returned value will have the same type.\nThe optional `level` is between `0` and `10`. With `level` set to\n`0` a simple LZSS using hashing will be performed. Levels between\n`1` and `9` offer a trade-off between time/space and ratio. Level\n`10` is optimal but very slow." *prompt* "Function called by REPL to signal the user input is required.\n\nDefault function prints `#;> `." member "Return the tail of a list beginning with the item, or `NIL` otherwise.\nList elements are compared to the `item` using `equal?`.\n\nExamples:\n\n (member 1 '(3 2 1 0)) → (1 0)\n (member 1 '(2 3)) → NIL" eq? "Return `T` if `a` and `b` are the same object, `NIL` otherwise.\n\nExamples:\n\n (eq? 0.0 0) → NIL\n (eq? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eq? a b) → NIL\n (def a '(1))\n (def b '(1))\n (eq? a b) → NIL" getprop "Return a property value associated with the symbol or `def` if\nmissing." vm-stats "Print various VM-related information, such as the number of GC\ncalls so far, heap and stack size, etc." * "Return product of the arguments or `1` when none specified." putprop "Associate a property value with the symbol." io->str "Return an in-memory `io` buffer converted to a string." bound? "Return `T` if `symbol` has a value associated with it, `NIL` otherwise." odd? "Return `T` if `x` is an odd integer, `NIL` otherwise." list? "Return `T` if the value is either `NIL` or a cons cell, `NIL`\notherwise." (doc
+ group io) "I/O functionality." < "Return `T` if the arguments are in strictly increasing order (next\none is greater than the previous one). With a single argument\nthe result is always `T`." sym "Return a symbol with the name being the concatenation of terms\nformatted as strings.\n\nThis is equivalent to `(sym (str terms…))`.\n\nExamples:\n\n (sym \"a\" 'b 1) → ab1" (doc
+ group builtin) "Built-in operators." NIL "An empty list. Can be used as the opposite of T in boolean\nexpressions.\n\nExamples:\n\n (not NIL) → T\n (if NIL 'yes 'no) → no\n (car NIL) → NIL\n (cdr NIL) → NIL" for "Call the function `fn` with a single integer argument, starting from\n`min` and ending with `max`.\n\nExamples:\n\n (for 0 2 (λ (i) (print (- 2 i)))) → 210" (doc
+ group vm) "VM-related functions." assoc "Return a pair of a matching key and the associated value, or `NIL` if\nnone matched. Keys are compared using `equal?`.\n\nExamples:\n\n (def L (assoc-list 'a 0 'b 1))\n (assoc 'b L) → (b . 1)\n (assoc 'c L) → NIL" > "Return `T` if the arguments are in strictly decreasing order (previous\none is greater than the next one)." + "Return sum of the arguments or `0` when none specified." (doc
+ group rand) "Random numbers generation." compare "Return -1 if `x` is less than `y`, 0 if equal, and `1` if `y` is\ngreater than `x`.\n\nExamples:\n\n (compare 'a 'b) → -1\n (compare 1 1) → 0\n (compare \"b\" \"a\") → 1" add-exit-hook "Puts an one-argument function on top of the list of exit hooks.\n\nOn shutdown each exit hook is called with the exit status as a single\nargument, which is (usually) `NIL` on success and a string describing\nan error otherwise." rand-float "Return a random float on [0.0, 1.0] interval." doc-group "Define documentation for a group." cons? "Return `T` if `v` is a cons cell, `NIL` otherwise.\n\nExamples:\n\n (cons? 0) → NIL\n (cons? NIL) → NIL\n (cons? '(1)) → T" even? "Return `T` if `x` is an even integer, `NIL` otherwise." aref "Return the sequence element specified by the subscripts. The sequence\ncan be an array, vector, a list. Multi-dimensional sequences\nof variating types are also supported.\n\nExamples:\n\n (def a '((1 #(2 (3)) 4)))\n (aref a 0) → (1 (2 (3)) 4)\n (aref a 1) → index 1 out of bounds\n (aref a 0 0) → 1\n (aref a 0 1 0) → 2\n (aref a 0 2) → 4" *properties* "All properties of symbols recorded with `putprop` are recorded in this\ntable." zero? "Return `T` if `x` is zero." >= "Return `T` if the arguments are in non-increasing order (previous\none is greater than or equal to the next one)." sym? "Return `T` if `v` is a symbol, `NIL` otherwise." void? "Return `T` if `x` is `#<void>`, `NIL` otherwise." proper-list? "Return `T` is the value is a proper list. That is, a non-circular\nlist with the last element being `NIL`, as opposed to a dotted list.\n\nExamples:\n\n (proper-list? NIL) → T\n (proper-list? '(1)) → T\n (proper-list? '(1 . 2) → NIL\n (def l '(1))\n (set-cdr! l l) → #0=(1 . #0#)\n (length l) → +inf.0\n (proper-list? l) → NIL" length= "Perform a bounded length test.\n\nUse this instead of `(= (length seq) n)`, since it avoids unnecessary\nwork and always terminates." doc-for "Define documentation for a top level term.\n\nIf `term` is a function signature and `doc` is not specified, just\nthe signature will be included in the documentation, without\nreplacing any previously defined.\n\nFirst `doc` argument is supposed to be a string with the description\nof the term. The following arguments are expected to be optional tag\npairings that provide grouping for multiple symbols and \"see also\"\nreferences.\n\nUseful in cases where setting the documentation for a term can't\n(or not preferred to) be made during the definition of said term.\nOne of those reasons is that the term is a built-in function\nimplemented in C.\n\nExamples:\n\n (doc-for (func arg (arg2 0))\n \"Return something about the `arg` and `arg2`. This is a short\n description.\n\n This is the longer description, following the short one.\n\n Examples:\n\n (func 0) → T\n (func 1 3) → NIL\"\n :doc-group stuff\n :doc-see func2)\n (doc-for (func arg (:another-variant NIL)))" aset! "Modify the sequence element specified by the subscripts and return the\nnew value. The sequence can be an array, vector, a list.\nMulti-dimensional sequences of variating types are also supported.\n\nExamples:\n\n (def a '((1 #(2 (3)) 4)))\n (aset! a 1 'x) → index 1 out of bounds\n (aset! a 0 0 'x) → x\n a → ((x #(2 (3)) 4))\n (aset! a 0 1 9) → 9\n a → ((x #(9 (3)) 4))" T "A boolean \"true\".\n\nExamples:\n\n (not T) → NIL\n (if T 'yes 'no) → yes" car "Return the first element of a cons cell (head of a list) or `NIL` if\nnot available.\n\nExamples:\n\n (car NIL) → NIL\n (car '(1 2 3)) → 1\n (car '(1 . 2)) → 1" <= "Return `T` if the arguments are in non-decreasing order (previous\none is less than or equal to the next one)." cons "Return a cons cell containing two arguments.\n\nExamples:\n\
\ No newline at end of file
+ group string) "String-related functionality." vec? "Return `T` if `v` is a vector, `NIL` otherwise." min "Return the smallest among the arguments.\n\nExamples:\n\n (min 3 1 9 4) → 1\n (min 'c 'h 'z 'a) → a\n (min \"t\" \"g\" \"a\") → \"a\"" eqv? "Return `T` if both `a` and `b` are of the same value and primitive\n(leaf) type, `NIL` otherwise. Neither cons cell nor vector are not\nconsidered primitive types as they may define deep structures.\n\nExamples:\n\n (eqv? 0.0 0) → NIL\n (eqv? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eqv? a b) → T\n (def a '(1))\n (def b '(1))\n (eqv? a b) → NIL" io? "Return `T` if `term` is of `io` type, `NIL` otherwise." eof-object? "Return `T` if `term` is `#<eof>`, `NIL` otherwise.\n\nThis object is returned by I/O functions to signal end of file,\nwhere applicable." list "Return a list constructed of the arguments.\n\nExamples:\n\n (list) → NIL ; empty list\n (list 1 2.5 \"a\" 'b) → (1 2.5 \"a\" b)" help "Display documentation the specified term, if available.\n\nThe optional parameter `kind` can be set to `group` to show\ndocumentation for the specified group instead of a single term.\nAll available documentation groups can be displayed with `(help\ngroups)`." memv "Return the tail of a list beginning with the item, or `NIL` otherwise.\nList elements are compared to the `item` using `eqv?`." (doc
+ group doc) "Writing and reading documentation." max "Return the largest among the arguments.\n\nExamples:\n\n (max 3 1 9 4) → 9\n (max 'c 'h 'z 'a) → z\n (max \"t\" \"g\" \"a\") → \"t\"" rand-u32 "Return a random integer on interval [0, 2³²-1]." help-print-header "Format and print signature(s) of the term for `(help term)` output." arg-counts "VM instructions mapped to their expected arguments count." (doc
+ group compress) "Compression." identity "Return `x`.") *doc-extra* #table(bound? ((:doc-group . builtin)) sym-set-doc ((:doc-group . doc)) odd? ((:doc-group . compare)
+ (:doc-see . even?)) list? ((:doc-group . list) (:doc-see . proper-list?)) io-eof? ((:doc-group . io)) < ((:doc-group . compare)
+ (:doc-group . builtin)) cadr ((:doc-group . list) (:doc-group . builtin)) nan? ((:doc-group . builtin)) NIL ((:doc-see . T)) for ((:doc-group . builtin)) fixnum? ((:doc-group . builtin)) exit ((:doc-group . sys)) assoc ((:doc-group . list)
+ (:doc-see . assv)) > ((:doc-group . compare)) + ((:doc-group . builtin)) div0 ((:doc-group . builtin)) lz-unpack ((:doc-group . compress)) compare ((:doc-group . builtin)) buffer ((:doc-group . io)) num? ((:doc-group . builtin)) assert ((:doc-group . debug)
+ (:doc-see . assert-fail)) rand-float ((:doc-group . rand)) builtin? ((:doc-group . builtin)) set-car! ((:doc-group . list)
+ (:doc-group . builtin)) cons? ((:doc-group . builtin)) doc-group ((:doc-group . doc)) even? ((:doc-group . compare)
+ (:doc-see . odd?)) aref ((:doc-group . builtin)) *properties* ((:doc-group . prop)) vec ((:doc-group . builtin)) >= ((:doc-group . compare)) sym? ((:doc-group . builtin)) zero? ((:doc-group . compare)) proper-list? ((:doc-group . list)
+ (:doc-see . list?)) length= ((:doc-group . list) (:doc-see . length>)) positive? ((:doc-group . compare)) doc-for ((:doc-group . doc)) aset! ((:doc-group . builtin)) T ((:doc-see)) car ((:doc-group . list)
een time/space and ratio. Level\n`10` is optimal but very slow." arg-counts "VM instructions mapped to their expected arguments count." *prompt* "Function called by REPL to signal the user input is required.\n\nDefault function prints `#;> `." eq? "Return `T` if `a` and `b` are the same object, `NIL` otherwise.\n\nExamples:\n\n (eq? 0.0 0) → NIL\n (eq? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eq? a b) → NIL\n (def a '(1))\n (def b '(1))\n (eq? a b) → NIL" getprop "Return a property value associated with the symbol or `def` if\nmissing." vm-stats "Print various VM-related information, such as the number of GC\ncalls so far, heap and stack size, etc." (doc
- arguments count." *prompt* "Function called by REPL to signal the user input is required.\n\nDefault function prints `#;> `." eq? "Return `T` if `a` and `b` are the same object, `NIL` otherwise.\n\nExamples:\n\n (eq? 0.0 0) → NIL\n (eq? 0 0) → T\n (def a \"1\")\n (def b \"1\")\n (eq? a b) → NIL\n (def a '(1))\n (def b '(1))\n (eq? a b) → NIL" getprop "Return a property value associated with the symbol or `def` if\nmissing." vm-stats "Print various VM-related information, such as the number of GC\ncalls so far, heap and stack size, etc." (doc
- group compress) "Compression." * "Return product of the arguments or `1` when none specified." putprop "Associate a property value with the symbol." io->str "Return an in-memory `io` buffer converted to a string.") *doc-extra* #table(bound? ((:doc-group . builtin)) sym-set-doc ((:doc-group . doc)) io-eof? ((:doc-group . io)) < ((:doc-group . compare)
- (:doc-group . builtin)) cadr ((:doc-group . list) (:doc-group . builtin)) nan? ((:doc-group . builtin)) NIL ((:doc-see . T)) for ((:doc-group . builtin)) fixnum? ((:doc-group . builtin)) exit ((:doc-group . sys)) > ((:doc-group . compare)) + ((:doc-group . builtin)) div0 ((:doc-group . builtin)) lz-unpack ((:doc-group . compress)) compare ((:doc-group . builtin)) buffer ((:doc-group . io)) num? ((:doc-group . builtin)) rand-float ((:doc-group . rand)) builtin? ((:doc-group . builtin)) set-car! ((:doc-group . list)
+dd?)) aref ((:doc-group . builtin)) *properties* ((:doc-group . prop)) vec ((:doc-group . builtin)) >= ((:doc-group . compare)) sym? ((:doc-group . builtin)) zero? ((:doc-group . compare)) proper-list? ((:doc-group . list)
+ (:doc-see . list?)) length= ((:doc-group . list) (:doc-see . length>)) positive? ((:doc-group . compare)) doc-for ((:doc-group . doc)) aset! ((:doc-group . builtin)) T ((:doc-see)) car ((:doc-group . list)
+ (:doc-group . builtin)) *builtins* ((:doc-group . builtin)) str ((:doc-group . string)) cons ((:doc-group . list)
+ (:doc-group . builtin)) - ((:doc-group . builtin)) remprop ((:doc-group . prop)) <= ((:doc-group . compare)) rand ((:doc-group . rand)) negative? ((:doc-group . compare)) assert-fail ((:doc-group . debug)
+ (:doc-see . assert)) Instructions ((:doc-group . builtin)) file ((:doc-group . io)) rand-double ((:doc-group . rand)) assv ((:doc-group . list)
+ (:doc-see . assoc)) cdr ((:doc-group . list) (:doc-group . builtin)) atom? ((:doc-group . builtin)) vec? ((:doc-group . builtin)) / ((:doc-group . builtin)) equal? ((:doc-group . compare)
ol." io->str "Return an in-memory `io` buffer converted to a string.") *doc-extra* #table(bound? ((:doc-group . builtin)) sym-set-doc ((:doc-group . doc)) io-eof? ((:doc-group . io)) < ((:doc-group . compare)
-f? ((:doc-group . io)) < ((:doc-group . compare)
- (:doc-group . builtin)) cadr ((:doc-group . list) (:doc-group . builtin)) nan? ((:doc-group . builtin)) NIL ((:doc-see . T)) for ((:doc-group . builtin)) fixnum? ((:doc-group . builtin)) exit ((:doc-group . sys)) > ((:doc-group . compare)) + ((:doc-group . builtin)) div0 ((:doc-group . builtin)) lz-unpack ((:doc-group . compress)) compare ((:doc-group . builtin)) buffer ((:doc-group . io)) num? ((:doc-group . builtin)) rand-float ((:doc-group . rand)) builtin? ((:doc-group . builtin)) set-car! ((:doc-group . list)
+ (:doc-group . builtin)) io? ((:doc-group . io)) eof-object? ((:doc-group . io)) list ((:doc-group . builtin)) apply ((:doc-group . builtin)) help ((:doc-group . doc)) memv ((:doc-group . list)
+ (:doc-see . member)) max ((:doc-group . compare) (:doc-see . min)) rand-u32 ((:doc-group . rand)) = ((:doc-group . compare)
+ (:doc-group . builtin)) rand-u64 ((:doc-group . rand)) not ((:doc-group . builtin)) separate-doc-from-body ((:doc-group . doc)) set-cdr! ((:doc-group . list)
npack ((:doc-group . compress)) compare ((:doc-group . builtin)) buffer ((:doc-group . io)) num? ((:doc-group . builtin)) rand-float ((:doc-group . rand)) builtin? ((:doc-group . builtin)) set-car! ((:doc-group . list)
(:doc-group . builtin)) cons? ((:doc-group . builtin)) doc-group ((:doc-group . doc)) aref ((:doc-group . builtin)) *properties* ((:doc-group . prop)) vec ((:doc-group . builtin)) >= ((:doc-group . compare)) sym? ((:doc-group . builtin)) zero? ((:doc-group . compare)) length= ((:doc-group . list)) positive? ((:doc-group . compare)) doc-for ((:doc-group . doc)) aset! ((:doc-group . builtin)) T ((:doc-see)) car ((:doc-group . list)
(:doc-group . builtin)) *builtins* ((:doc-group . builtin)) str ((:doc-group . string)) cons ((:doc-group . list)
--- a/src/system.sl
+++ b/src/system.sl
@@ -292,27 +292,62 @@
;;; standard procedures
(def (member item lst)
+ "Return the tail of a list beginning with the item, or `NIL` otherwise.
+ List elements are compared to the `item` using `equal?`.
+
+ Examples:
+
+ (member 1 '(3 2 1 0)) → (1 0)
+ (member 1 '(2 3)) → NIL"
+ :doc-group list
+ :doc-see memv
(cond ((equal? (car lst) item) lst)
(lst (member item (cdr lst)))))
(def (memv item lst)
+ "Return the tail of a list beginning with the item, or `NIL` otherwise.
+ List elements are compared to the `item` using `eqv?`."
+ :doc-group list
+ :doc-see member
(cond ((eqv? (car lst) item) lst)
(lst (memv item (cdr lst)))))
-(def (assoc-list . lst)
- (let ((s (cdr lst)))
+(def (assoc-list . kvs)
+ "Return an association list built of the arguments.
+
+ Every two arguments are expected to be a key and a value associated
+ with that key.
+
+ Examples:
+
+ (assoc-list 'a 0 'b 1) → ((a . 0) (b . 1))"
+ (let ((s (cdr kvs)))
(when (cons? s)
- (cons (cons (car lst) (car s))
+ (cons (cons (car kvs) (car s))
(apply assoc-list (cdr s))))))
-(def (assoc item lst)
- (cond ((equal? (caar lst) item) (car lst))
- (lst (assoc item (cdr lst)))))
+(def (assoc key lst)
+ "Return a pair of a matching key and the associated value, or `NIL` if
+ none matched. Keys are compared using `equal?`.
-(def (assv item lst)
- (cond ((eqv? (caar lst) item) (car lst))
- (lst (assv item (cdr lst)))))
+ Examples:
+ (def L (assoc-list 'a 0 'b 1))
+ (assoc 'b L) → (b . 1)
+ (assoc 'c L) → NIL"
+ :doc-group list
+ :doc-see assv
+ (cond ((equal? (caar lst) key) (car lst))
+ (lst (assoc key (cdr lst)))))
+
+(def (assv key lst)
+ "Return a pair of a matching key and the associated value, or `NIL` if
+ none matched. Keys are compared using `eqv?`."
+ :doc-group list
+ :doc-see assoc
+ (cond ((eqv? (caar lst) key) (car lst))
+ (lst (assv key (cdr lst)))))
+
(doc-group compare
"Comparison operators.")
@@ -363,9 +398,15 @@
(> x 0))
(def (even? x)
+ "Return `T` if `x` is an even integer, `NIL` otherwise."
+ :doc-group compare
+ :doc-see odd?
(= (logand x 1) 0))
(def (odd? x)
+ "Return `T` if `x` is an odd integer, `NIL` otherwise."
+ :doc-group compare
+ :doc-see even?
(not (even? x)))
(def (identity x)
@@ -404,6 +445,15 @@
x))
(def (max x0 . xs)
+ «Return the largest among the arguments.
+
+ Examples:
+
+ (max 3 1 9 4) → 9
+ (max 'c 'h 'z 'a) → z
+ (max "t" "g" "a") → "t"»
+ :doc-group compare
+ :doc-see min
(if xs
(foldl (λ (a b) (if (< a b) b a))
x0
@@ -411,6 +461,15 @@
x0))
(def (min x0 . xs)
+ «Return the smallest among the arguments.
+
+ Examples:
+
+ (min 3 1 9 4) → 1
+ (min 'c 'h 'z 'a) → a
+ (min "t" "g" "a") → "a"»
+ :doc-group compare
+ :doc-see max
(if xs
(foldl (λ (a b) (if (< a b) a b))
x0
@@ -485,6 +544,8 @@
(def (list? a)
"Return `T` if the value is either `NIL` or a cons cell, `NIL`
otherwise."
+ :doc-group list
+ :doc-see proper-list?
(or (not a) (cons? a)))
(def (proper-list? a)
@@ -500,6 +561,8 @@
(set-cdr! l l) → #0=(1 . #0#)
(length l) → +inf.0
(proper-list? l) → NIL"
+ :doc-group list
+ :doc-see list?
(def (proper? a b)
(let* {[a (cdr a)][b (cdr b)]
@@ -526,6 +589,7 @@
Use this instead of `(= (length seq) n)`, since it avoids unnecessary
work and always terminates."
:doc-group list
+ :doc-see length>
(cond ((< n 0) NIL)
((cons? seq) (length= (cdr seq) (- n 1)))
(else (= (length seq) n))))
@@ -729,7 +793,7 @@
;;; backquote
(def (revappend l1 l2)
- (reverse- l2 l1))
+ (reverse- l2 l1))
(def (nreconc l1 l2)
(reverse!- l2 l1))
@@ -742,7 +806,8 @@
(sym? x)
(eq? x (top-level-value x))))))
-(defmacro (quasiquote x) (bq-process x 0))
+(defmacro (quasiquote x)
+ (bq-process x 0))
(def (splice-form? x)
(or (and (cons? x) (or (eq? (car x) 'unquote-splicing)
@@ -945,10 +1010,36 @@
;;; debugging utilities
+(doc-group debug
+ "Debugging utilities.")
+
(defmacro (assert expr)
+ «Throw an exception if `expr` evaluates to `NIL`. Return `T` in any
+ other case.
+
+ Examples:
+
+ (def s "abc")
+ (assert (= (length s) 3)) → T
+ (assert (eq? (str-rune s 0) #\x)) → assertion failed: ...»
+ :doc-group debug
+ :doc-see assert-fail
`(if ,expr T (raise '(assert-failed ,expr))))
(defmacro (assert-fail expr . what)
+ «Throw an "assertion failed" exception if evaluating `expr` itself does
+ not result in an exception thrown. Return `T` otherwise.
+
+ To test for a specific exception type, an optional `what` argument can
+ be used.
+
+ Examples:
+
+ (def s "abc")
+ (assert-fail (= (length s) 3)) → assertion failed: ...
+ (assert-fail (= s 1) type-error) → T»
+ :doc-group debug
+ :doc-see assert
`(assert (trycatch (begin ,expr NIL)
(λ (e) ,(if what
`(eq? (car e) ',(car what))