yarbf 0.1.0 → 0.1.1

data/bin/yarbf

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -w
 
 lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -8,7 +8,7 @@ require 'yarbf'
 
 # overrides the default #Kernel.fail.
 def fail(reason)
-  STDERR.puts File.basename($0) + ': ' + reason.to_s
+  $stderr.puts File.basename($0) + ': ' + reason.to_s
   exit false
 end
 

data/lib/yarbf.rb

@@ -9,10 +9,36 @@ module Yarbf
   # available options for input mode
   INPUT_MODE_OPTIONS = [:buffered, :raw] # :nodoc:
 
+  module BooleanJudge
+    ##
+    # Determines and returns whether an object is a boolean value.
+    #
+    # +obj+:: An #Object.
+    # +&block+:: A block to call when true.
+    #
+    def is_boolean?(obj, &block)
+      result = [true, false].include?(obj)
+      yield if result && !block.nil?
+      result
+    end
+
+    ##
+    # Determines and returns whether an object is not a boolean value.
+    #
+    # +obj+:: An #Object.
+    # +&block+:: A block to call when true.
+    #
+    def not_boolean?(obj, &block)
+      result = [true, false].include?(obj)
+      yield unless result || block.nil?
+      result
+    end
+  end
+
   ##
   # == BfInterpreter
   #
-  # BfInterpreter is the main class of module #YARBF.
+  # BfInterpreter is the main class of module #Yarbf.
   #
   # === Options
   #
@@ -42,27 +68,37 @@ module Yarbf
   #     :cell_size => 16,
   #     :input_mode => :buffered
   #   }
-  #   interpreter = YARBF::BfInterpreter.new(options)
+  #   interpreter = Yarbf::BfInterpreter.new(options)
   #   interpreter.run('/path/to/Brainfuck/source')
   #
   class BfInterpreter
+    include BooleanJudge
+
     ##
     # Initialize the instance.
     #
     # +options+:: A Hash containing options to the interpreter.
     #
     def initialize(options)
-      unless options.is_a? Hash and OPTIONS.all? { |s| options.has_key? s }
-        fail 'Invalid options given!'
+      unless options.is_a?(Hash) && OPTIONS.all? { |s| options.has_key? s }
+        fail 'Missing required options!'
       end
-      @option = options.dup
+      @options = options.select { |k| OPTIONS.include? k }
+    end
+
+    ##
+    # Returns a human-readable string describing the interpreter.
+    #
+    def inspect
+      @options.inspect
     end
+    alias_method :to_s, :inspect
 
     ##
     # Returns whether the interpreter is in debug mode.
     #
     def debug?
-      @option[:debug]
+      @options[:debug]
     end
 
     ##
@@ -71,17 +107,17 @@ module Yarbf
     # +debug+:: A boolean value.
     #
     def debug=(debug)
-      unless debug.is_a?(TrueClass) or debug.is_a?(FalseClass)
+      not_boolean?(debug) do
         fail "'debug' switch should be a boolean but is a #{debug.class}!"
       end
-      @option[:debug] = debug
+      @options[:debug] = debug
     end
 
     ##
     # Returns whether the interpreter accepts wrap around.
     #
     def wrap_around?
-      @option[:wrap_around]
+      @options[:wrap_around]
     end
 
     ##
@@ -90,17 +126,17 @@ module Yarbf
     # +wrap_around+:: A boolean value.
     #
     def wrap_around=(wrap_around)
-      unless wrap_around.is_a?(TrueClass) or wrap_around.is_a?(FalseClass)
+      not_boolean?(wrap_around) do
         fail "'wrap_around' should be a boolean but is a #{wrap_around.class}!"
       end
-      @option[:wrap_around] = wrap_around
+      @options[:wrap_around] = wrap_around
     end
 
     ##
     # Returns the size of each tape cell.
     #
     def cell_size?
-      @option[:cell_size]
+      @options[:cell_size]
     end
 
     ##
@@ -112,14 +148,14 @@ module Yarbf
       unless cell_size.is_a? Integer
         fail "'cell_size' should be an integer but is a #{cell_size.class}!"
       end
-      @option[:cell_size] = cell_size
+      @options[:cell_size] = cell_size
     end
 
     ##
     # Returns the current input mode.
     #
     def input_mode?
-      @option[:input_mode]
+      @options[:input_mode]
     end
 
     ##
@@ -131,7 +167,7 @@ module Yarbf
       unless INPUT_MODE_OPTIONS.include? input_mode
         fail 'Invalid value of input mode!'
       end
-      @option[:input_mode] = input_mode
+      @options[:input_mode] = input_mode
     end
 
     ##
@@ -146,8 +182,7 @@ module Yarbf
       begin
         File.open(src) { |file| units = construct_program_units(file) }
       rescue SystemCallError => e
