spitewaste 0.1.003 → 0.1.004

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4f49809a688762a3b50dab64b93163e493aa75a33d2565b9892ec5ad8c9bc0
-  data.tar.gz: 6a06768b5a4edcf18ca0948900effd3c3fb01fbdea2e2da8d29080036870614f
+  metadata.gz: 5e6953a0755edbb33708f3cdc1ebeb33cdb6a47c1f3d6335716d25f693dec56c
+  data.tar.gz: 130d57daadcee3de1a465e4be9b28bba16d70c4dafa87c59195696be06e49a7c
 SHA512:
-  metadata.gz: 99cc02efffe8e2ddecf76b1b8578c4eb5e3a6c96b0cf1d46d063b9268507120a718835822f906739962a0b36262ae08328c610db3b37b0a777b3ff84d5e2df02
-  data.tar.gz: fa3425ae1c074a9a34f78bf110a7d8bb645b15205bb78f68787060e61c018cf63925c2c32d67bbf5ab0d4552c37727555dfcdd384824af2b6087c665bf969233
+  metadata.gz: b1f2075fb27a9ecf5599365cf029bfeebacfda5208a5df357ea94de00465111f61d42cc58a5220e16de710dfe4c778acf911e65ab3d86459c7039cee37f011a6
+  data.tar.gz: ea2003b53fe38c7fa092b2c43c383706980009fd1efa54f5733e40937b180fd76ea08e973dd5e16835fab1854f075add855af1957357aeab391df0dab6945e92

data/Rakefile

@@ -7,15 +7,20 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/*_test.rb']
 end
 
-desc "Generate standard library documentation."
+task test: :docs
+
+desc 'Generate standard library documentation.'
 task :docs do |t|
-  all_docs = {}
-  Dir['lib/spitewaste/libspw/math*'].each do |path|
-    lib = File.basename path, '.spw'
-    all_docs[lib] = extract_docs path
-  end
+  docs = {}
+
+  Dir.chdir('lib/spitewaste/libspw') do |d|
+    %w[rational.spw array.spw stack.spw util.spw string.spw math.spw].each do |path|
+      lib = File.basename path, '.spw'
+      docs[lib] = extract_docs path
+    end
 
-  File.open('docs.json', ?w) { |f| JSON.dump all_docs, f }
+    File.open('docs.json', ?w) { |f| JSON.dump docs, f }
+  end
 end
 
 def extract_docs path
@@ -41,12 +46,24 @@ def strpack s
 end
 
 def parse_stack s
-  s.split.map { Integer(_1) rescue strpack _1.delete %('") }
+  s.scan(/"[^"]*"|\S+/).map { |v|
+    begin
+      Integer v
+    rescue
+      if v[/R\((-?\d+),(-?\d+)\)/]
+        n, d = $1.to_i, $2.to_i
+        s = (n<=>0) * (d<=>0)
+        (n.abs * 2**31 + d.abs) * 2 + (s == -1 ? 0 : 1)
+      else
+        strpack v.delete %('")
+      end
+    end
+  }
 end
 
-def parse_doc doc
-  StackRx = /(?<=\[)[^\]]+(?=\])/ # match [.+], but don't capture the brackets
+StackRx = /(?<=\[)[^\]]*(?=\])/ # match [.*], but don't capture the brackets
 
+def parse_doc doc
   # strip comment character and any implementation details
   doc.gsub!(/; */, '').gsub!(/^!.+\n/, '')
 

data/lib/spitewaste.rb

@@ -17,7 +17,7 @@ module Spitewaste
     black = program.size - white
 
     return :whitespace if white > black
-    program[/[^-\w\s]/] ? :spitewaste : :assembly # TODO: something more robust?
+    program[/import|[^-\w\s]/] ? :spitewaste : :assembly
   end
 end
 

data/lib/spitewaste/cli/exec.rb

@@ -16,28 +16,25 @@ class SpitewasteCLI
 - use % to write to $HOME/.cache/spitewaste directory, where Spiceweight knows to look',
     aliases: '-s'
 
