yarbf 0.0.1 → 0.0.2

checksums.yaml

@@ -1,4 +1,7 @@
 ---
+SHA1:
+  metadata.gz: c50a097c05b4592a3af56541e41e1ce016f8aaef
+  data.tar.gz: de0acce92f5167ce6fd1c3597bd925010205407b
 SHA512:
-  metadata.gz: 22f7d3768f1b31130f5fa1452d52dc98b0a3236b95c4f1e072c10ec8be3f2f9ec194ec195bdb837bec66e1335336e00e692eedcea4233847f327a33576ffd4e6
-  data.tar.gz: cc4df3daa804a1ee6f9e555b04d6f1d550d66b782ae02173652e8990a0114904b1115c30b2e5be2d8a1d1c786ac3506b6271116c08594a805135e8f1ebf3a33e
+  metadata.gz: bf7026eaece5ff3bdc25cfcd1d7293208ed6ede199807103b931da68bfbbeb57429e34d46b41fb62fdf9f164377f79d4f191eab144b8258efd466eb415d941ef
+  data.tar.gz: 8289e0617d9b293a03d1e9971ebeaea728a250cc5fd6f39de7ffb65e220b5cdc3a69daf39cfe6fe3c7f03916261c6e4e63c81150383b8d1b0a499d35922e1119

data/bin/yarbf

@@ -1,6 +1,60 @@
 #!/usr/bin/env ruby
 
+# for parsing command line arguments
+require 'optparse'
+
 require 'yarbf'
 
-interpreter = BfInterpreter.new
+# set default values
+options = Hash.new
+options[:debug]       = false
+options[:wrap_around] = false
+options[:cell_size]   = 8
+
+parser = OptionParser.new do |opts|
+  opts.banner = 'yarbf - Yet another Brainfuck interpreter in Ruby'
+  opts.separator ''
+  opts.separator 'Usage: yarbf [options] <source>'
+  opts.separator ''
+  opts.separator 'Options:'
+
+  # debug
+  opts.on('-d', '--debug', 'Use debug mode') { options[:debug] = true }
+
+  # wrap around
+  opts.on('-w', '--wrap', 'Enable wrap around') { options[:wrap_around] = true }
+
+  # cell size
+  opts.on('-s', '--size SIZE', OptionParser::DecimalInteger,
+          'Set cell size') { |size| options[:cell_size] = size }
+
+  # version
+  opts.on('-V', '--version', 'show version and exit') do
+    puts 'yarbf 0.0.1'
+    exit
+  end
+
+  # help
+  opts.on('-h', '--help', 'Show this message and exit') do
+    puts opts
+    exit
+  end
+
+  opts.separator ''
+end
+
+# do parse
+begin
+  parser.parse!
+rescue OptionParser::ParseError => e
+  STDERR.puts $0 + ': ' + e.to_s
+  exit false
+end
+
+if ARGV[0] == nil
+  STDERR.puts $0 + ': no source file specified'
+  exit false
+end
+
+interpreter = BfInterpreter.new(options)
 interpreter.run(ARGV[0])

data/lib/yarbf.rb

@@ -1,43 +1,93 @@
 require 'io/console'
 
+##
+# == BfInterpreter
+#
+# BfInterpreter is the main class of yarbf.
+#
+# === Options
+#
+# Options to interpreter can be specified via passing a #Hash object to
+# the constructor or just calling attribute writers. Supported options are:
+#
+# - debug:: Debug mode switch. Setting this option to true will print out
+#           each Brainfuck instruction when interpreting. Default is false.
+# - wrap_around:: Wrap around switch. Setting this option to true will
+#                 ignore cell value overflow or underflow. Default is false.
+# - cell_size:: Size of each cell in bit. Default is 8.
+#
+# === Examples
+#
+# Following is a brief example.
+#
+#   require 'yarbf'
+#
+#   interpreter = BfInterpreter.new({:debug => true, :cell_size => 16})
+#   interpreter.run('/path/to/Brainfuck/source')
+#
 class BfInterpreter
-  # private constants
-  KEY_DEBUG = 'debug'
-  KEY_WRAP = 'wrap_around'
-  KEY_CELL = 'cell_size'
-  private_constant :KEY_DEBUG, :KEY_WRAP, :KEY_CELL
-
-  def initialize(debug = false, wrap_around = true, cell_size = 8)
-    @option = Hash.new
-    @option[KEY_DEBUG] = debug
-    @option[KEY_WRAP] = wrap_around
-    @option[KEY_CELL] = cell_size
+  ##
+  # Initialize the instance.
+  #
+  # +hash+:: A Hash containing options to the interpreter.
+  #
+  def initialize(hash)
+    @option = hash
   end
 
