robolson-simplesem 0.1.3 → 0.1.4

data/Manifest

@@ -0,0 +1,18 @@
+LICENSE
+Manifest
+README.textile
+Rakefile
+bin/simplesem
+lib/simplesem.rb
+lib/simplesem/arithmetic.treetop
+lib/simplesem/arithmetic_node_classes.rb
+lib/simplesem/simple_sem.treetop
+lib/simplesem/simplesem_program.rb
+lib/simplesem/version.rb
+lib/trollop/trollop.rb
+sample_programs/case-statement.txt
+sample_programs/gcd.txt
+sample_programs/hello-world.txt
+sample_programs/while-loop.txt
+test/simplesem_test.rb
+test/test_helper.rb

data/README.textile

@@ -8,27 +8,27 @@ Interpreter for the SIMPLESEM language.
 
 SIMPLESEM is used in the CS141 Programming Languages course taught by Professor "Shannon Tauro":http://www.ics.uci.edu/~stauro/ at UC Irvine. This Rubygem was created out of my desire to execute SIMPLESEM programs.
 
-This interpreter utilizes Nathan Sobo's "Treetop":http://github.com/nathansobo/treetop gem to create a parsing expression grammar for parsing SIMPLESEM commands.  
+This interpreter utilizes Nathan Sobo's "Treetop":http://github.com/nathansobo/treetop gem to create a parsing expression grammar for parsing SIMPLESEM commands.
 
 h2. Installation and Usage
 
 Install the simplesem gem with:
 
-  $ sudo gem install robolson-simplesem
+bc. $ sudo gem install robolson-simplesem
 
 Execute a SIMPLESEM program using the simplesem command. Pass the filename of the SIMLESEM source file as an argument.
 
-  $ simplesem simplesem_file.txt
+bc. $ simplesem simplesem_file.txt
 
 h3. Command Line Options
 
-The simplesem executable accepts a couple command line options which will display the values in the Data array at the time the program exits.
+The simplesem executable accepts a couple optional command line options which will display the values in the Data array at the time the program exits.
 
-  -h    Print help message
-  -t    Print Data array on exit
-  -v    Print Data array with change history on exit. Supersedes -t if it is also specified.
+pre. --help              Print help message
+--inspect           Print values in the data array on exit
+--inspect-history   Print values in the data array with change history on exit
 
-Use -t if you only want to see the ending value at each position in the Data array, otherwise use -v to see each data location's history. If neither -t or -v is used the program will not display the data array.
+Use @--inspect@ if you only want to see the ending value at each position in the Data array, otherwise use @--inspect-history@ to see each data location's history.
 
 h2. Introduction to SIMPLESEM
 
@@ -40,11 +40,11 @@ The @set@ command is used to modify the value stored in a cell. It takes two par
 
 Evaluate the expression (4 * 2) and places the result into location 0:
 
-  set 0, 4 * 2
+bc. set 0, 4 * 2
 
 Assign the value stored at location 0 into location 2:
 
-  set 2, D[0]
+bc. set 2, D[0]
 
 h3. Input/Output with SET
 
@@ -52,11 +52,11 @@ The @set@ command is also used to print to the screen and to get input from the
 
 Print the value stored at location 0:
 
-  set write, D[0]
+bc. set write, D[0]
 
 Get input from the user and store it at location 1:
 
-  set 0, read
+bc. set 0, read
 
 h3. JUMP
 
@@ -64,7 +64,7 @@ The @jump@ command performs and unconditional jump to the line number specified.
 
 Jump program execution to the address at location 0:
 
-  jump D[0]
+bc. jump D[0]
 
 h3. JUMPT
 
@@ -72,7 +72,7 @@ The @jumpt@ command (pronounced jump-true), is a conditional jump. It only jumps
 
 Jump to line 7 if the value at <notextile>D[1]</notextile> is equal to the value at <notextile>D[0]</notextile>:
 
-  jumpt 7, D[1] = D[0]
+bc. jumpt 7, D[1] = D[0]
 
 SIMPLESEM supports all the common comparison operators: >, <, >=, <=, !=, and =. Take note that the equality operator is a single '=' sign, not the usual '=='.
 
@@ -80,8 +80,8 @@ h3. Comments
 
 SIMPLESEM comments begin with two forward slashes. Everything on the line following @//@ is considered a comment and is ignored by the interpreter. *Important*: Comments still consume line numbers! Keep this in mind when writing jump statements.
 
-  // This is line number 0.
-  set write, "foo"  // a comment after a statement
+bc. // This is line number 0.
+set write, "foo"  // a comment after a statement
 
 h2. Slightly More Advanced Features of SIMPLESEM
 