-  def exec file = '/dev/stdin'
+  def exec input = '/dev/stdin'
     fmt = SpitewasteCLI.validate_format options
 
-    raise LoadError, "No such file '#{file}'", [] unless File.exists? file
+    raise LoadError, "No such file '#{input}'", [] unless File.exists? input
 
     opts = options.dup # options is frozen
     if opts[:symbol_file] == '%'
-      opts[:symbol_file] = SpitewasteCLI.make_cache_path file
+      opts[:symbol_file] = SpitewasteCLI.make_cache_path input
     end
 
-    path =
-      if File.extname(file) != '.ws'
-        io = Tempfile.new
-        as = Spitewaste::Assembler.new File.read(file), format: fmt, **opts
-        as.assemble! format: :whitespace, io: io
-        io.tap(&:close).path
-      else
-        file
-      end
+    if File.extname(input) != '.ws'
+      io = Tempfile.new
+      as = Spitewaste::Assembler.new File.read(input), format: fmt, **opts
+      as.assemble! format: :whitespace, io: io
+      input = io.tap(&:close).path
+    end
 
     cmd = options[:interpreter].split
-    cmd.map! { |c| c == '%' ? path : c }
+    cmd.map! { |c| c == '%' ? input : c }
     Kernel.exec *cmd
   end
 end

data/lib/spitewaste/libspw/array.spw

@@ -1,3 +1,7 @@
+import math  ; divmod, max, min, pos?
+import stack ; bury, dig, ncopy, nslide, roll
+import util  ; dec, die!, eq
+
 $amax = 1000
 
 arysum: reduce (add) ret
@@ -48,7 +52,7 @@ aryat: ; [a i]
 
 _aryat_neg: copy 1 add dup jn _aryat_oob jump aryat
 
-_aryat_oob: push "(aryat) index out of bounds!" :die
+_aryat_oob: push "(aryat) index out of bounds!" :die!
 
 minmax:
   :arydup reduce (:max)

data/lib/spitewaste/libspw/bits.spw

@@ -1,6 +1,8 @@
-import math
+import math   ; ilog, pow
+import string ; strcat, strlen, strrev
+import util   ; bin, digits, itos
 
-; TODO: don't use strings for bitwise operations
+; TODO: don't use strings for bitwise operations!
 
 ; bitwise bitwise_and
 ; ! clobbers heap address -1

data/lib/spitewaste/libspw/case.spw

@@ -1,4 +1,6 @@
-import bits
+import bits   ; bitwise_and, bitwise_or, bitwise_xor
+import string ; isalpha, strcat, strunpack
+
 ;;; Case conversion
 
 upcase: :strunpack push 0 ; tally

data/lib/spitewaste/libspw/fun.spw

@@ -1,4 +1,8 @@
-import string
+import array  ; sort
+import case   ; upcase
+import stack  ; to_a
+import string ; isalpha, strcat, strjoin, strrev, strunpack
+import util   ; eq
 
 palindrome?: dup :strrev :eq ret
 

data/lib/spitewaste/libspw/io.spw

@@ -1,3 +1,5 @@
+import string ; strcat, strpack, strrev, strunpack
+
 ; prints the character at the top of the stack until terminating zero
 print: :strunpack
 _print_loop:

data/lib/spitewaste/libspw/math.spw

@@ -1,4 +1,5 @@
-import util ; range for factorial, inc for ilog
+import array ; arycat, arydup
+import util  ; eq, inc, range
 
 ; returns B raised to the power E
 ; [B E] => [B**E]
@@ -41,79 +42,116 @@ _isqrt_update: slide 1 jump _isqrt_loop
 ; ! clobbers heap address -1 TODO: maybe unnecessarily?
 ; [N B] => [logB(N)]
 ;
-; [15 4] => [1], [16 4] => [2]
+; [15   4] => [1]
+; [16   4] => [2]
 ; [100 10] => [2]
-; [42 2] => [5]
+; [42   2] => [5]
 ilog: push -1,0 store ; accumulator at -1
-_ilog_loop:
-  swap dup jz _ilog_done
-  push -1 :inc
-  copy 1 div swap jump _ilog_loop
+_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
 
