spitewaste 0.1.001 → 0.1.002

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2124fde880a571c835efe1e74e397a0dea698786c69a62852c4ad8bd7e3ffe0
-  data.tar.gz: 0d40e036ca0d7f51ea617be600274088160a8159dc7e04f87af8429d29154fc4
+  metadata.gz: b185ba760bbddf427962b292046de239f29b6a13964c7182eea2da1a2bcc0d10
+  data.tar.gz: 36991071a4e6bc98134d235a340dbaf90f082020ffc2e2bd8a67b83970b86e68
 SHA512:
-  metadata.gz: 8ca420c6896dba0743f70f27a6558178bfe6201fd821afd45594e11796a975ebd042eb6d65fda6b20221f40831d183e417aca2e7dd7c19edff16c4e99ea15135
-  data.tar.gz: 1699a938795047284088697c7c3d7f444e626b033f888080618d2d7350635a69dab37b63455cd6544740e747b2665f30df5c15d14c64bdb1a2f2755387cd4ff5
+  metadata.gz: add4543eead4effe21e7eab4ff3bd18fc6f544889368c14b2b178953adddbb1f53913dc737ebcb95ce5f49ee144c81e1916072e2c9e72752c5cb9aab5d0313d5
+  data.tar.gz: 1249b0e70507839d31c15f7fb29d084eb7b572dea51f5b398416e871b57e5d3eb621e2ed756cd5871a28a8a7ebd72bc59f1b65a8b884a441dc9de77a3e254271

data/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -1,7 +1,4 @@
-<p align="center">
-<img src="abc" /><br >
-"Code should be invisible." — someone, surely
-</p>
+<p align="center">"Code should be invisible." — someone, surely</p>
 
 # Spitewaste
 
@@ -21,7 +18,7 @@ Spitewaste is the pseudo-assembly language referred to throughout this document,
 
 **spw** is a command-line utility whose primary purpose is to "lower" Spitewaste programs to Whitespace for execution by some external interpreter, but it's capable of several (perhaps too many) other transformations; see `spw help convert` for further details. In addition to losslessly converting between various representations, spw can generate pretty pictures of Whitespace code syntax-highlighted in your favorite color scheme via `spw image`.
 
-Spitewaste is not [a Whitespace interpreter](collidedscope/spiceweight), but `spw exec` will convert its input to something your interpreter of choice should understand and ferry it along. Finally, `spw compile` will blindly translate Whitespace instructions to functionally equivalent C++ code and feed that into a compiler; the results aren't spectacular (compilers loathe `goto`), but it's fun to pretend Whitespace is a compiled language.
+Spitewaste is not [a Whitespace interpreter](../../../spiceweight), but `spw exec` will convert its input to something your interpreter of choice should understand and ferry it along. Finally, `spw compile` will blindly translate Whitespace instructions to functionally equivalent C++ code and feed that into a compiler; the results aren't spectacular (compilers loathe `goto`), but it's fun to pretend Whitespace is a compiled language.
 
 ## Where <sub>can I get it?</sub>
 

data/Rakefile

@@ -1,10 +1,64 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'json'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.libs << 'lib'
   t.test_files = FileList['test/*_test.rb']
 end
 
