shithub: sl

Info  •  Files  •  Log  •  Branches

docs: the rest of ops

That makes all opcodes that map to functions have documentation.

References: https://todo.sr.ht/~ft/sl/16

--- a/boot/sl.boot

+++ b/boot/sl.boot

@@ -23,12 +23,12 @@

   new-first))  cons? ((v))  1+ ((n))  aref ((sequence subscript0 . rest))  zero? ((x))  vec (rest)  >= ((a . rest))  sym? ((v))  void? ((x))  length= ((lst

   n))  positive? ((x))  doc-for ((term (doc NIL)))  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))  apply ((fn

-  arg . rest))  io? ((term))  eof-object? ((term))  list (rest)  help ((term (:print-header

-                                                                              help-print-header)))  rand-u32 (NIL)  = ((a . rest))  rand-u64 (NIL)  not ((v))  set-cdr! ((cell

+  (: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

+  (:print-header help-print-header)))  rand-u32 (NIL)  = ((a . rest))  rand-u64 (NIL)  not ((v))  set-cdr! ((cell

   new-second))  /= ((a . rest))  fn? ((v))  help-print-header ((term sigs))  lz-pack ((data (level

-  0)))  *prompt* (NIL)  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."  io-eof? "Return `T` if `io` is currently in the \"end of file\" state, `NIL`\notherwise."  < "Return `T` if the arguments are in strictly increasing order (next\none is greater than the previous one)."  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 "Convert terms to a symbol.\n\nThis is equivalent to `(sym (str terms…))`."  nan? "Return `T` if `v` is a floating point representation of NaN, either\nnegative or positive, `NIL` otherwise."  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"  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)\n    (exit \"error\")"  > "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` with none."  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"  __finish "A function called right before exit by the VM."  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`),\nwhere the first element is the name of the structure's type, the\nrest are the slot values.  If the name as the first element isn't\nrequired, `:named NIL` should be used.  A list can be used instead\nof a vector by adding `:type list` option.\n\nAn example of a default constructor signature, based on structure\ndefinition:\n\n    (defstruct blah a b c) →\n      (make-blah (:a NIL) (:b NIL) (:c NIL))\n\nIt can be customized in several ways. For example:\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 `name-`.\n\nDefault predicate name (`name?`) can be changed:\n\n    ; use \"blargh?\" instead of \"blah?\"\n    (defstruct blah :predicate blargh? a b c)"  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, `NIL` otherwise."  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:\

\ No newline at end of file

+  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."  io-eof? "Return `T` if `io` is currently in the \"end of file\" state, `NIL`\notherwise."  < "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 "Convert terms to a symbol.\n\nThis is equivalent to `(sym (str terms…))`."  nan? "Return `T` if `v` is a floating point representation of NaN, either\nnegative or positive, `NIL` otherwise."  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"  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)\n    (exit \"error\")"  > "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"  __finish "A function called right before exit by the VM."  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`),\nwhere the first element is the name of the structure's type, the\nrest are the slot values.  If the name as the first element isn't\nrequired, `:named NIL` should be used.  A list can be used instead\nof a vector by adding `:type list` option.\n\nAn example of a default constructor signature, based on structure\ndefinition:\n\n    (defstruct blah a b c) →\n      (make-blah (:a NIL) (:b NIL) (:c NIL))\n\nIt can be customized in several ways. For example:\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 `name-`.\n\nDefault predicate name (`name?`) can be changed:\n\n    ; use \"blargh?\" instead of \"blah?\"\n    (defstruct blah :predicate blargh? a b c)"  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"  s

\ No newline at end of file

 n\n    (def q '(1 2 3 4 5))\n    (set-car! q 0) → (0 6 7)\n    q              → (0 6 7)"  cons? "Return `T` if `v` is a cons cell, `NIL` otherwise."  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 table."  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."  length= "Perform a bounded length test.\n\nUse this instead of `(= (length lst) 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."  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))"  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"  *builtins* "VM instructions as closures."  str "Convert terms to a concatenated string.\n\nThis is equivalent to `(princ terms…)`, except the string is\nreturned, rather than printed."  cons "Return a cons cell containing two arguments.\n\nExamples:\n\n    (cons 1 2)                     → (1 . 2)\n    (cons 1 '(2))                  → (1 2)\n    (cons 1 (cons 2 (cons 3 NIL))) → (1 2 3)"  - "Return the result of subtraction.  With only one argument a\nnegation is performed.\n\nExamples:\n\n    (- 1.5) → -1.5\n    (- 3 2) → 1"  remprop "Remove a property value associated with a symbol."  <= "Return `T` if the arguments are in non-decreasing order (previous\none is less than or equal to the next one)."  rand "Return a random non-negative fixnum on its maximum range."  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."  negative? "Return `T` if `x` is negative."  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)`."  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."  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"  T "A boolean \"true\".\n\nExamples:\n\n    (not T)         → NIL\n    (if T 'yes 'no) → yes"  vec? "Return `T` if `v` is a vector, `NIL` otherwise."  / "

\ No newline at end of file

             *syntax-environment* #table(bcode:nconst #fn("n1200r2e3:" #(aref))  doc-for #fn("\x8710002000W1000J60q?140B86;35040<;J404086;35040=863D0202187e212188e2e4:202187e21e3:" #(sym-set-doc

   quote))  with-input-from #fn("z12021e1220e2e1e12315163:" #(#fn(nconc) with-bindings *io-in* #fn(copy-list)))  unless #fn("z1200q211Pe4:" #(if

--- a/tools/gen.lsp

+++ b/tools/gen.lsp

@@ -62,7 +62,13 @@

   (op loadc0)

   (op cons? 1 (λ (x) (cons? x))

     {[(v)

-      "Return `T` if `v` is a cons cell, `NIL` otherwise."]})

+      "Return `T` if `v` is a cons cell, `NIL` otherwise.

+

+       Examples:

+

+           (cons? 0)    → NIL

+           (cons? NIL)  → NIL

+           (cons? '(1)) → T"]})

   (op brne)

   (op loadt)

   (op load0)

@@ -73,7 +79,13 @@

       "Return `T` if `v` is a _not_ a cons cell, `NIL` otherwise.  This is

        the opposite of `cons?`.

-       The term \"atom\" comes from the idea of being indivisible."]})

