spitewaste 0.1.002 → 0.1.007

data/lib/spitewaste/libspw/test.spw

@@ -1,3 +1,6 @@
+import io     ; print, println
+import string ; strcat
+
 assert_eq:
   dup copy 2 sub jz _assert_eq_yes
   push "expected " :print onum

data/lib/spitewaste/libspw/util.spw

@@ -1,24 +1,41 @@
-import syntax
-
-; Calling range() will insert between the top two stack values all of the
-; intervening consecutive elements: [9 10 3 7] -> [9 10 3 4 5 6 7]
+import io     ; println
+import math   ; divmod, pow
+import stack  ; to_a
+import string ; charat, strcat, strindex, strlen
+
+; inserts between the top two stack values the intervening consecutive elements
+; ! TODO: Support step, and negative as well.
+; [I J] => [I I+1 ... J]
+;
+; [2 5] => [2 3 4 5]
+; [0 4] => [0 1 2 3 4]
+; [-2 0] => [-2 -1 0]
+; [-3 3] => [-3 -2 -1 0 1 2 3]
+; [4 4] => [4 5] TODO: bug
 range:
   copy 1 push 1 add swap
   copy 1 copy 1 sub jn range
   pop ret
 
-;;;
-
-die: :println exit
-;;;
+; prints the string at the top of the stack and halts execution
+die!: :println exit
 
+; for stoi and itos
 alpha: push "0123456789abcdefghijklmnopqrstuvwxyz" ret
 
-; string to integer in base b
-stoi: ; [s b]
-  swap push 0 ; tally
-
-_stoi_loop: ; [b s t]
+; converts the string S to an integer in base B (2-36)
+; ! TODO: support prefixes?
+; [S B]
+;
+; ["101010" 2] => [42]
+; ["0777"   8] => [511]
+; ["12345" 10] => [12345]
+; ["123_"  10] => [123]
+; ["123____"  10] => [123000] ; TODO: bug
+; ["dead"  16] => [57005]
+; ["gabe"  17] => [81699]
+stoi: swap push 0 ; accumulator
+_stoi_loop: ; [b s a]
   swap dup jz _stoi_done
   swap copy 2 copy 2
   :strlen push 1 sub :pow
@@ -27,24 +44,24 @@ _stoi_loop: ; [b s t]
   dup jn _stoi_invalid ; found something non-alphanumeric
   mul add swap push 128 div swap
   jump _stoi_loop
-
-_stoi_invalid: pop pop slide 1 swap div ret
-
+_stoi_invalid: pop pop slide 1 swap div ret ; return what we were able to parse
 _stoi_done: swap slide 2 ret
 
-;;;
-
+; creature comforts
 bin:  push  2 :stoi ret
 oct:  push  8 :stoi ret
 to_i: push 10 :stoi ret
 hex:  push 16 :stoi ret
 
-;;;
-
-; integer to string in base b
-itos: ; [i b]
-  swap push 0 ; empty string
-
+; converts the integer N to a string in base B
+; [N B]
+;
+; [42 2] => ["101010"]
+; [511 8] => ["777"]
+; [12345 10] => ["12345"]
+; [57005 16] => ["dead"]
+; [81699 17] => ["gabe"]
+itos: swap push 0 ; accumulator
 _itos_loop:
   swap dup jz _itos_done
   swap copy 1 copy 3 mod
@@ -52,47 +69,86 @@ _itos_loop:
   swap :strcat
   swap copy 2 div
   swap jump _itos_loop
-
 _itos_done: swap slide 2 ret
 
-to_s: push 10 :itos ret
-
-;;;
-
-digits: ; [ n d ]
+; creature comforts
+to_bin: push  2 :itos ret
+to_oct: push  8 :itos ret
+to_s:   push 10 :itos ret
+to_hex: push 16 :itos ret
+
+; puts the digits of N in base B on the stack as a pseudo-array
+; [N B] => [Dn ...D0 n]
+;
+; [42 2] => [1 0 1 0 1 0 6]
+; [12345 10] => [1 2 3 4 5 5]
+; [255 16] => [15 15 2]
+; [256 16] => [1 0 0 3]
+digits:
   copy 1 jz _digits_zero ; special case
   push -1 swap store
   push -1 swap ; sentinel value
-
 _digits_loop:
   dup jz _digits_done
   push -1 load :divmod
   swap jump _digits_loop
-
 _digits_zero: dup div ret
-
 _digits_done: push 1 sub :to_a ret
 
-; increment value at heap address n
+; increments the value at heap address N TODO: make heap effects test-able ?
+; [N]
 inc: dup load $++ store ret
 
-; decrement value at heap address n
+; decrements the value at heap address N
+; [N]
 dec: dup load $-- store ret
 