-; greatest common divisor
-gcd: ; [a  b]
-  dup jz _gcd_done
-  swap copy 1 mod
-  jump gcd
-
+; returns the greatest common divisor of A and B
+; [A B] => [gcd(A, B)]
+;
+; [6 9] => [3]
+; [13 17] => [1]
+; [24 36] => [12]
+gcd: dup jz _gcd_done swap copy 1 mod jump gcd
 _gcd_done: pop ret
 
-; least common multiple
-lcm: ; [a b]
-  copy 1 mul
-  swap dup copy 2 swap div
-  :gcd div ret
-
-;;;
+; returns the least common multiple of A and B
+; [A B] => [lcm(A, B)]
+;
+; [6 9] => [18]
+; [13 17] => [221]
+; [24 36] => [72]
+lcm: copy 1 mul swap dup copy 2 swap div :gcd div ret
 
-min: ; [a b]
-  copy 1 copy 1 sub jn _min_done swap
+; keeps the minimum of the top two stack values
+; [A B] => [A < B ? A : B]
+;
+; [3 1] => [1]
+; [2 4] => [2]
+min: copy 1 copy 1 sub jn _min_done swap
 _min_done: pop ret
 
-max: ; [a b]
-  copy 1 copy 1 sub jn _max_done swap
+; keeps the maximum of the top two stack values
+; [A B] => [A > B ? A : B]
+;
+; [3 1] => [3]
+; [2 4] => [4]
+max: copy 1 copy 1 sub jn _max_done swap
 _max_done: slide 1 ret
 
-;;;
-
-; -1, 0, or 1 to indicate the sign of the argument
-sign: ; [n]
-  dup jz _sign_zero
-  jn _sign_neg
-  push 1 ret
+; returns -1, 0, or 1 to indicate the sign of N
+; [N] => [-1 | 0 | 1]
+;
+; [17] => [1]
+; [-25] => [-1]
+; [0] => [0]
+sign: dup jz _sign_zero jn _sign_neg push 1 ret
 _sign_zero: ret
 _sign_neg: push -1 ret
 
-; absolute value ; [n] => [abs(n)]
+; returns the absolute value of N
+; [N] => [N < 0 ? -N : N]
+;
+; [-5] => [5]
+; [10] => [10]
+; [0] => [0]
 abs: dup :sign mul ret
 
