spitewaste 0.2.0 → 0.2.5

data/lib/spitewaste/libspw/fun.spw

@@ -36,6 +36,12 @@ _isop_resume: sub add swap push 128 div jump _isop_loop
 _isop_no: dup jump _isop_resume
 _isop_done: pop ret
 
+$_do_collatz() {
+  dup push 2 mod
+  swap copy 1 push 2 mul $++ mul
+  push 2 copy 2 sub div add
+}
+
 ; returns the elements of the Collatz sequence for integer N as a pseudo-array
 ; ! may run forever on some as-yet-unknown input
 ; [N] => [A]
@@ -48,18 +54,29 @@ _isop_done: pop ret
 collatz: push 1 ; sequence length
 _collatz_loop:
   copy 1 dup push 1 sub jz _collatz_done
-  dup push 2 mod
-  swap copy 1 push 2 mul $++ mul
-  push 2 copy 2 sub div add
-  swap $++ jump _collatz_loop
+  $_do_collatz() swap $++ jump _collatz_loop
 _collatz_done: pop ret
 
+; returns the length L of the Collatz sequence for integer N
+; ! may run forever on some as-yet-unknown input
+; [N] => [L]
+;
+; [1] => [1]
+; [4] => [3]
+; [7] => [17]
+; [189] => [107]
+collatz_len: push 1 swap
+_collatz_len_loop:
+  dup $-- jz _collatz_done
+  $_do_collatz() swap $++ swap jump _collatz_len_loop
+  copy 1 dup push 1 sub jz _collatz_done
+
 ; ruby:
 ;   push "'" :strcat push "ruby -e 'p " swap :strcat shell ret
 
 $_to_roman(r, v) {
   push `v` :divmod swap push `r` swap :strrep
-  push -2 load swap :strcat push -2 swap store
+  @-2 swap :strcat ^-2
 }
 
 ; converts the number N to a string of roman numerals R
@@ -77,3 +94,17 @@ to_roman: push -2,0 store
   $_to_roman("X", 10)   $_to_roman("IX", 9)
   $_to_roman("V", 5)    $_to_roman("IV", 4)
   $_to_roman("I", 1) push 2 sub load ret