+  ##
+  # Returns whether the interpreter is in debug mode.
+  #
   def debug?
-    @option[KEY_DEBUG]
+    @option[:debug]
   end
 
+  ##
+  # Sets the interpreter to debug mode
+  #
+  # +debug+:: A boolean value.
+  #
   def debug=(debug)
-    @option[KEY_DEBUG] = debug
+    @option[:debug] = debug
   end
 
+  ##
+  # Returns whether the interpreter accepts wrap around.
+  #
   def wrap_around?
-    @option[KEY_WRAP]
+    @option[:wrap_around]
   end
 
+  ##
+  # Sets whether the interpreter should accept wrap around.
+  #
+  # +wrap_around+:: A boolean value.
+  #
   def wrap_around=(wrap_around)
-    @option[KEY_WRAP] = wrap_around
+    @option[:wrap_around] = wrap_around
   end
 
+  ##
+  # Returns the size of each tape cell.
+  #
   def cell_size?
-    @option[KEY_CELL]
+    @option[:cell_size]
   end
 
+  ##
+  # Sets the size of each tape cell.
+  #
+  # +cell_size+:: An integer.
+  #
   def cell_size=(cell_size)
-    @option[KEY_CELL] = cell_size
+    @option[:cell_size] = cell_size
   end
 
+  ##
+  # Interpret a Brainfuck source file.
+  #
+  # +src+:: Path of the source.
+  #
   def run(src)
     units = []
 
@@ -54,7 +104,7 @@ class BfInterpreter
     position = 0
     unit = units[0]
     while unit != nil
-      tape[position] = BfCell.new(position) if tape[position] == nil
+      tape[position] = BfCell.new(cell_size?) if tape[position] == nil
 
       STDERR.printf('%s', unit.instruction) if debug?
 
@@ -85,6 +135,11 @@ class BfInterpreter
     end
   end
 
+  ##
+  # Constructs and returns the program units of class #BfProgramUnit.
+  #
+  # +file+:: The #File object of source file.
+  #
   def construct_program_units(file)
     units = Array.new
     position = 0
@@ -104,6 +159,11 @@ class BfInterpreter
     units
   end
 
+  ##
+  # Matches each bracket '[' and ']' in the source.
+  #
+  # +units+:: An #Array of program units.
+  #
   def match_brackets(units)
     units.each_index do |i|
       if units[i].instruction == '['
@@ -129,27 +189,46 @@ class BfInterpreter
 
   private :construct_program_units, :match_brackets
 
+  ##
+  # Cell of the Brainfuck tape.
+  #
   class BfCell
-    attr_accessor :position, :value
+    attr_accessor :cell_size, :value
 
-    def initialize(position, value = 0)
-      @position = position
+    def initialize(cell_size = 8, value = 0)
+      @cell_size = cell_size
       @value = value
     end
 
-    def increase(increment = 1, wrap_around = true)
-      if !wrap_around && (@value + increment < 0 || @value + increment > 255)
+    ##
+    # Increase the value of a cell.
+    #
+    # +increment+:: Value to increase by. Default is 1.
+    # +wrap_around+:: Whether to wrap around. Default is false.
+    #
+    def increase(increment = 1, wrap_around = false)
+      if !wrap_around &&
+          (@value + increment < 0 || @value + increment >= (1 << @cell_size))
         fail 'Overflow or underflow happened while forbidden!'
       else
-        @value = (@value + increment) % 256
+        @value = (@value + increment) % (1 << @cell_size)
       end
     end
 
-    def decrease(decrement = 1, wrap_around = true)
+    ##
+    # Decrease the value of a cell.
+    #
+    # +decrement+:: Value to decrease by. Default is 1.
+    # +wrap_around+:: Whether to wrap around. Default is false.
+    #
+    def decrease(decrement = 1, wrap_around = false)
       self.increase(-decrement, wrap_around)
     end
   end
 
+  ##
+  # Program unit of Brainfuck.
+  #
   class BfProgramUnit
     attr_reader :instruction
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarbf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chaos Shen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: yarbf, is a simple Brainfuck interpreter in Ruby.
+description: yarbf is a simple Brainfuck interpreter in Ruby.
 email: chaosdefinition@hotmail.com
 executables:
 - yarbf