@@ -89,19 +89,19 @@ h3. Nested Data Lookups
 
 SIMPLESEM supports nesting expressions inside of the address location for accessing the data array. This statement looks up the value at location 0, adds 1 to it, then uses the result as the address of another data lookup. If <notextile>D[0]</notextile> contains the value 9--this statement will set location 5 with the value at location 10.
 
-  set 5, D[D[0]+1]
+bc. set 5, D[D[0]+1]
 
 h3. Indirect Addressing
 
 Assigns the value stored at location 15 into the cell whose address is the value stored at location 10:
 
-  set D[10], D[15]
+bc. set D[10], D[15]
 
 h3. Complex Math Expressions
 
 SIMPLESEM supports standard mathematical order of operations. The following statement sets location 1 to 14 as expected:
 
-  set 1, 2+3*4
+bc. set 1, 2+3*4
 
 h3. Using The Instruction Pointer Variable
 
@@ -109,13 +109,15 @@ At any point you can use the @ip@ placeholder in your code and it will evaluate
 
 The following program will output the text "hello world!" five times and then exit. It uses the @ip@ variable to jump execution back to the @set write@ statement.
 
-<pre><code>
+<pre>
+<code>
 set 0, 0
 set write, "hello world!"
 set 0, D[0]+1
 jumpt ip-3, D[0] < 5
 halt
-</code></pre>
+</code>
+</pre>
 
 h3. A Sample SIMPLESEM Program
 
@@ -136,15 +138,15 @@ set 0, D[0]-D[1]
 jump 8
 </code></pre>
 
+Running the above program on the command line will give the following output:
 <pre>
-$ simplesem -v sample_programs/gcd.txt 
+$ simplesem --inspect-history sample_programs/gcd.txt
 input: 15
 input: 35
 5
 
-DATA: 
+DATA:
 0: [15, 10, 5]
 1: [35, 20, 5]
 2: [4]
 </pre>
-

data/Rakefile

@@ -1,13 +1,11 @@
-require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('simplesem', '0.1.3') do |p|
-  p.description         = "SIMPLESEM Interpreter"
-  p.url                 = "http://github.com/robolson/simplesem"
-  p.author              = "Rob Olson"
-  p.email               = "rko618@gmail.com"
+Echoe.new('simplesem', '0.1.4') do |p|
+  p.summary = "SIMPLESEM Interpreter"
+  p.description = "Interpreter for parsing and executing SIMPLESEM programs"
+  p.url = "http://github.com/robolson/simplesem"
+  p.author = "Rob Olson"
+  p.email = "rob@thinkingdigitally.com"
   p.runtime_dependencies = ["treetop >=1.2.4"]
 end
-
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/bin/simplesem

@@ -1,55 +1,36 @@
 #!/usr/bin/env ruby
-#= Overview
-#
-# Interpreter for the SIMPLESEM language
-#
-#= Usage
-#
-# simplesem [-t|-v] filename
-# 
-# Options:
-#   -h    Print this message
-#   -t    Print Data array on exit
-#   -v    Print Data array with change history on exit. Supersedes -t 
-#         if it is also specified.
-#
-
-require 'rubygems'
-require 'rdoc/usage'
-require 'getoptlong'
-
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
-require 'simplesem'
 
-opts = GetoptLong.new(
-  [ '-h', '--help', GetoptLong::NO_ARGUMENT ],
-  [ '-t', GetoptLong::NO_ARGUMENT ],
-  [ '-v', GetoptLong::NO_ARGUMENT ]
-)
-
-verbosity = 0   # by default do not print what is in Data
-
-opts.each do |opt, arg|
-  case opt
-    when '-h'
-      RDoc::usage
-    when '-t'
-      verbosity = 1
-    when '-v'
-      verbosity = 2
-  end
+# The gem packager will properly add the lib dir to LOAD_PATH when
+# executing the gem but load path manipulation is needed during development
+unless $LOAD_PATH.include?(File.expand_path('../../lib', __FILE__))
+  $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 end
 
-if ARGV.length != 1
-  puts "Missing filename argument (try --help)"
-  exit 0
+require 'simplesem'
+require 'trollop/trollop'
+
+opts = Trollop::options do
+  version SimpleSem::VERSION
+  banner <<-EOS
+Interpreter for the SIMPLESEM language by Rob Olson
+
+Usage: simplesem [options] filename
+
+Options:
+EOS
+
+  opt :inspect, "Print values in the data array on exit"
+  opt :inspect_history, "Print values in the data array with change history on exit"
+  conflicts :inspect, :inspect_history
 end