-;;;
-
+; pops A and B and pushes both their quotient and modulus
+; [A B] => [A/B A%B]
+;
+; [17 5] => [3 2]
+; [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
 
-;;;
-
+; returns whether N is greater than 0
+; [N] => [N > 0]
+;
+; [5] => [1]   [-3] => [0]   [0] => [0]
 pos?: :sign push  1 :eq ret
-neg?: :sign push -1 :eq ret
 
-;;;
+; returns whether N is less than 0
+; [N] => [N < 0]
+;
+; [5] => [0]   [-3] => [1]   [0] => [0]
+neg?: :sign push -1 :eq ret
 
+; returns a pseudo-array of the positive divisors of N; as an optimization,
+; they're not returned in ascending order, but rather in two "halves".
+; The alternative is unnecessarily invoking to_a and clobbering heap.
+; [N]
+;
+; [10] => [1 2 10 5 4]
+; [12] => [1 2 3 12 6 4 6]
+; [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
-  :isqrt push 1 swap :range dup ; 1..n**0.5
+  dup push -1 swap store ; 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
-
+  push -1 load 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
+; [N K]
+;
+; [ 4 5] => [0]
+; [ 7 7] => [1]
+; [13 3] => [286]
+; [16 4] => [1820]
+; [50 3] => [19600]
 nCk:
   copy 1 copy 1 sub :factorial
   swap :factorial mul

data/lib/spitewaste/libspw/prime.spw

@@ -1,3 +1,6 @@
+import math ; divmod
+import util ; inc
+
 ; [n] => [0|1]
 prime?: ; [n]
   dup push 3 sub jn _prime_special ; special-case < 3
@@ -40,7 +43,5 @@ _factor_loop: ; [d n]
 _divisor_loop:
   dup copy 2 :divmod jz _divisor_keep
   pop swap :next_prime swap jump _factor_loop
-
 _divisor_keep: push -2 :inc slide 1 copy 1 swap jump _factor_loop
-
 _factor_done: slide 1 push 3 sub load ret

data/lib/spitewaste/libspw/random.spw

@@ -1,3 +1,5 @@
+import math ; pow
+
 srand: push $seed swap store ret
 
 rand:

data/lib/spitewaste/libspw/rational.spw

@@ -0,0 +1,153 @@
+;;; Rational numbers
+
+import math ; abs, divmod, gcd, pow, sign
+import util ; die!, neq
+
+; maximum value of either component of a rational number before behavior is
+; undefined; 2^31 by default to give interpreters without bignums a chance,
+; but customizable from userland.
+$RAT = push 2,31 :pow
+
+; encodes a numerator N and a denominator D as a rational number R with the
+; following structure: ((N × $RAT + D) << 1) + sign (0 for negative, else 1).
+; This representation is nice because, with care, it makes it so that we never
+; have to involve the heap (besides divmod) just to do fairly basic arithmetic.
+; [N D] => [R]
+;
+; [22 7]  => [R(22,7)]
+; [4 8]   => [R(4,8)]  ; no implicit simplification TODO: make it configurable?
+; [5 1]   => [R(5,1)]  ; no conversion to integer (duh)
+; [-3 4]  => [R(-3,4)]
+; [3 -4]  => [R(-3,4)] ; sign always held in the numerator
+; [-1 -3] => [R(1,3)]
+to_r: dup jz _to_r_dbz
+  dup :sign copy 2 :sign mul push -1 :neq
+  copy 2 :abs copy 2 :abs
+  $RAT copy 2 mul add push 2 mul
+  copy 2 add slide 4 ret
+_to_r_dbz: push "0 in denominator!" :die!
+
+; returns the numerator N of the rational number R, which may be negative
+; [R] => [N]
+;
+; [R(22,7)] => [22]
+; [R(-3,4)] => [-3]
+; [R(3,-4)] => [-3]
+ratnum: push 2 :divmod push 2 mul push 1 sub swap $RAT div mul ret
+
+; returns the denominator D of the rational number R; always positive
+; [R] => [D]
+;
+; [R(22,7)] => [7]
+; [R(-3,4)] => [4]
+; [R(3,-4)] => [4]
+ratden: push 2 div $RAT mod ret
+
+; decomposes the rational number R into its numerator N and denominator D
+; [R] => [N D]
+;
+; [R(22,7)] => [22 7]
+; [R(-3,4)] => [-3 4]
+; [R(3,-4)] => [-3 4]
+; [R(4,8)]  => [4 8]  ; no implicit simplification
+from_r: dup :ratnum swap :ratden ret
+
+; fully simplifies the rational number R by dividing both of its components
+; by their greatest common divisor
+; [R] => [R, simplified]
+;
+; [R(4,8)] => [R(1,2)]
+; [R(-3,12)] => [R(-1,4)]
+; [R(17,-51)] => [R(-1,3)]
+ratsimp:
+  push 2 :divmod swap $RAT :divmod dup copy 2 :gcd
+  swap copy 1 div copy 2 copy 2 div swap :to_r
+  slide 2 push 2 div push 2 mul add ret
+
+; helper prologue shared by all but ratmul
+_rathead:
+  copy 1 :ratnum copy 1 :ratden mul
+  copy 2 :ratden copy 2 :ratnum mul ret
+
+; helper epilogue shared by all but ratdiv
+_rattail:
+  copy 2 :ratden copy 2 :ratden mul
+  :to_r :ratsimp slide 2 ret
+
+; returns the simplified sum of the rational numbers Ra and Rb
+; [Ra Rb] => [Ra + Rb]
+;
+; [R(-9,-14) R(-3,19)]  => [R(129,266)]
+; [R(17,30)  R(18,10)]  => [R(71,30)]
+; [R(-27,14) R(15,-23)] => [R(-831,322)]
+; [R(3,-9)   R(8,3)]    => [R(7,3)]
+; [R(-5,27)  R(-2,-27)] => [R(-1,9)]
+; [R(-27,-8) R(-15,22)] => [R(237,88)]
+; [R(-9,-29) R(-27,3)]  => [R(-252,29)]
+; [R(2,-21)  R(4,6)]    => [R(4,7)]
+ratadd: :_rathead add :_rattail ret
+
+; returns the simplified difference of the rational numbers Ra and Rb
+; [Ra Rb] => [Ra - Rb]
+;
+; [R(21,25)  R(-28,27)]  => [R(1267,675)]
+; [R(14,7)   R(13,6)]    => [R(-1,6)]
+; [R(-24,-9) R(-5,-21)]  => [R(17,7)]
+; [R(-27,-2) R(-2,26)]   => [R(353,26)]
+; [R(-27,3)  R(2,-22)]   => [R(-98,11)]
+; [R(-4,23)  R(-9,13)]   => [R(155,299)]
+; [R(-14,19) R(-18,-11)] => [R(-496,209)]
+; [R(-29,21) R(-15,-16)] => [R(-779,336)]
+ratsub: :_rathead sub :_rattail ret
+
+; returns the simplified product of the rational numbers Ra and Rb
+; [Ra Rb] => [Ra × Rb]
+;
+; [R(-24,26) R(-1,-30)]  => [R(-2,65)]
+; [R(19,4)   R(27,2)]    => [R(513,8)]
+; [R(25,27)  R(4,-11)]   => [R(-100,297)]
+; [R(1,18)   R(4,8)]     => [R(1,36)]
+; [R(1,27)   R(-8,29)]   => [R(-8,783)]
+; [R(25,-13) R(-6,24)]   => [R(25,52)]
+; [R(6,-13)  R(9,23)]    => [R(-54,299)]
+; [R(11,8)   R(-19,-19)] => [R(11,8)]
+ratmul: copy 1 :ratnum copy 1 :ratnum mul :_rattail ret
+
+; returns the simplified quotient of the rational numbers Ra and Rb
+; [Ra Rb] => [Ra / Rb]
+;
+; [R(-30,-22) R(15,12)]   => [R(12,11)]
+; [R(13,28)   R(-15,29)]  => [R(-377,420)]
+; [R(7,-30)   R(-22,-12)] => [R(-7,55)]
+; [R(15,4)    R(8,-8)]    => [R(-15,4)]
+; [R(-23,28)  R(-16,-15)] => [R(-345,448)]
+; [R(-18,12)  R(6,18)]    => [R(-9,2)]
+; [R(29,-2)   R(11,-21)]  => [R(609,22)]
+; [R(-23,25)  R(25,-3)]   => [R(69,625)]
+ratdiv: :_rathead :to_r :ratsimp slide 2 ret
+
+; returns the simplified modulus of the rational numbers Ra and Rb
+; [Ra Rb] => [Ra % Rb]
+;
+; [R(-15,-3) R(-16,-10)] => [R(1,5)]
+; [R(4,2)    R(21,21)]   => [R(0,1)]
+; [R(24,10)  R(-18,-3)]  => [R(12,5)]
+; [R(3,-7)   R(-2,16)]   => [R(-3,56)]
+; [R(4,28)   R(-29,7)]   => [R(-4,1)]
+; [R(7,-27)  R(10,23)]   => [R(109,621)]
+; [R(28,-3)  R(30,-12)]  => [R(-11,6)]
+; [R(-29,21) R(19,-23)]  => [R(-268,483)]
+ratmod: :_rathead mod :_rattail ret
+
+; returns the sign of the rational number R
+; [R] => [-1 | 0 | 1]
+;
+; [R(4,3)] => [1]
+; [R(4,-3)] => [-1]
+; [R(0,10)] => [0]
+; [R(-3,4)] => [-1]
+; [R(-3,-4)] => [1]
+ratsign:
+  dup $RAT push 2 mul push 2 add sub jn _ratsign_zero
+  push 2 mod push 2 mul push 1 sub ret
+_ratsign_zero: pop push 0 ret