-;;;
-
+; pops A and B and pushes 1 if they're equal, 0 otherwise
+; [A B] => [A == B]
+;
+; [1 2] => [0]
+; [3 3] => [1]
+; [-4 4] => [0]
+; ['A' 65] => [1]
+; ['B' 65] => [0]
 eq: sub jz _eq_yes push 0 ret
 _eq_yes: push 1 ret
 
+; pops A and B and pushes 1 if they're not equal, 0 otherwise
+; [A B] => [A != B]
+;
+; [1 2] => [1]
+; [3 3] => [0]
+; [-4 4] => [1]
+; ['A' 65] => [0]
+; ['B' 65] => [1]
 neq: sub jz _neq_no push 1 ret
 _neq_no: push 0 ret
 
-gt: swap
+; pops A and B and pushes 1 if A is greater than B, 0 otherwise
+; [A B] => [A > B]
+;
+; [4 3] => [1]
+; [3 4] => [0]
+; [2 2] => [0]
+; [2 1] => [1]
+gt: swap ; intentionally flow into lt
+
+; pops A and B and pushes 1 if A is less than than B, 0 otherwise
+; [A B] => [A < B]
+;
+; [3 4] => [1]
+; [4 3] => [0]
+; [2 2] => [0]
+; [1 2] => [1]
 lt: sub jn _lt_yes push 0 ret
 _lt_yes: push 1 ret
 
-;;;
-
-heap_search:
+; Though extremely rare, it's possible that we know a particular value is
+; stored in the heap at some key, just not which one. This subroutine takes
+; 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
   slide 1 ret

data/lib/spitewaste/parsers/spitewaste.rb

@@ -19,7 +19,7 @@ module Spitewaste
       @symbol_file = options['symbol_file']
 
       preprocess!
-      eliminate_dead_code!
+      eliminate_dead_code! unless options[:keep_dead_code]
     end
 
     def parse
@@ -57,6 +57,7 @@ module Spitewaste
     private
 
     def preprocess!
+      @src.prepend "import syntax\n"
       resolve_imports
       seed_prng if @seen.include? 'random'
       resolve_strings
@@ -94,7 +95,7 @@ module Spitewaste
     end
 
     def resolve_strings
-      @src.gsub!(/"([^"]+)"/m) {
+      @src.gsub!(/"([^"]*)"/m) {
         [0, *$1.reverse.bytes] * ' push ' + ' :strpack'
       }
     end
@@ -118,31 +119,36 @@ module Spitewaste
 
     def fucktionalize
       # Iteratively remove pseudo-fp calls until we can't to allow nesting.