+Trollop::die "must specify a single filename" if ARGV.length != 1
 
-ssp = SimpleSemProgram.new(ARGV.shift)
+
+ssp = SimpleSem::Program.new(ARGV.shift)
 ssp.run
 
-if (verbosity == 1)
+if opts[:inspect_history]
   puts "\nDATA: \n" + ssp.inspect_data
-elsif (verbosity == 2)
+elsif opts[:inspect]
   puts "\nDATA: \n" + ssp.inspect_data_with_history
-end
+end

data/lib/simplesem/arithmetic.treetop

@@ -1,99 +1,101 @@
-grammar Arithmetic  
-  rule expression
-    comparative / additive
-  end
-  
-  rule comparative
-    operand_1:additive space operator:comparison_op space operand_2:additive <BinaryOperation>
-  end
-  
-  rule comparison_op
-    '>=' {
-      def apply(a, b)
-        a >= b
-      end
-    }
-    /
-    '<=' {
-      def apply(a, b)
-        a <= b
-      end
-    }
-    /
-    '>' {
-      def apply(a, b)
-        a > b
-      end
-    }
-    /
-    '<' {
-      def apply(a, b)
-        a < b
-      end
-    }
-    /
-    '!=' {
-      def apply(a, b)
-        a != b
-      end
-    }
-    /
-    '=' {
-      def apply(a, b)
-        a == b
-      end
-    }
-  end
-  
-  rule additive
-    operand_1:multitive space operator:additive_op space operand_2:additive <BinaryOperation>
-    /
-    multitive
-  end
-  
-  rule additive_op
-    '+' {
-      def apply(a, b)
-        a + b
-      end
-    }
-    /
-    '-' {
-      def apply(a, b)
-        a - b
-      end
-    }
-  end
+module SimpleSem
+  grammar Arithmetic
+    rule expression
+      comparative / additive
+    end
 
-  rule multitive
-    operand_1:primary space operator:multitive_op space operand_2:multitive <BinaryOperation>
-    /
-    primary
-  end
-  
-  rule multitive_op
-    '*' {
-      def apply(a, b)
-        a * b
-      end
-    }
-    /
-    '/' {
-      def apply(a, b)
-        a / b
-      end
-    }
-  end  
+    rule comparative
+      operand_1:additive space operator:comparison_op space operand_2:additive <BinaryOperation>
+    end
 
-  rule number
-    ('-'? [1-9] [0-9]* / '0') {
-      def eval(env={})
-        text_value.to_i
-      end
-    }
-  end
-  
-  rule space
-    ' '*
+    rule comparison_op
+      '>=' {
+        def apply(a, b)
+          a >= b
+        end
+      }
+      /
+      '<=' {
+        def apply(a, b)
+          a <= b
+        end
+      }
+      /
+      '>' {
+        def apply(a, b)
+          a > b
+        end
+      }
+      /
+      '<' {
+        def apply(a, b)
+          a < b
+        end
+      }
+      /
+      '!=' {
+        def apply(a, b)
+          a != b
+        end
+      }
+      /
+      '=' {
+        def apply(a, b)
+          a == b
+        end
+      }
+    end
+
+    rule additive
+      operand_1:multitive space operator:additive_op space operand_2:additive <BinaryOperation>
+      /
+      multitive
+    end
+
+    rule additive_op
+      '+' {
+        def apply(a, b)
+          a + b
+        end
+      }
+      /
+      '-' {
+        def apply(a, b)
+          a - b
+        end
+      }
+    end
+
+    rule multitive
+      operand_1:primary space operator:multitive_op space operand_2:multitive <BinaryOperation>
+      /
+      primary
+    end
+
+    rule multitive_op
+      '*' {
+        def apply(a, b)
+          a * b
+        end
+      }
+      /
+      '/' {
+        def apply(a, b)
+          a / b
+        end
+      }
+    end
+
+    rule number
+      ('-'? [1-9] [0-9]* / '0') {
+        def eval(env={})
+          text_value.to_i
+        end
+      }
+    end
+
+    rule space
+      ' '*
+    end
   end
-end
+end

data/lib/simplesem/arithmetic_node_classes.rb

@@ -1,7 +1,11 @@
-module Arithmetic
-  class BinaryOperation < Treetop::Runtime::SyntaxNode
-    def eval(env={})
-      operator.apply(operand_1.eval(env), operand_2.eval(env))      
+module SimpleSem
+  module Arithmetic
+
+    class BinaryOperation < Treetop::Runtime::SyntaxNode
+      def eval(env={})
+        operator.apply(operand_1.eval(env), operand_2.eval(env))
+      end
     end
+
   end
-end
+end