-        STDERR.puts $0 + ': ' + e.to_s
-        return
+        fail e.to_s
       end
 
       # match brackets
@@ -158,47 +193,9 @@ module Yarbf
       position = 0
       unit = units[0]
       until unit.nil?
-        tape[position] = BfCell.new(cell_size?) if tape[position].nil?
-
-        STDERR.printf('%s', unit.instruction) if debug?
-
-        case unit.instruction
-          when '+' then
-            tape[position].increase(1, wrap_around?)
-          when '-' then
-            tape[position].decrease(1, wrap_around?)
-          when '<' then
-            position -= 1
-            fail 'Cell position out of bound!' if position < 0
-          when '>' then
-            position += 1
-          when ',' then
-            ch = nil
-            begin
-              ch = STDIN.getc if input_mode? == :buffered
-              ch = STDIN.getch if input_mode? == :raw
-            rescue SystemCallError => e
-              fail e.to_s
-            end
-            return if ch.nil?
-            tape[position].value = ch.ord
-          when '.' then
-            STDOUT.putc tape[position].value
-          when '[' then
-            if tape[position].value == 0
-              unit = unit.match
-              next
-            end
-          when ']' then
-            if tape[position].value != 0
-              unit = unit.match
-              next
-            end
-          else
-            fail "Invalid instruction '#{unit.instruction}'!"
-        end
-
-        unit = unit.next
+        tape[position] = BfCell.new(position, cell_size?) if tape[position].nil?
+        $stderr.printf('%s', unit.instruction) if debug?
+        unit, position = deal_unit(unit, tape, position)
       end
     end
 
@@ -213,13 +210,13 @@ module Yarbf
 
       file.each_byte do |c|
         case c.chr
-          when '+', '-', '<', '>', '[', ']', '.', ',' then
-            unit = BfProgramUnit.new(c.chr)
-            units[position - 1].next = unit if position > 0
-            units[position] = unit
-            position += 1
-          else
-            # other characters are considered as comments, do nothing
+        when '+', '-', '<', '>', '[', ']', '.', ',' then
+          unit = BfProgramUnit.new(c.chr, position)
+          units[position - 1].next = unit if position > 0
+          units[position] = unit
+          position += 1
+        else
+          # other characters are considered as comments, do nothing
         end
       end
 
@@ -229,7 +226,7 @@ module Yarbf
     ##
     # Matches each bracket '[' and ']' in the source.
     #
-    # +units+:: An #Array of program units.
+    # +units+:: An #Array of #BfProgramUnit.
     #
     def match_brackets(units)
       units.each_index do |i|
@@ -254,19 +251,89 @@ module Yarbf
       end
     end
 
-    private :construct_program_units, :match_brackets
+    ##
+    # Reads and returns the next character from stdin.
+    #
+    def get_char
+      ch = nil
+      begin
+        ch = $stdin.getc if input_mode? == :buffered
+        ch = $stdin.getch if input_mode? == :raw
+      rescue SystemCallError => e
+        fail e.to_s
+      end
+      ch
+    end
+
+    ##
+    # Deals with the current program unit, and returns the next program unit
+    # and tape position.
+    #
+    # +unit+:: The current program unit.
+    # +tape+:: An #Array of #BfCell.
+    # +position+:: The current position on the #tape.
+    #
+    def deal_unit(unit, tape, position)
+      case unit.instruction
+      when '+' then
+        tape[position].increase(1, wrap_around?)
+        unit = unit.next
+      when '-' then
+        tape[position].decrease(1, wrap_around?)
+        unit = unit.next
+      when '<' then
+        position -= 1
+        fail 'Cell position out of bound!' if position < 0
+        unit = unit.next
+      when '>' then
+        position += 1
+        unit = unit.next
+      when ',' then
+        ch = get_char
+        return nil, nil if ch.nil?
+        tape[position].value = ch.ord
+        unit = unit.next
+      when '.' then
+        $stdout.putc tape[position].value
+        unit = unit.next
+      when '[' then
+        if tape[position].value == 0
+          unit = unit.match
+        else
+          unit = unit.next
+        end
+      when ']' then
+        if tape[position].value != 0
+          unit = unit.match
+        else
+          unit = unit.next
+        end
+      else
+        fail "Invalid instruction '#{unit.instruction}'!"
+      end
+      return unit, position
+    end
+
+    private :construct_program_units, :match_brackets, :get_char, :deal_unit
 
     ##
     # Cell of the Brainfuck tape.
     #
     class BfCell
+      attr_reader :position
       attr_accessor :cell_size, :value
 