-      1 while @src.gsub!(/(#{FUCKTIONAL.keys * ?|})\s*\((.+)\)/) do
+      1 while @src.gsub!(/(#{FUCKTIONAL.keys * ?|})\s*\((.+?)\)/m) do
         FUCKTIONAL[$1] % [gensym, $2]
       end
     end
 
     def propagate_macros
-      @src.gsub!(/(\$\S+)\s*=\s*(.+)/) { @macros[$1] = $2; '' }
-      @src.gsub!(/(\$\S+)/) { @macros[$1] || raise("no macro '#{$1}'") }
-
-      # @src.gsub!(/(\$[^(]+)\s*\((.+)\)\s*{(.+)}/m) { @macros[$1] = $2, $3; '' }
-      # @src.gsub!(/(\$[^(]+)\((.+?)\)/m) {
-      #   unless (params, body = @macros[$1])
-      #     raise "no macro function '#{$1}'"
-      #   end
-
-      #   params = params.split(?,).map &:strip
-      #   args = $2.split ?,
-      #   body.gsub /\b(#{params * ?|})\b/, params.zip(args).to_h
-      # }
+      # Macros are write-once, allowing user code to customize the special
+      # values that get used to drive certain behavior in the standard library.
+
+      parse = -> s { s.split(?,).map &:strip }
+
+      # Macro "functions" get handled first.
+      @src.gsub!(/(\$\S+?)\(([^)]+)\)\s*{(.+?)}/m) {
+        @macros[$1] ||= [$2, $3]; ''
+      }
+      @src.gsub!(/(\$\S+?)\(([^)]+)\)/) {
+        params, body = @macros[$1]
+        raise "no macro function '#$1'" unless body
+        map = parse[params].zip(parse[$2]).to_h
+        body.gsub(/`(.+?)`/) { map[$1] }
+      }
+
+      @src.gsub!(/(\$\S+)\s*=\s*(.+)/) { @macros[$1] ||= $2; '' }
+      @src.gsub!(/(\$\S+)/) { @macros[$1] || raise("no macro '#$1'") }
     end
 
     def eliminate_dead_code!
       tokens = @src.split
 
-      # We need an entry point from which to begin determining which routines
+      # We need an entry point whence to begin determining which routines
       # are never invoked, but Whitespace programs aren't required to start
       # with a label. Here, we add an implcit "main" to the beginning of the
       # source unless it already contains an explicit entry point. TODO: better?

data/lib/spitewaste/version.rb

@@ -1,3 +1,3 @@
 module Spitewaste
-  VERSION = '0.1.002'
+  VERSION = '0.1.007'
 end

data/spitewaste.gemspec

@@ -1,17 +1,22 @@
 require_relative 'lib/spitewaste/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'spitewaste'
-  spec.version       = Spitewaste::VERSION
-  spec.author        = 'Collided Scope (collidedscope)'
+Gem::Specification.new do |s|
+  s.name          = 'spitewaste'
+  s.version       = Spitewaste::VERSION
+  s.author        = 'Collided Scope (collidedscope)'
 
-  spec.summary       = 'Make programming in Whitespace even better.'
-  spec.description   = 'Spitewaste is a collection of tools that makes it almost too easy to write Whitespace.'
-  spec.homepage      = 'https://github.com/collidedscope/spitewaste'
-  spec.license       = 'WTFPL'
+  s.summary       = 'Make programming in Whitespace even better.'
+  s.description   = 'Spitewaste is a collection of tools that makes it almost too easy to read and write Whitespace programs.'
+  s.homepage      = 'https://github.com/collidedscope/spitewaste'
+  s.license       = 'WTFPL'
 
-  spec.files         = `git ls-files`.split.reject { |f| f[/^test/] }
-  spec.bindir        = 'bin'
-  spec.executables   = ['spw']
-  spec.require_paths = ['lib']
+  s.add_dependency 'rake', '~> 13.0.1'
+  s.add_dependency 'minitest', '~> 5.14.2'
+  s.add_dependency 'thor', '~> 1.0.1'
+  s.add_dependency 'oily_png', '~> 1.2.1'
+
+  s.files         = `git ls-files`.split.reject { |f| f[/^(test|demo)/] }
+  s.bindir        = 'bin'
+  s.executables   = ['spw']
+  s.require_paths = ['lib']
 end

metadata

@@ -1,17 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: spitewaste
 version: !ruby/object:Gem::Version
-  version: 0.1.002
+  version: 0.1.007
 platform: ruby
 authors:
 - Collided Scope (collidedscope)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
-dependencies: []
+date: 2020-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: Spitewaste is a collection of tools that makes it almost too easy to
-  write Whitespace.
+  read and write Whitespace programs.
 email:
 executables:
 - spw
@@ -24,16 +80,13 @@ files:
 - Rakefile
 - TUTORIAL.md
 - bin/spw
-- demo/factorial-nicespace.png
-- demo/factorial.asm
-- demo/factorial.png
-- demo/factorial.wsa
 - lib/spitewaste.rb
 - lib/spitewaste/assembler.rb
 - lib/spitewaste/cli.rb
 - lib/spitewaste/cli/asm.rb
 - lib/spitewaste/cli/compile.rb
 - lib/spitewaste/cli/convert.rb
+- lib/spitewaste/cli/docs.rb
 - lib/spitewaste/cli/exec.rb
 - lib/spitewaste/cli/image.rb
 - lib/spitewaste/emitter.rb
@@ -47,11 +100,13 @@ files:
 - lib/spitewaste/libspw/array.spw
 - lib/spitewaste/libspw/bits.spw
 - lib/spitewaste/libspw/case.spw
+- lib/spitewaste/libspw/docs.json
 - lib/spitewaste/libspw/fun.spw
 - lib/spitewaste/libspw/io.spw
 - lib/spitewaste/libspw/math.spw
 - lib/spitewaste/libspw/prime.spw
 - lib/spitewaste/libspw/random.spw
+- lib/spitewaste/libspw/rational.spw
 - lib/spitewaste/libspw/stack.spw
 - lib/spitewaste/libspw/string.spw
 - lib/spitewaste/libspw/syntax.spw

data/demo/factorial.asm

@@ -1,47 +0,0 @@
-label 0
-push 6
-call 1
-onum
-exit
-label 1
-push 1
-swap
-call 4
-dup
-dup
-dup
-push 2
-sub
-jn 3
-pop
-push -9
-swap
-push 1
-sub
-store
-label 2
-mul
-push -9
-dup
-load
-push 1
-sub
-dup
-jz 3
-store
-jump 2
-label 3
-pop
-pop
-ret
-label 4
-copy 1
-push 1
-add
-swap
-copy 1
-copy 1
-sub
-jn 4
-pop
-ret