-task :default => :test
+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
+  File.open('docs.json', ?w) { |f| JSON.dump all_docs, f }
+end
+
+def extract_docs path
+  docs = {}
+  buffer = ''
+
+  File.open(path).each_line do |line|
+    if line.strip.empty?
+      buffer.clear
+    elsif line[/^([^_]\S+):/]
+      docs[$1] = parse_doc buffer.dup unless buffer.empty?
+      buffer.clear
+    elsif line[/^;/]
+      buffer << line
+    end
+  end
+
+  docs
+end
+
+StackRx = /(?<=\[)[^\]]+(?=\])/
+
+def strpack s
+  s.bytes.zip(0..).sum { |b, e| b * 128 ** e }
+end
+
+def parse_stack s
+  s.split.map { Integer(_1) rescue strpack _1.delete %('") }
+end
+
+def parse_doc doc
+  # strip comment character and any implementation details
+  doc.gsub!(/; */, '').gsub!(/^!.+\n/, '')
+
+  head, specs = doc.split "\n\n"
+  *desc, effect = head.split ?\n
+  desc *= ?\n
+
+  cases = []
+  specs.scan(StackRx).each_slice 2 do |spec|
+    cases << spec.map { parse_stack _1 }
+  end if specs
+
+  {full: doc, desc: desc, effect: effect, cases: cases}
+end
+
+task default: :test

data/TUTORIAL.md

@@ -120,6 +120,6 @@ A standard library! Writing a Whitespace program from scratch can be a daunting
 
 ### Strings
 
-Pretty much every program needs strings, and Spitewaste has 'em! But how? Well, a string is ultimately just a sequence of bytes, and we can use the power of exponents to smush multiple numbers into a single value. If we had the numbers 3, 9, and 4, we could easily encode them as a single base-10 number: 3 × 10<sup>2</sup> + 9 × 10<sup>1</sup> + 4 × 10<sup>0</sup>. Strings in Spitewaste are similarly encoded, except backwards (as an implementation detail) and in base-128 rather than decimal.
+Pretty much every program needs strings, and Spitewaste has 'em! But how? Well, a string is ultimately just a sequence of bytes, and we can use the power of exponents to smush multiple numbers into a single value. If we had the numbers 3, 9, and 4, we could easily encode them as a single base-10 number: 3 × 10<sup>2</sup> + 9 × 10<sup>1</sup> + 4 × 10<sup>0</sup> = 394. Strings in Spitewaste are similarly encoded, except backwards (as an implementation detail) and in base-128 rather than decimal.
 
 When you say <code>push "ABC"</code>, the assembler transforms it into <code>push 1106241</code>, the value of: 67 ('C') × 128<sup>2</sup> + 66 × 128<sup>1</sup> + 65 × 128<sup>0</sup>. Whitespace interpreters SHOULD (and many do) support arbitrarily large integers, so we don't have to worry about these representations not fitting into 64 bits. Once we're able to pass strings around as individual values, a plethora of possibilities opens up, and the standard library contains many string functions to reflect this.

data/lib/spitewaste/emitters/assembly.rb

@@ -1,7 +1,7 @@
 module Spitewaste
   class AssemblyEmitter < Emitter
     def emit io:
-      io.puts instructions.map { (_1 * ' ').rstrip }
+      io.puts instructions.map { |i| (i * ' ').rstrip }
     end
   end
 end

data/lib/spitewaste/libspw/math.spw

@@ -1,52 +1,55 @@
-import util (range) ; for factorial
-
-; [b e] => [b^e]
-pow:
-  push 1 swap
-
+import util ; range for factorial, inc for ilog
+
+; returns B raised to the power E
+; [B E] => [B**E]
+;
+; [0 0] => [1],   [0 9] => [0],   [9 0] => [1]
+; [3 2] => [9],   [2 3] => [8],   [7 4] => [2401]
+pow: push 1 swap
 _pow_loop: ; [b n e]
   dup jz _pow_done
   swap copy 2 mul ; [b e n*b]
   swap push 1 sub jump _pow_loop
+_pow_done: swap slide 2 ret
 
-_pow_done: ; b n e
-  pop slide 1 ret
-
-;;;
-
-; [n] => [n!]
+; returns the product of the integers from 1 to N, with 0! defined to be 1
+; [N] => [N!]
+;
+; [0] => [1],   [1] => [1],     [2] => [2]
+; [3] => [6],   [5] => [120],   [10] => [3628800]
 factorial: push 0 swap :range
 _fac_loop: swap dup jz _fac_done mul jump _fac_loop
-_fac_done: pop ret
 
-;;;
+_fac_done: pop ret
 
-isqrt: ; [n] -> [isqrt(n)]
-  dup push 2 sub jn _isqrt_done
-  dup push 4 div :isqrt push 2 mul
-  dup push 1 add
-  copy 2 copy 1 dup mul sub jn _isqrt_cleanup
-  swap
-_isqrt_cleanup: swap slide 2
+; returns the integer square root of N
+; [N] => [floor(sqrt(N))]
+;
+; [0] => [0], [1] => [1], [2] => [1], [3] => [1]
+; [4] => [2], [8] => [2], [9] => [3], [99] => [9], [100] => [10]
+isqrt:
+  dup push 2 sub jn _isqrt_done ; nothing to do for 0 and 1
+  dup push 2 div
+_isqrt_loop:
+  copy 1 copy 1 div copy 1 add push 2 div ; new guess is (n / g + g) / 2
+  dup copy 2 sub jn _isqrt_update
+  swap slide 2
 _isqrt_done: ret
-
-;;;
-
-; intger logarithm ; [a b] => [log(a, b)]
-; ! clobbers heap address -1 TODO: maybe not necessary?
-ilog:
-  push -1 push 0 store ; tally
-
-_ilog_loop: ; a b
+_isqrt_update: slide 1 jump _isqrt_loop
+
+; returns the intger logarithm of N in base B
+; ! clobbers heap address -1 TODO: maybe unnecessarily?
+; [N B] => [logB(N)]
+;
+; [15 4] => [1], [16 4] => [2]
+; [100 10] => [2]
+; [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_done: ; a b t
-  push -1 load slide 2 ret
-
-;;;
+  copy 1 div swap jump _ilog_loop
+_ilog_done: push -1 load slide 2 ret
 
 ; greatest common divisor
 gcd: ; [a  b]

data/lib/spitewaste/parsers/fucktional.rb

@@ -66,6 +66,7 @@ SPW
 
     'minby' => 'maxby (%2$s push -1 mul)',
     'each' => 'dup times (dup call roll %2$s push 1 sub) pop',
+    'count' => 'select (%2$s) dup call nslide',
     'select' => generate_filter_spw('select', 0, 1),
     'reject' => generate_filter_spw('reject', 1, 0),
   }

data/lib/spitewaste/parsers/spitewaste.rb

@@ -100,7 +100,7 @@ module Spitewaste
     end
 
     def remove_comments
-      @src.gsub!(/;.+/, '')
+      @src.gsub!(/;.*/, '')
     end
 
     def add_sugar
@@ -109,7 +109,7 @@ module Spitewaste
       # character literals
       @src.gsub!(/'(.)'/) { $1.ord }
       # quick push (`push 1,2,3` desugars to individual pushes)
-      @src.gsub!(/push \S+/) { _1.split(?,) * ' push ' }
+      @src.gsub!(/push \S+/) { |m| m.split(?,) * ' push ' }
     end
 
     def gensym

data/lib/spitewaste/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spitewaste
 version: !ruby/object:Gem::Version
-  version: 0.1.001
+  version: 0.1.002
 platform: ruby
 authors:
 - Collided Scope (collidedscope)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies: []
 description: Spitewaste is a collection of tools that makes it almost too easy to
   write Whitespace.
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - TUTORIAL.md