+
+; applies the ROT13 "cipher" to the string S
+; [S] => [S']
+;
+; ["gnat"] => ["tang"]
+; ["purely"] => ["cheryl"]
+; ["cat.PNG"] => ["png.CAT"]
+; ["Hello, world."] => ["Uryyb, jbeyq."]
+; ["a123z"] => ["n123m"]
+ROT13:
+  push "AZ" :strexpand push "az" :strexpand :strcat
+  push "NZ" :strexpand push "AM" :strexpand
+  push "nz" :strexpand push "am" :strexpand
+  :strcat :strcat :strcat :strtrans ret

data/lib/spitewaste/libspw/io.spw

@@ -1,6 +1,7 @@
 import string ; strcat, strpack, strrev, strunpack
 
 ; prints the character at the top of the stack until terminating zero
+; [0 ... C] => []
 print: :strunpack
 _print_loop:
   dup jz _print_done
@@ -8,34 +9,35 @@ _print_loop:
 _print_done: pop ret
 
 ; print with newline
+; [0 ... C] => []
 println: :print push 10 ochr ret
 
-;;;
-
 ; reads a line of input onto the top of the stack as a packed string
 ; ! clobbers heap address -1
+; [] => [L]
 getline: push 0 ; terminator for strpack
-
-; read characters onto the stack until newline (10) or EOF (-1)
 _getline_loop:
   push -1 dup ichr load
   dup jn _getline_eof
   dup push 10 sub jz _getline_done
   jump _getline_loop
-
 _getline_eof: pop
 _getline_done: :strpack :strrev ret
 
-;;;
-
+; displays the string S then reads a line of input
+; [S] => [L]
 prompt: :print :getline ret
 
-;;;
-
-; consume stdin until EOF
+; consume stdin until EOF into the string S
+; [] => [S]
 readall: push 0 ; accumulated string
 _readall_loop:
   :getline dup jz _readall_done
   :strcat jump _readall_loop
-
 _readall_done: pop ret
+
+; returns the contents C of the file at path P (a string)
+; NON-STANDARD! This function makes use of the `shell` instruction, which is
+; only(?) available in the Spiceweight Whitespace interpreter.
+; [P] => [C]
+readfile: push "cat " swap :strcat shell ret

data/lib/spitewaste/libspw/math.spw

@@ -51,7 +51,7 @@ ilog: push -1,0 store ; accumulator at -1
 _ilog_loop: ; [n b]
   swap copy 1 div dup jz _ilog_done
   push -1 :inc swap jump _ilog_loop
-_ilog_done: push -1 load slide 2 ret
+_ilog_done: @-1 slide 2 ret
 
 ; returns the greatest common divisor of A and B
 ; [A B] => [gcd(A, B)]
@@ -111,10 +111,7 @@ abs: dup :sign mul ret
 ; [42 6] => [7 0]
 ; [ 1 5] => [0 1]
 ; ! [9 0] => [!!] TODO: find a way to expect exceptions
-divmod:
-  push -1 swap store
-  dup push -1 load div
-  swap push -1 load mod ret
+divmod: ^-1 dup @-1 div swap @-1 mod ret
 
 ; returns whether N is greater than 0
 ; [N] => [N > 0]
@@ -138,11 +135,11 @@ neg?: :sign push -1 :eq ret
 ; [25] => [1 5 25 3] ; no duplicate for perfect squares
 ; [60] => [1 2 3 4 5 6 60 30 20 15 12 10 12]
 divisors: ; [n]
-  dup push -1 swap store ; preserve N because array operations
+  dup ^-1 ; preserve N because array operations
   :isqrt push 1 swap :range dup ; 1..isqrt(N)
-  reject (push -1 load swap mod) :arydup ; get first half of divisors
-  map (push -1 load swap div) :arycat ; map first half to second half
-  push -1 load copy 2 dup mul sub jz _divisors_square ret
+  reject (@-1 swap mod) :arydup ; get first half of divisors
+  map (@-1 swap div) :arycat ; map first half to second half
+  @-1 copy 2 dup mul sub jz _divisors_square ret
 _divisors_square: slide 1 $-- ret ; de-duplicate when N is a perfect square
 
 ; returns the number of ways to choose K elements from a set of N

data/lib/spitewaste/libspw/random.spw

@@ -1,16 +1,39 @@
-import math ; pow
+import array  ; sorted?
+import math   ; pow
+import string ; strtoa
 
-srand: push $seed swap store ret
+; seeds the random number generator with integer S
+; [S] => []
+srand: ^$seed ret
 
+; returns the next number N in the linear congruential generator (better MINSTD)
+; [] => [N]
 rand:
   push $seed dup dup load
-  push 3,13,10244807 mul mul mul
-  push 2,32 :pow mod
+  push 48271 mul
+  push 2,31 :pow $-- mod
   store load ret
 
-rand_range: ; [a b]
-  copy 1 sub :rand swap mod add ret
+; returns a random integer I between A and B (inclusive)
+; [A B] => [I]
+rand_range:
+  $++ copy 1 sub :rand swap mod add ret
 
-dice:
-  push -2 swap store push 1 :aryfill
-  map (push -2 load :rand_range) ret
+; returns an array A of N random integers between 1 and D (inclusive)
+; [N D] => [A]
+dice: ^-2 dup ^-1 times (push 1 @-2 :rand_range) @-1 ret
+
+; shuffles the array A in-place using the modern Fisher-Yates algorithm
+; [A] => [A']
+shuffle: dup $-- ^-3
+_shuffle_loop:
+  push 0 @-3 :rand_range @-3 :aryswap
+  push -3 :dec @-3 push -1 mul jn _shuffle_loop ret
+
+; shuffles the characters of the string S, producing a random anagram
+; [S] => [S']
+strfry: :strtoa :shuffle pop :strpack ret
+
+; sorts the array A if you're lucky
+; [A] => [A']
+bogosort: :shuffle :arydup :sorted? jz bogosort ret

data/lib/spitewaste/libspw/rational.spw

@@ -187,9 +187,9 @@ _ratpow_neg: push -1 mul swap :ratinv swap :ratpow ret
 ; [R(355,113) 6] => [3 141592]
 ; [R(8675,309) 10] => [28 744336569] TODO: leading 0 is lost (bug)
 ; [R(2,4) 3] => [0 500]
-to_f: push -2 swap store :from_r :divmod push 0 swap
+to_f: ^-2 :from_r :divmod push 0 swap
 _to_f_loop:
-  push -1 load :divmod  swap
+  @-1 :divmod  swap
   copy 2 push 10 mul add
   swap push 10 mul
   push 2 :dig

data/lib/spitewaste/libspw/stack.spw

@@ -1,6 +1,6 @@
 ;;; Heavy-handed stack manipulation
 
-; These subrtouines do some pretty intricate stack-based operations, relying
+; These subroutines do some pretty intricate stack-based operations, relying
 ; heavily on clobbering the heap in order to maintain their "bookkeeping".
 ; Many of them use heap addresses -10 and lower, unbounded, so they're only
 ; meant to be used in a pinch or when there just isn't much of an alternative.
@@ -16,15 +16,13 @@ import util ; dec
 ; [1 2 3 4 5 3] => [1 3 4 5 2]
 roll:
   push -10 dup store ; current heap index kept at -10
-_roll_keep: ; [n]
+_roll_keep:
   dup jz _roll_remove
   push -10 :dec
-  swap push -10 load swap store
+  swap @-10 swap store
   push 1 sub jump _roll_keep
-_roll_remove:
-  push 10 sub load
-  swap push -10 swap store
-_roll_restore: ; i
+_roll_remove: push 10 sub load swap ^-10
+_roll_restore:
   dup load swap push 1 add
   dup push 10 add jz _roll_done
   jump _roll_restore
@@ -37,15 +35,15 @@ _roll_done: load ret
 ; [1 2 3 4 5 8 5] => [8 1 2 3 4 5]
 bury:
   push -10 dup store ; current heap index kept at -10
-  swap push -9 swap store ; preserve element to bury
+  swap ^-9 ; preserve element to bury
 _bury_keep: ; [n]
   dup jz _bury_restore
   push -10 :dec
-  swap push -10 load swap store
+  swap @-10 swap store
   push 1 sub jump _bury_keep
 _bury_restore:
   push 9 sub load
-  push -10 load :_roll_restore pop ret
+  @-10 :_roll_restore pop ret
 
 
 ; "digs" out the Ith element of the stack and discards it
@@ -63,14 +61,14 @@ dig: :roll pop ret
 ;
 ; [-1 9 8 7 -1] => [7 8 9 3]
 ; [0 'c' 'b' 'a' 0] => ['a' 'b' 'c' 3]
-to_a: push -1 swap store push -10 dup store
+to_a: ^-1 push -10 dup store
 _to_a_loop:
-  dup push -1 load sub jz _to_a_sentinel
+  dup @-1 sub jz _to_a_sentinel
   push -10 dup :dec load
   swap store jump _to_a_loop
 _to_a_sentinel: pop push -10
 _to_a_restore:
-  dup push -10 load sub jz _to_a_done
+  dup @-10 sub jz _to_a_done
   push 1 sub dup load swap
   jump _to_a_restore
 _to_a_done: push -10 swap sub ret
@@ -88,7 +86,7 @@ _npop_done: pop ret
 ;
 ; [1 2 3 4 5 2] => [1 2 5]
 ; [1 2 3 4 1] => [1 2 4]
-nslide: swap push -1 swap store :npop push -1 load ret
+nslide: swap ^-1 :npop @-1 ret
 
 ; copies the Nth element to the top of the stack; this does exactly what
 ; a `copy N` instruction would do, but we don't always know N in advance
@@ -106,3 +104,14 @@ _ncopy_restore:
   dup push 9 add jz _ncopy_done
   dup load swap push 1 add jump _ncopy_restore
 _ncopy_done: pop ret
+
+; swaps the two arrays at the top of the stack
+; [A B] => [B A]
+;
+; [1 2 3 3 3 2 1 3] => [3 2 1 3 1 2 3 3]
+; [5 6 2 9 7 5 3 1 5] => [9 7 5 3 1 5 5 6 2]
+; [0 0 2 4 2 0 3] => [4 2 0 3 0 0 2]
+; [1 1 2 1] => [2 1 1 1]
+swapary:
+  push -10 :aryheap push -11 @-9 sub :aryheap
+  push -10 :heapary push -11 @-9 sub :heapary ret

data/lib/spitewaste/libspw/string.spw

@@ -224,13 +224,13 @@ _strchop_empty: ret
 ; ["foo,,bar" ','] => ["foo" "" "bar" 3]
 ; ["/foo/bar/" '/'] => ["" "foo" "bar" "" 4]
 strsplit:
-  push -3 push 1 store ; number of found substrings
-  push -2 swap store ; stash delimiter to allow some stack juggling
+  push -3,1 store ; number of found substrings
+  ^-2 ; stash delimiter to allow some stack juggling
 _strsplit_loop:
-  dup dup push -2 load
+  dup dup @-2
   :strindex dup jn _strsplit_done ; done when index of delimiter is -1
   push 0 swap :strslice
-  swap copy 1 push -3 load
+  swap copy 1 @-3
   swap :strlen
   swap push -3 swap push 1 add store ; update number of found
   push 1 add push 128 swap :pow div ; shrink haystack
@@ -248,11 +248,10 @@ lines: push 10 :strsplit ret
 ; ["foo" "bar" "baz" 3 '--'] => ["foo--bar--baz"]
 ; ["foo" 1 "?!"] => ["foo"]
 strjoinc:
-  dup :strlen pop ; get delimiter length into -1
-  push -2 swap store
-  map (push -2 load :strcat) ; add delimiter to all elements
+  dup :strlen pop ^-2 ; get delimiter length into -1
+  map (@-2 :strcat) ; add delimiter to all elements
   swap push 128 copy 1 :strlen
-  push -2 load :strlen
+  @-2 :strlen
   sub :pow mod swap ; remove delimiter from last and flow into strjoin
 
 ; concatenates the pseudo-array of strings A into string S
@@ -289,9 +288,8 @@ _strcountc_done: swap slide 2 ret
 ; ["eunoia" "aeiou"] => [5]
 ; ["why" "aeiou"] => [0]
 strcount:
-  swap push -2 swap store
-  :strunpack push 0 :to_a
-  map (push -2 load swap :strcountc)
+  swap ^-2 :strunpack push 0 :to_a
+  map (@-2 swap :strcountc)
   reduce (add) ret
 
 ; translates all characters in A to the corresponding characters in B
@@ -303,16 +301,13 @@ strcount:
 ; ["abcd" "abc" "xyz"] => ["xyzd"]
 ; ["foobar" "oba" "ele"] => ["feeler"]
 ; ["abcdcba" "abcd" "xyz|"] => ["xyz|zyx"]
-strtrans:
-  push -3 swap store
-  push -2 swap store
-  dup :strlen push -1 swap store
-  :strunpack push -1 load
+strtrans: ^-3 ^-2
+  dup :strlen ^-1 :strunpack @-1
   map (:_strtrans) pop :strpack ret
 _strtrans:
-  dup push -2 load swap :strindex
+  dup @-2 swap :strindex
   dup jn _strtrans_no
-  push -3 load swap :charat
+  @-3 swap :charat
   slide 1 ret
 _strtrans_no: pop ret
 
@@ -346,8 +341,8 @@ _strsqueeze_skip: pop jump _strsqueeze_loop
 _strsqueeze_done: pop :strpack :strrev ret
 
 $_strdel(cmp) {
-  :strunpack push -1 load :strlen
-  select (push -2 load swap :strindex `cmp`)
+  :strunpack @-1 :strlen
+  select (@-2 swap :strindex `cmp`)
   pop :strpack ret
 }
 
@@ -390,13 +385,39 @@ strrotl: push 128 swap copy 2 :strlen mod :pow :divmod :strcat ret
 ; ["abcd" 1] => ["dabc"]
 ; ["abcd" 5] => ["dabc"]
 ; ["foodbar" 3] => ["barfood"]
-strrotr: push 0 swap sub :strrotl ret
+strrotr: push -1 mul :strrotl ret
+
+; gets the characters of the string S onto the stack as a pseudo-array, but
+; with a leading 0 on the assumption that it'll eventually be repacked
+;
+; ["abc"] => [0 99 98 97 3]
+strtoa: dup :strlen pop :strunpack @-1 $++ ret
 
 ; frobnicates the string S by XORing all its bytes with 42
 ; [S] => [S']
 ;
 ; ["foobar"] => ["LEEHKX"]
 ; ["LEEHKX"] => ["foobar"]
-memfrob:
-  dup :strlen pop :strunpack push -1 load $++
-  map (push 42 :bxor) pop :strpack ret
+memfrob: :strtoa map (push 42 :bxor) pop :strpack ret
+
+; returns 1 if the string S begins with substring T, 0 otherwise
+; [S T] => [0 | 1]
+;
+; ["foobar" "foo"] => [1]
+; ["foobar" "boo"] => [0]
+; ["abc123" "123"] => [0]
+; [" foo" " "] = [1]
+strbegins?:
+  dup :strlen copy 2 swap push 0 swap
+  :strslice :eq slide 1 ret
+
+; returns 1 if the string S ends with substring T, 0 otherwise
+; [S T] => [0 | 1]
+;
+; ["foobar" "bar"] => [1]
+; ["foobar" "foo"] => [0]
+; ["abc123" "abc"] => [0]
+; ["foo " " "] = [1]
+strends?:
+  :strrev dup :strlen copy 2 :strrev swap push 0 swap
+  :strslice :eq slide 1 ret

data/lib/spitewaste/libspw/test.spw

@@ -8,3 +8,6 @@ assert_eq:
   push ", got " :print onum
   push " for test " swap :strcat :die!
 _assert_eq_yes: pop pop pop ret
+
+assert_nz: jz _assert_nz_no pop ret
+_assert_nz_no: push "expected nonzero for test " swap :strcat :die!

data/lib/spitewaste/libspw/util.spw

@@ -26,7 +26,7 @@ _range_down:
 
 $range_loop(fn, cmp) {
 `fn`:
-  dup copy 2 add push -1 load `cmp` jz _`fn`_done
+  dup copy 2 add @-1 `cmp` jz _`fn`_done
   copy 1 copy 1 add swap jump `fn`
 _`fn`_done: pop ret
 }
@@ -50,8 +50,10 @@ steprange: swap push -1 copy 1 store copy 2 sub
 $range_loop(_steprange_loop, :lte)
 $range_loop(_steprange_down_loop, :gte)
 
-; prints the string at the top of the stack and halts execution
-die!: :println exit
+; prints the string at the top of the stack and halts execution after pushing
+; something onto the stack to signal abnormal termination/unclean exit
+; [...] => [... 1]
+die!: :println push 1 exit
 
 ; for stoi and itos
 alpha: push "0123456789abcdefghijklmnopqrstuvwxyz" ret
@@ -72,7 +74,7 @@ alpha: push "0123456789abcdefghijklmnopqrstuvwxyz" ret
 ; ["-123" 10] => [-123]
 ; ["-ff" 16] => [-255]
 stoi: swap dup :_stoi_sign swap copy 1 :eq
-  push 2 mul $-- push -2 swap store push 0
+  push 2 mul $-- ^-2 push 0
 _stoi_loop: ; [b s a]
   swap dup jz _stoi_done
   swap copy 2 copy 2
@@ -83,8 +85,8 @@ _stoi_loop: ; [b s a]
   mul add swap push 128 div swap
   jump _stoi_loop
 _stoi_sign: dup push 0 :charat push '-' :eq copy 1 :strlen :strslice ret
-_stoi_invalid: pop pop slide 1 swap div push -2 load mul ret
-_stoi_done: swap slide 2 push -2 load mul ret
+_stoi_invalid: pop pop slide 1 swap div @-2 mul ret
+_stoi_done: swap slide 2 @-2 mul ret
 
 ; creature comforts
 
@@ -111,7 +113,7 @@ _itos_loop:
   swap :strcat
   swap copy 2 div
   swap jump _itos_loop
-_itos_done: swap slide 2 push 45,-2 load mul swap :strcat ret
+_itos_done: swap slide 2 push 45 @-2 mul swap :strcat ret
 
 ; creature comforts
 
@@ -129,12 +131,10 @@ to_hex: push 16 :itos ret
 ; [256 16] => [1 0 0 3]
 digits:
   copy 1 jz _digits_zero ; special case
-  push -1 swap store
-  push -1 swap ; sentinel value
+  ^-1 push -1 swap ; sentinel value
 _digits_loop:
   dup jz _digits_done
-  push -1 load :divmod
-  swap jump _digits_loop
+  @-1 :divmod swap jump _digits_loop
 _digits_zero: dup div ret
 _digits_done: push 1 sub :to_a ret
 
@@ -215,8 +215,8 @@ between?: copy 2 :gte swap copy 2 :lte mul slide 1 ret
 ; a value V to search for and a starting index I, and either returns the first
 ; key associated with that value or loops forever. Probably don't touch.
 ; [V I]
-heap_seeking_missile:
-  $++ dup load copy 2 :eq jz heap_search
+heap-seeking_missile:
+  $++ dup load copy 2 :eq jz heap-seeking_missile
   slide 1 ret
 
 ; converts the #RRGGBB (leading '#' optional) color string S to
@@ -246,3 +246,31 @@ rgb2hex:
   copy 2 push 256 mul add add
   slide 2 :to_hex push 6,48 :rjustc ret
 _rgb2hex_invalid: push "(rgb2hex) invalid RGB" :die!
+
+; stashes the array A in negative heap space starting at index I
+; [A I] => []
+aryheap:
+  $++ dup copy 2 store
+  swap times ($-- swap copy 1 swap store) pop ret
+
+; restores the heaped array starting at index I
+; [I] => [A]
+heapary:
+  $++ dup load swap copy 1 sub swap
+  times (dup load swap $++) load ret
+
+; swaps the elements in the heap at indices I and J
+; ! TODO: make heap effects doctest-able
+; [I J] => []
+heapswap: dup load swap copy 2 load store store ret
+
+; returns the number of nanoseconds N since the Unix epoch
+; [] => [N]
+time: push "date +%s%N" shell :to_i ret
+
+$bench(insns) {
+  #insns :println
+  :time ^0 `insns` :time @0 sub
+  push 10,9 :pow :divmod swap onum
+  push '.' ochr :to_s push 9,48 :rjustc :println
+}