base-lang 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352641028b34da47dec624f8cb3e135e6c336e47f854931649104b0c9a29629c
-  data.tar.gz: 490c1fa4fd25ec278bf2dd12e67f0cecc1b53da7a3eee848daee81121ddbff4e
+  metadata.gz: 479899f8818cfda3f541a9cbfda0ed3251359f660a527255054f8263c77152d8
+  data.tar.gz: 047b1a3051f3e1d4a63ab30c9c8d92c1800a0dd957ece661a1cee928a45fb630
 SHA512:
-  metadata.gz: b7d1e64864df4c093c56c70c2d212013c926082e213f8aad86ead4120e2f3cb0da5df3153402fa0a70da5716723a71163a1172a23a6a577cee4e23e5337725ed
-  data.tar.gz: 054abcc979edead6e60520bba2926a7614899fe73e349f81418ac87b617829de6d196b98c85b7f8156fb27b727a3fc45c0641440a5d8cdbc1667b133be145d54
+  metadata.gz: 839ea8f044ef774895405c57dda3698bedb5e71a4922277d6ceefe1e1de597efd73e9989d8748159d371d5e42d3d20cc25cfb6ffe922242e6ee85c0f9e905a4b
+  data.tar.gz: 837e462241f9238ca3fb7f051976f925aef26e3087bcc0bcbbf7c0a5cc5c6e7072a29bf6653f6516efcb4ab89ad3b91d9e342ec1883c160fc186a05ad9241b37

data/README.md

@@ -49,28 +49,29 @@ Run it:
 
 All instructions take no arguments except the `push` instruction which takes the value to push to the stack.
 
-Values may be an integer, a single character in double quotes, a label, or the special text `ip` which refers to
-the current instruction pointer.
+Values may be an integer, a single character in double quotes which is interpreted as its unicode number, a label representing a memory location, or the special text `ip` which refers to the current instruction pointer.
 
-Signed integers of arbitrary size can be used.  Memory locations start at 0 and by default to up to 1MB (1048575).
+Signed integers of arbitrary size can be used.  Memory locations start at 0 and by default go up to 1MB.
 
 operation | op code | stack impact | description
 -|-|-|-
 debug | 0 | | enters the debugger
 push (value or label) | 1, value | + | pushes the value onto the stack
 discard | 2 | - | discards the top entry on the stack
-duplicate | 3 | + | duplicates the top entry on the stack
+duplicate | 3 | -++ | pushes two copies of the top entry on the stack
 write | 4 | -- | writes the second entry on the stack to the memory location at the top entry on the stack
 read | 5 | -+ | reads from the memory location on the stack and puts the result on the stack
 add | 6 | --+ | adds the top two entries on the stack and puts the result on the stack
 subtract | 7 | --+ | subtracts the top entry on the stack from the second entry on the stack and puts the result on the stack
-jump | 8 | - | jumps to the location indicated by the top entry on the stack
-bltz | 9 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is less than 0
-bgtz | 10 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is greater than 0
-betz | 11 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is equal to 0
-bnetz | 12 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is not equal to 0
-out | 13 | - | outputs the top entry on the stack to stdout, interpreted as a unicode character
-halt | 13 | | halts the program
+multiply | 8 | --+ | multiplies the top two entries on the stack and puts the result on the stack
+divide | 9 | --+ | divides the top entry on the stack from the second entry on the stack and puts the integer result on the stack
+jump | 10 | - | jumps to the location indicated by the top entry on the stack
+bltz | 11 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is less than 0
+bgtz | 12 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is greater than 0
+betz | 13 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is equal to 0
+bnetz | 14 | -- | jumps to the location indicated by the top entry on the stack if the second entry on the stack is not equal to 0
+out | 15 | - | outputs the top entry on the stack to stdout, interpreted as a unicode character
+halt | 16 | | halts the program
 
 ## Compiler
 
@@ -82,8 +83,8 @@ You can use labels to mark a place in the code:
 
     # infinite loop
     .marker
-    push marker
-    jump
+      push marker
+      jump
 
 `.main` is a special label. If specified, code execution will start at this point.
 