-      def initialize(cell_size = 8, value = 0)
+      def initialize(position, cell_size = 8, value = 0)
+        @position = position
         @cell_size = cell_size
         @value = value
       end
 
+      def inspect
+        "{ pos: #{@position}, value: #{@value} }"
+      end
+      alias_method :to_s, :inspect
+
       ##
       # Increase the value of a cell.
       #
@@ -297,16 +364,23 @@ module Yarbf
     # Program unit of Brainfuck.
     #
     class BfProgramUnit
-      attr_reader :instruction
+      attr_reader :instruction, :position
+      attr_accessor :match, :next
 
-      attr_accessor :match
-      attr_accessor :next
-
-      def initialize(instruction)
+      def initialize(instruction, position)
         @instruction = instruction
+        @position = position
         @match = nil
         @next = nil
       end
+
+      def inspect
+        s = "{ ins: '#{@instruction}', pos: #{@position}"
+        s += ", next: #{@next.position}" unless @next.nil?
+        s += ", match: #{@match.position}" unless @match.nil?
+        s + ' }'
+      end
+      alias_method :to_s, :inspect
     end
   end
 end

data/lib/yarbf/version.rb

@@ -1,4 +1,4 @@
 module Yarbf
   # gem version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/test/bf/hello-world.bf

@@ -0,0 +1,15 @@
+print "Hello World!" with a line feed
+
+++++++++
+[
+	>++++
+	[
+		>++>+++>+++>+<<<<-
+	]
+	>+>+>->>+
+	[
+		<
+	]
+	<-
+]
+>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.

data/test/bf/pi.bf

@@ -0,0 +1,229 @@
+calculate and print value of Pi
+
+>+++++++++++++++
+[
+	<+>>>>>>>>++++++++++<<<<<<<-
+]
+>+++++
+[
+	<+++++++++>-
+]
++>>>>>>+
+[
+	<<+++
+	[
+		>>
+		[
+			-<
+		]
+		<
+		[
+			>
+		]
+		<-
+	]
+	>>
+	[
+		>+>
+	]
+	<
+	[
+		<
+	]
+	>
+]
+>
+[
+	[
+		->>>>+<<<<
+	]
+	>>>+++>-
+]
+<
+[
+	<<<<
+]
+<<<<<<<<+
+[
+	->>>>>>>>>>>>
+	[
+		<+
+		[
+			->>>>+<<<<
+		]
+		>>>>>
+	]
+	<<<<
+	[
+		>>>>>
+		[
+			<<<<+>>>>-
+		]
+		<<<<<-
+		[
+			<<++++++++++>>-
+		]
+		>>>
+		[
+			<<
+			[
+				<+<<+>>>-
+			]
+			<
+			[
+				>+<-
+			]
+			<++<<+>>>>>>-
+		]
+		<<
+		[
+			-
+		]
+		<<-<
+		[
+			->>+<-
+			[
+				>>>
+			]
+			>
+			[
+				[
+					<+>-
+				]
+				>+>>
+			]
+			<<<<<
+		]
+		>
+		[
+			-
+		]
+		>+<<<-
+		[
+			>>+<<-
+		]
+		<
+	]
+	<<<<+>>>>>>>>
+	[
+		-
+	]
+	>
+	[
+		<<<+>>>-
+	]
+	<<++++++++++<
+	[
+		->>+<-
+		[
+			>>>
+		]
+		>
+		[
+			[
+				<+>-
+			]
+			>+>>
+		]
+		<<<<<
+	]
+	>
+	[
+		-
+	]
+	>+>
+	[
+		<<+<+>>>-
+	]
+	<<<<+<+>>
+	[
+		-
+		[
+			-
+			[
+				-
+				[
+					-
+					[
+						-
+						[
+							-
+							[
+								-
+								[
+									-
+									[
+										-<->
+										[
+											-<+<->>
+										]
+									]
+								]
+							]
+						]
+					]
+				]
+			]
+		]
+	]
+	<
+	[
+		+++++
+		[
+			<<<++++++++<++++++++>>>>-
+		]
+		<<<<+<->>>>
+		[
+			>+<<<+++++++++<->>>-
+		]
+		<<<<<
+		[
+			>>+<<-
+		]
+		+<
+		[
+			->-<
+		]
+		>
+		[
+			>>.<<<<
+			[
+				+.
+				[
+					-
+				]
+			]
+			>>-
+		]
+		>
+		[
+			>>.<<-
+		]
+		>
+		[
+			-
+		]
+		>
+		[
+			-
+		]
+		>>>
+		[
+			>>
+			[
+				<<<<<<<<+>>>>>>>>-
+			]
+			<<-
+		]
+	]
+	>>
+	[
+		-
+	]
+	<<<
+	[
+		-
+	]
+	<<<<<<<<
+]
+++++++++++.