+       The term \"atom\" comes from the idea of being indivisible.

+

+       Examples:

+

+           (atom? \"a\")  → T

+           (atom? NIL)  → T

+           (atom? '(1)) → NIL"]})

   (op loadvoid)

   (op brnn)

   (op load1)

@@ -80,7 +92,8 @@

   (op < -1 (λ rest (apply < rest))

     {[(a . rest)

       "Return `T` if the arguments are in strictly increasing order (next

-       one is greater than the previous one)."]}

+       one is greater than the previous one).  With a single argument

+       the result is always `T`."]}

     :cname "LT")

   (op add2)

   (op set-cdr! 2 (λ (x y) (set-cdr! x y))

@@ -104,7 +117,20 @@

            (cons 1 2)                     → (1 . 2)

            (cons 1 '(2))                  → (1 2)

            (cons 1 (cons 2 (cons 3 NIL))) → (1 2 3)"]})

-  (op eq? 2 (λ (x y) (eq? x y))) ; FIXME

+  (op eq? 2 (λ (x y) (eq? x y))

+    {[(a b)

+      "Return `T` if `a` and `b` are the same object, `NIL` otherwise.

+

+       Examples:

+

+           (eq? 0.0 0) → NIL

+           (eq? 0 0)   → T

+           (def a \"1\")

+           (def b \"1\")

+           (eq? a b)   → NIL

+           (def a '(1))

+           (def b '(1))

+           (eq? a b)   → NIL"]})

   (op sym? 1 (λ (x) (sym? x))

     {[(v)

       "Return `T` if `v` is a symbol, `NIL` otherwise."]})

@@ -142,10 +168,21 @@

       "Return `T` if `symbol` has a value associated with it, `NIL` otherwise."]})

   (op builtin? 1 (λ (x) (builtin? x))

     {[(v)

-      "Return `T` if `v` is a built-in function, `NIL` otherwise."]})

+      "Return `T` if `v` is a built-in function implemented in C, `NIL`

+       otherwise.

+

+       Examples:

+

+           (builtin? map)         → T

+           (builtin? macroexpand) → NIL"]})

   (op fn? 1 (λ (x) (fn? x))

     {[(v)

-      "Return `T` if `v` is a function, `NIL` otherwise."]})

+      "Return `T` if `v` is a function, `NIL` otherwise.

+

+       Examples:

+

+           (fn? map)         → T

+           (fn? macroexpand) → T"]})

   (op vec? 1 (λ (x) (vec? x))

     {[(v)

       "Return `T` if `v` is a vector, `NIL` otherwise."]})

@@ -164,8 +201,38 @@

   (op jmp.l)

   (op brn.l)

   (op box)

-  (op eqv? 2 (λ (x y) (eqv? x y))) ; FIXME

-  (op equal? 2 (λ (x y) (equal? x y))) ; FIXME

+  (op eqv? 2 (λ (x y) (eqv? x y))

+    {[(a b)

+      "Return `T` if both `a` and `b` are of the same value and primitive

+       (leaf) type, `NIL` otherwise.  Neither cons cell nor vector are not

+       considered primitive types as they may define deep structures.

+

+       Examples:

+

+           (eqv? 0.0 0) → NIL

+           (eqv? 0 0)   → T

+           (def a \"1\")

+           (def b \"1\")

+           (eqv? a b)   → T

+           (def a '(1))

+           (def b '(1))

+           (eqv? a b)   → NIL"]})

+  (op equal? 2 (λ (x y) (equal? x y))

+    {[(a b)

+      "Return `T` if both `a` and `b` are of the same value.  For non-leaf

+       types (cons cell and vector), the equality test is performed

+       throughout the whole structure of the values.

+

+       Examples:

+

+           (equal? 0.0 0) → NIL

+           (equal? 0 0)   → T

+           (def a \"1\")

+           (def b \"1\")

+           (equal? a b)   → T

+           (def a '(1))

+           (def b '(1))

+           (equal? a b)   → T"]})

   (op list T (λ rest rest)

     {[rest

       "Return a list constructed of the arguments.

@@ -188,7 +255,7 @@

            (apply arr 'u8 '(3 4 5)) → #vu8(3 4 5)"]})

   (op + T (λ rest (apply + rest))

     {[rest

-      "Return sum of the arguments or `0` with none."]}

+      "Return sum of the arguments or `0` when none specified."]}

     :cname "ADD")

   (op - -1 (λ rest (apply - rest))

     {[(a . rest)

@@ -202,7 +269,7 @@

     :cname "SUB")

   (op * T (λ rest (apply * rest))

     {[rest

-      "Return product of the arguments or `1` with none."]}

+      "Return product of the arguments or `1` when none specified."]}

     :cname "MUL")

   (op / -1 (λ rest (apply / rest))

     {[(x . rest)