@@ -99,11 +100,11 @@ The data can also be a string, which is interpreted as a list of bytes, or a mix
 
 Simple macros can be defined as a comma-separated list of operations (or other macros, as long as they don't recurse):
 
-   macro increment push 1, add
-
-   push "A"
-   increment
-   out # outputs a "B"
+    macro increment push 1, add
+ 
+    push "A"
+    increment
+    out # outputs a "B"
 
 You'll need to define a macro before you use it in your file.
 
@@ -120,5 +121,5 @@ When in the debugger, type `h` for help.
 
 MIT licence.
 
-Feel free to contribute!  It's intentionally simple, so the intention isn't to add any more operations than what is
-there.
+Feel free to contribute!  It's intentionally simple, and as a result it's unlikely we'll add more instructions or syntactic
+sugar than what's already there.

data/bin/base

@@ -5,8 +5,13 @@ require_relative "../lib/base"
 
 options = {}
 OptionParser.new do |parser|
+  parser.version = Base::VERSION
   parser.banner = "Usage: base [options] filename.base"
 
+  parser.on("-b", "--bytecode", "Input file is compiled bytecode") do
+    options[:bytecode] = true
+  end
+
   parser.on("-d", "--debug", "Start debugger immediately") do
     options[:debug] = true
   end
@@ -19,6 +24,11 @@ OptionParser.new do |parser|
     puts parser
     exit 1
   end
+
+  parser.on_tail("--version", "Show version") do
+    puts "base #{Base::VERSION}"
+    exit
+  end
 end.parse!
 
 if ARGV.length != 1
@@ -26,11 +36,26 @@ if ARGV.length != 1
   exit 1
 end
 
+def file_or_stdin(file)
+  if file == "-"
+    $stdin.read
+  else
+    File.read(file)
+  end
+end
+
 begin
-  program = Base::Compiler.new.compile(ARGV[0])
+  program = Base::Program.new
+
+  if options[:bytecode]
+    program.decode(file_or_stdin(ARGV[0]))
+  else
+    compiler = Base::Compiler.new(program)
+    compiler.compile(file_or_stdin(ARGV[0]))
+  end
 
   if options[:compile]
-    puts program.join(",")
+    print program.encode
   else
     Base::VM.new(program, debug: options[:debug] || false).run
   end

data/lib/base/compiler.rb

@@ -2,23 +2,26 @@ module Base
   class Compiler
     Error = Class.new(StandardError)
 
-    def initialize
+    def initialize(program)
+      @program = program
       @parsing = []
-      @memory = []
       @labels = {}
       @macros = {}
     end
 
-    def compile(file)
-      lines = File.read(file).split("\n")
+    def compile(data)
+      lines = data.split("\n")
       parse(lines)
-
-      main = @labels["main"] || 0
-      [main] + @memory
+      @program.start_location = @labels["main"] || 0
+      true
     end
 
     private
 
+    def memory
+      @program.memory
+    end
+
     def parse(lines)
       lines.each.with_index do |line, index|
         begin
@@ -30,7 +33,7 @@ module Base
 
       @parsing.each do |index, line_number|
         begin
-          @memory[index] = parse_arg(@memory[index], index)
+          memory[index] = parse_arg(memory[index], index)
         rescue Error => e
           raise Error, "#{e.message} on line #{line_number}"
         end
@@ -46,12 +49,12 @@ module Base
       when /\A\.([a-z_][a-z0-9_]*)(?:\s+(.+))?\z/i
         raise Error, "label already defined" if @labels[$1]
         raise Error, "can't use 'ip' as a label name" if $1 == 'ip'
-        @labels[$1] = @memory.length
-        @memory += parse_static($2) if $2
+        @labels[$1] = memory.length
+        memory.concat(parse_static($2)) if $2
 
       when /\Apush\s+(.+)\z/
-        @memory += [VM::COMMANDS.index("push"), $1]
-        @parsing << [@memory.length - 1, number]
+        memory.concat [VM::COMMANDS.index("push"), $1]
+        @parsing << [memory.length - 1, number]
 
       when /\Amacro\s+(\S+)\s+(.+)/
         raise Error, "label already defined" if @macros[$1]
@@ -60,7 +63,7 @@ module Base
 
       else
         if op_code = VM::COMMANDS.index(line)
-          @memory << op_code
+          memory << op_code
         elsif macro = @macros[line]
           if macro_entry.include?(macro)
             raise Error, "recursive call to macro #{macro}"

data/lib/base/program.rb

@@ -0,0 +1,49 @@
+module Base
+  class Program
+    DecodeError = Class.new(StandardError)
+
+    attr_reader :memory
+    attr_accessor :start_location
+
+    def initialize
+      @start_location = 0
+      @memory = []
+    end
+
+    def encode
+      bytecode = ['B'.ord, 'A'.ord, 'S'.ord, 'E'.ord, 2, start_location] + memory
+
+      bytecode.flat_map do |value|
+        bytes = []
+        while value >= 128
+          bytes << ((value & 127) | 128).chr
+          value >>= 7
+        end
+        bytes + [value.chr]
+      end.join
+    end
+
+    def decode(data)
+      raise DecodeError, "invalid header signature" unless data[0..4] == "BASE\2"
+
+      bytecode = []
+      carry = 0
+      value = 0
+      data[5..-1].each_byte do |byte|
+        if byte & 128 == 128
+          value |= (byte & 127) << carry
+          carry += 7
+        else
+          bytecode << ((byte << carry) | value)
+          carry = value = 0
+        end
+      end
+
+      raise DecodeError, "unexpected end of bytecode" unless carry == 0
+
+      @start_location = bytecode[0]
+      @memory = bytecode[1..-1]
+      true
+    end
+  end
+end

data/lib/base/version.rb

@@ -0,0 +1,3 @@
+module Base
+  VERSION = "0.2.0"
+end

data/lib/base/vm.rb

@@ -6,11 +6,11 @@ module Base
 
     attr_reader :ip, :stack, :memory
 
-    COMMANDS = %w(debug push discard duplicate write read add subtract jump bltz bgtz betz bnetz out halt)
+    COMMANDS = %w(debug push discard duplicate write read add subtract multiply divide jump bltz bgtz betz bnetz out halt)
 
     def initialize(program, debug: false)
-      @ip = program.shift
-      @memory = program
+      @ip = program.start_location
+      @memory = program.memory
       @debug = debug
       @stack = Stack.new
     end
@@ -71,6 +71,15 @@ module Base
         a = stack.pop
         b = stack.pop
         stack.push(b - a)
+      when "multiply"
+        a = stack.pop
+        b = stack.pop
+        stack.push(b * a)
+      when "divide"
+        a = stack.pop
+        b = stack.pop
+        raise Error, "divide by 0" if a == 0
+        stack.push(b / a)
 
       when "jump"
         @ip = stack.pop - 1

data/lib/base.rb

@@ -1,3 +1,5 @@
+require_relative 'base/version'
+require_relative 'base/program'
 require_relative 'base/stack'
 require_relative 'base/compiler'
 require_relative 'base/vm'

data/sample/alphabet.base

@@ -0,0 +1,30 @@
+.main
+  push "A"
+
+.loop
+  # Print letter to the screen
+  duplicate
+  out
+
+  # Check whether we've reached Z yet
+  duplicate
+  push "Z"
+  subtract
+
+  # If we have, we're done
+  push done
+  betz
+
+  # Advance to the next letter and loop
+  push 1
+  add
+  push loop
+  jump
+
+.done
+  # Program ends
+  discard
+  push "\n"
+  out
+  halt
+

data/sample/int_to_string.base

@@ -0,0 +1,95 @@
+.fn_print_number
+    # number_buffer_ptr points to number_buffer
+    push number_buffer
+    push number_buffer_ptr
+    write
+
+  .dec_next_digit
+    duplicate
+
+    # divide by 10
+    push 10
+    divide
+
+    # write the result for next loop
+    duplicate
+    push next_number
+    write
+
+    # find the modulo
+    push 10
+    multiply
+    subtract
+
+    # convert to ASCII
+    push "0"
+    add
+    push number_buffer_ptr
+    read
+    write
+
+    # next_number becomes our new number
+    push next_number
+    read
+
+    # increment the pointer by 1
+    push number_buffer_ptr
+    read
+    push 1
+    add
+    push number_buffer_ptr
+    write
+
+    # process the next digit if we're not at 0
+    duplicate
+    push dec_next_digit
+    bgtz
+
+  .print_next_digit
+    # move the ptr back 1
+    push number_buffer_ptr
+    read
+    push 1
+    subtract
+    duplicate
+    push number_buffer_ptr
+    write
+
+    # read the ptr and print it out
+    read
+    out
+
+    # if we're not back at the start yet, loop
+    push number_buffer_ptr
+    read
+    push number_buffer
+    subtract
+    push print_next_digit
+    bgtz
+
+    # all done :)
+    discard
+
+    # return ip is on stack
+    jump
+
+
+.main
+  # set return address
+  push ip
+  push 10
+  add
+
+  # call function
+  push 472
+  push fn_print_number
+  jump
+
+  # output newline
+  push "\n"
+  out
+  halt
+
+.next_number 0
+.number_buffer_ptr 0
+.number_buffer 0 # following memory used for unsized buffer

data/sample/simple.base

@@ -0,0 +1,33 @@
+.counter 10
+
+.main
+  push "H"
+  out
+  push "e"
+  out
+  push "l"
+  out
+  push "l"
+  out
+  push "o"
+  out
+  push "\n"
+  out
+
+  # subtract 1 from value at label .counter
+  push counter
+  read
+  push 1
+  subtract
+
+  # write new value back to .counter, and keep the value in the stack
+  duplicate
+  push counter
+  write
+
+  # jump back to the start if we're not at 0 yet
+  push main
+  bgtz
+
+  # done
+  halt

data/sample/subroutine_macro.base

@@ -0,0 +1,60 @@
+.jsr_location 0
+macro jsr push jsr_location, write, push ip, push 9, add, push jsr_location, read, jump
+
+.main
+push 10 # times around the loop
+push counter
+write
+
+.loop
+push message
+push index
+write
+
+push subroutine
+jsr
+
+.inner
+push index
+read
+read
+duplicate
+push done
+betz
+out
+push index
+read
+push 1
+add
+push index
+write
+push inner
+jump
+
+.done
+discard
+push counter
+read
+push 1
+subtract
+duplicate
+push counter
+write
+push loop
+bgtz
+
+halt
+
+.subroutine
+push "h"
+out
+push "i"
+out
+push "\n"
+out
+jump
+
+
+.counter 0
+.index 0
+.message "Hello!\n", 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: base-lang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mog Nesbitt
@@ -22,8 +22,14 @@ files:
 - lib/base.rb
 - lib/base/compiler.rb
 - lib/base/debugger.rb
+- lib/base/program.rb
 - lib/base/stack.rb
+- lib/base/version.rb
 - lib/base/vm.rb
+- sample/alphabet.base
+- sample/int_to_string.base
+- sample/simple.base
+- sample/subroutine_macro.base
 homepage: https://github.com/mogest/base-lang
 licenses:
 - MIT