meta_compile 0.1.2 → 0.1.3

data/README.md

@@ -3,7 +3,7 @@ meta_compile
 
 A meta compilation framework for Ruby à la [Meta-II by Val Schorre](http://ibm-1401.info/Meta-II-schorre.pdf).
 
-This uses a [C version of Meta-II](https://github.com/impeachgod/meta) developed by Long Nguyen to bootstrap a Ruby version from a [fully self-contained, 26 (non-empty) line specification file](https://raw.github.com/robertfeldt/meta_compile/master/syntaxes/meta_to_ruby_minimal.meta). The [generated Ruby Meta-II compiler file](https://github.com/robertfeldt/meta_compile/blob/master/bin/meta_compile) is 231 lines of Ruby code.
+This uses a [C version of Meta-II](https://github.com/impeachgod/meta) developed by Long Nguyen to bootstrap a Ruby version from a [fully self-contained, 26 (non-empty) line specification file](https://raw.github.com/robertfeldt/meta_compile/master/syntaxes/meta_to_ruby_minimal.meta). The [generated Ruby Meta-II compiler file](https://github.com/robertfeldt/meta_compile/blob/master/bin/metac_minimal) is 231 lines of Ruby code. A more readable and commented version of the specification file [is available here](https://raw.github.com/robertfeldt/meta_compile/master/syntaxes/meta_to_ruby.meta). It also has better error handling both when used from the command line and when compiling (but it is longer, 74 loc for the spec and 331 loc for the [generated compiler](https://github.com/robertfeldt/meta_compile/blob/master/bin/metac_readable)).
 
 Install
 -------
@@ -45,7 +45,7 @@ and this should convince us:
 
 Limitations
 -----------
-+ Very bad/little error handling
++ Rudimentary error handling/reports while compiling/parsing
 
 Ok, now what?
 -------------
@@ -62,11 +62,11 @@ Let's use this to compile programs which can only contain assignments of numbers
 
 The new thing here compared to the original Meta-II syntax is the two Regexp's (in as and ex1). First we need to bootstrap the meta compiler that accepts regexps:
 
-        rake bootstrap_re
+        rake boot_regexp
 
 Then we create a compiler for the assignments syntax:
 
-        ruby bin/metacomp_re syntaxes/assignments.meta > tas.rb
+        ruby bin/metac_regexp syntaxes/assignments.meta > tas.rb
 
 We now have a compiler for assignments and if we apply it [to the file](https://raw.github.com/robertfeldt/meta_compile/master/inputs/assignments.input1):
 

data/Rakefile

@@ -9,18 +9,19 @@ def pexec(str)
 end
 
 desc "Bootstrap our version of Long Nguyen's C version of Meta-II"
-task :bootstrap_c do
-	Dir.chdir "bootstrap"
-	puts "1. Build bootstrap compiler"
-	pexec "gcc -o bootstrapped_c bootstrap.c"
-	puts "2. Use the bootstrapped meta compiler to compile the meta_for_c.txt description of itself"
-	pexec "./bootstrapped_c meta_for_c.txt meta_compiler_from_boostrapped_c.c"
-	puts "3. Build the compiler we created from the meta description"
-	pexec "gcc -o meta_c meta_compiler_from_boostrapped_c.c"
-	puts "4. Now use the generated compiler to generate itself"
-	pexec "./meta_c meta_for_c.txt meta_compiler.c"
-	puts "5. Now ensure the compilers are exactly the same"
-	pexec "diff meta_compiler_from_boostrapped_c.c meta_compiler.c"
+task :boot_c do
+	Dir.chdir "bootstrap" do
+		puts "1. Build bootstrap compiler"
+		pexec "gcc -o bootstrapped_c bootstrap.c"
+		puts "2. Use the bootstrapped meta compiler to compile the meta_to_c.meta description of itself"
+		pexec "./bootstrapped_c meta_to_c.meta meta_compiler_from_boostrapped_c.c"
+		puts "3. Build the compiler we created from the meta description"
+		pexec "gcc -o meta_c meta_compiler_from_boostrapped_c.c"
+		puts "4. Now use the generated compiler to generate itself"
+		pexec "./meta_c meta_to_c.meta meta_compiler.c"
+		puts "5. Now ensure the compilers are exactly the same"
+		pexec "diff meta_compiler_from_boostrapped_c.c meta_compiler.c"
+	end
 end
 
 # Non-empty Lines of Code calc
@@ -28,42 +29,49 @@ def loc(filename)
 	File.readlines(filename).map {|l| l.strip.length==0?nil:l}.compact.length
 end
 
-desc "Bootstrap the Ruby Meta-II compiler"
-task :bootstrap do
+def bootstrap_from_c(syntaxFile)
+	if syntaxFile =~ /^syntaxes/
+		syntaxf = File.join("..", syntaxFile)
+	else
+		syntaxf = File.join("..", "syntaxes", syntaxFile)
+	end
 	Dir.chdir("bootstrap") do
 		puts "1. Build bootstrap compiler"
 		pexec "gcc -o bootstrapped_c bootstrap.c"
 		puts "2. Use the c meta compiler to compile the meta_to_ruby_minimal.meta description"
-		pexec "./bootstrapped_c ../syntaxes/meta_to_ruby_minimal.meta compile_to_ruby.c"
+		pexec "./bootstrapped_c #{syntaxf} compile_to_ruby.c"
 		puts "3. Build the stepping stone ruby compiler we created from the meta description"
 		pexec "gcc -o meta_r compile_to_ruby.c"
 		puts "4. Now use the generated stepping stone compiler to generate a ruby compiler for the ruby meta syntax"
-		pexec "./meta_r ../syntaxes/meta_to_ruby_minimal.meta meta_ruby_compiler_from_c.rb"
+		pexec "./meta_r #{syntaxf} meta_ruby_compiler_from_c.rb"
 		puts "5. Run the generated ruby meta compiler to a ruby version"
-		pexec "ruby -I. meta_ruby_compiler_from_c.rb ../syntaxes/meta_to_ruby_minimal.meta > meta_ruby_compiler.rb"
+		pexec "ruby -I. meta_ruby_compiler_from_c.rb #{syntaxf} > meta_ruby_compiler.rb"
 		puts "6. Ruby version differ since it has single instead of double quotes around strings"
 		#pexec "diff meta_ruby_compiler_from_c.rb meta_ruby_compiler.rb"
 		puts "7. But we can generate again and ensure it is a meta compiler"
-		pexec "ruby -I. meta_ruby_compiler.rb ../syntaxes/meta_to_ruby_minimal.meta > meta_ruby_compiler2.rb"
+		pexec "ruby -I. meta_ruby_compiler.rb #{syntaxf} > meta_ruby_compiler2.rb"
 		pexec "diff meta_ruby_compiler.rb meta_ruby_compiler2.rb"
 		puts "8. One more round just to show off... :)"
-		pexec "ruby -I. meta_ruby_compiler2.rb ../syntaxes/meta_to_ruby_minimal.meta > meta_ruby_compiler3.rb"
+		pexec "ruby -I. meta_ruby_compiler2.rb #{syntaxf} > meta_ruby_compiler3.rb"
 		pexec "diff meta_ruby_compiler.rb meta_ruby_compiler3.rb"
-		puts "Summary:\nCreated a #{loc('meta_ruby_compiler.rb')} line meta-II meta compiler from a #{loc('../syntaxes/meta_to_ruby_minimal.meta')} line meta-II spec\n\n"
+		puts "Summary:\nCreated a #{loc('meta_ruby_compiler.rb')} line meta-II meta compiler from a #{loc(syntaxf)} line meta-II spec\n\n"
+  	ensure_is_meta "meta_ruby_compiler.rb", syntaxf, "../bin/meta_compile"
 	end
 end
 
 # Bootstrap a syntax from the meta_compile compiler
-def bootstrap_from_meta_compile(syntaxFile)
-	pexec "meta_compile #{syntaxFile} > tgen.rb"
-	ensure_is_meta("tgen.rb", syntaxFile)
+def bootstrap_from_ruby(syntaxFile, targetName = "tgen.rb")
+	syntaxf    = File.join("syntaxes", syntaxFile)
+	# Assumes the ruby version has been bootstrapped from C and is installed as meta_compile
+	pexec "ruby bin/meta_compile #{syntaxf} > #{targetName}"
+	ensure_is_meta(targetName, syntaxf, targetName)
 end
 
 def diff_files(f1, f2)
 	File.read(f1) != File.read(f2)
 end
 
-def ensure_is_meta(generatedFile, specFile)
+def ensure_is_meta(generatedFile, specFile, saveAsTarget = nil)
 	pexec "ruby #{generatedFile} #{specFile} > t.rb"
 	pexec "ruby t.rb #{specFile} > t2.rb"
 	# Obviously we should now be able to go on and on... :)
@@ -74,35 +82,74 @@ def ensure_is_meta(generatedFile, specFile)
 			exit(-1)
 		else
 			puts "YES #{generatedFile} is meta!!! (generated from #{specFile})"
+			if saveAsTarget
+				FileUtils.mv("t2.rb", saveAsTarget) 
+				puts "Saved bootstrapped file as #{saveAsTarget}"
+			end
+			return true
 		end
 	ensure
 		FileUtils.rm_f Dir.glob("t*.rb")
 	end
 end
 
-desc "Make binary from the bootstrapped ruby meta-II compiler"
-task :make_bin => [:bootstrap] do
-	FileUtils.cp "bootstrap/meta_ruby_compiler.rb", "bin/meta_compile"
+def create_main_binary(sourceBinary)
+	FileUtils.cp sourceBinary, "bin/meta_compile"
 	FileUtils.chmod 0755, "bin/meta_compile"
-	puts "Created binary in bin/meta_compile"
-end
-
-desc "Ensure it is a meta compiler"
-task :ensure_meta => [:make_bin] do
-  ensure_is_meta "bin/meta_compile", "syntaxes/meta_to_ruby_minimal.meta"
+	puts "Created main binary in bin/meta_compile from #{sourceBinary}"
 end
 
 def bootstrap_with_stepping_stone(syntaxFile, target)
 	syntaxf    = File.join("syntaxes", syntaxFile)
 	stepstonef = File.join("syntaxes", "stepping_stone_" + syntaxFile)
-	pexec "meta_compile #{stepstonef} > tgen_stepstone.rb"
+	pexec "ruby bin/meta_compile #{stepstonef} > tgen_stepstone.rb"
 	pexec "ruby tgen_stepstone.rb #{syntaxf} > #{target}"
-	ensure_is_meta(target, syntaxf)
+	ensure_is_meta(target, syntaxf, target)
+end
+
+desc "Bootstrap the Ruby meta compiler (uses the minimal syntax)"
+task :boot do
+	bootstrap_from_c "meta_to_ruby_minimal.meta"
+end
+
+desc "Bootstrap and set binary file permissions"
+task :bootstrap => :boot do	
+	FileUtils.chmod 0755, "bin/meta_compile"
+end
+
+desc "Bootstrap the minimal Ruby meta compiler (from the Ruby meta compiler)"
+task :boot_minimal => :bootstrap do
+	bootstrap_from_ruby "meta_to_ruby_minimal.meta", "bin/metac_minimal"
+end
+
+desc "Make main gem binary from the minimal ruby meta compiler"
+task :make_bin_minimal => :boot_minimal do
+	create_main_binary "bin/metac_minimal"
+end
+
+desc "Ensure minimal ruby meta it is a meta compiler"
+task :ensure_meta_minimal => :make_bin_minimal do
+  ensure_is_meta "bin/meta_compile", "syntaxes/meta_to_ruby_minimal.meta"
+end
+
+desc "Bootstrap the readable meta compiler (from the Ruby meta compiler)"
+task :boot_readable => :make_bin_minimal do
+	bootstrap_from_ruby "meta_to_ruby.meta", "bin/metac_readable"
+end
+
+desc "Make main gem binary from the readable ruby meta compiler"
+task :make_bin_readable => :boot_readable do
+	create_main_binary "bin/metac_readable"
+end
+
+desc "Ensure readable ruby meta it is a meta compiler"
+task :ensure_meta_readable => :make_bin_readable do
+  ensure_is_meta "bin/meta_compile", "syntaxes/meta_to_ruby.meta"
 end
 
 desc "Bootstrap the meta compiler that accepts regexps"
-task :bootstrap_re do
-	bootstrap_with_stepping_stone("meta_to_ruby_minimal_with_regexps.meta", "bin/metacomp_re")
+task :boot_regexp => :make_bin_minimal do
+	bootstrap_with_stepping_stone("meta_to_ruby_minimal_with_regexps.meta", "bin/metac_regexp")
 end
 
 def run_example(compiler, example)
@@ -112,8 +159,8 @@ def run_example(compiler, example)
 	pexec "ruby #{compiler} #{example}"
 end
 
-def metacomp_re_run_examples(syntaxFile, *inputs)
-	pexec "ruby bin/metacomp_re #{syntaxFile} > tas.rb"
+def metac_regexp_run_examples(syntaxFile, *inputs)
+	pexec "ruby bin/metac_regexp #{syntaxFile} > tas.rb"
 	inputs.each do |i|
 	  run_example("tas.rb", "inputs/#{i}")
 	end
@@ -121,22 +168,21 @@ end
 
 desc "Compile all inputs for the assignments syntax"
 task :ex_ass do
-	metacomp_re_run_examples "syntaxes/assignments.meta", "assignments.input1"
+	metac_regexp_run_examples "syntaxes/assignments.meta", "assignments.input1"
 end
 
 desc "Update line counts in README.template.md to make README.md"
-task :update => [:bootstrap] do
-	rmeta2_compiler_loc = loc('bootstrap/meta_ruby_compiler.rb')
-	rmeta2_spec_loc = loc('syntaxes/meta_to_ruby_minimal.meta')
-	readme = File.read("README.template.md").gsub("%%RMetaII_SPEC_LOC%%", rmeta2_spec_loc.to_s)
-	readme = readme.gsub("%%RMetaII_COMPILER_LOC%%", rmeta2_compiler_loc.to_s)
+task :update => [:boot_minimal, :boot_regexp, :boot_readable] do
+	readme = File.read("README.template.md")
+	readme = readme.gsub("%%RMetaII_SPEC_LOC%%", loc('syntaxes/meta_to_ruby_minimal.meta').to_s)
+	readme = readme.gsub("%%RMetaII_COMPILER_LOC%%", loc('bin/metac_minimal').to_s)
+	readme = readme.gsub("%%RMetaII_READABLE_SPEC_LOC%%", loc('syntaxes/meta_to_ruby.meta').to_s)
+	readme = readme.gsub("%%RMetaII_READABLE_COMPILER_LOC%%", loc('bin/metac_readable').to_s)
 	File.open("README.md", "w") {|f| f.puts readme}
 end
 
-task :default => :ensure_meta
-
 desc "Build the gem"
-task :build_gem => [:make_bin] do
+task :build_gem => [:update, :make_bin_readable] do
 	Rake::Task["clean"].invoke
 	FileUtils.rm_f Dir.glob("meta_compile-*.gem")
 	pexec "gem build meta_compile.gemspec"
@@ -148,7 +194,7 @@ task :install_gem => [:build_gem] do
 end
 
 desc "Deploy gem"
-task :deploy => [:update, :install_gem] do
+task :deploy => :build_gem do
 	pexec "gem push meta_compile*.gem"
 end
 
@@ -164,4 +210,6 @@ task :clobber => [:clean] do
 	  FileUtils.rm_f %w{meta_ruby_compiler.rb meta_compile*.gem}
 	end
   FileUtils.rm_f Dir.glob("meta_compile-*.gem")
-end
+end
+
+task :default => :make_bin_readable

data/bin/meta_compile

@@ -1,231 +1,331 @@
 #!/usr/bin/env ruby
 require "strscan"
-class C_program
-$c = self
-def compile(str, out)
-@i, @o = StringScanner.new(str), out
-compile_program
+class StringScanner
+  # Add scan for string since base StringScanner lack that...
+  def scan_str(string)
+    return nil unless self.peek(string.length) == string
+    self.pos += string.length           # Advance the position in the input string
+    return string
+  end
+  alias :old_scan :scan
+  def scan(strOrRegexp)
+    String === strOrRegexp ? scan_str(strOrRegexp) : old_scan(strOrRegexp)
+  end
 end
+class MetaCompiler_program
+  $compiler_class = self # Save class in global var for later reference below
+  def compile_string(string, outFile)
+    @in, @out = StringScanner.new(string), outFile
+    compile_program # call the main compile method to start compiling
+  end
+  # Scan for a string or regexp and update state based on match. Skips leading whitespace.
+  def scan strOrRegexp
+    @in.scan /\s*/   # Skip whitespace
+    @match = @in.scan strOrRegexp
+    # Since nil is same as false in Ruby we can set the flag to the matched token
+    @last_matched_token = @match if @match # Update last matched only if a token was matched
+  end
+  def report_error
+    pre_lines = @in.string[0, @in.pos].split("\n") # lines of input up to current position
+    post_lines = @in.rest.split("\n")              # lines of input after current position
+    message = "PARSE ERROR at line #{pre_lines.length}:\n  " + pre_lines.last.inspect + " @ "
+    message += post_lines.first.inspect
+    message += "\n  Last matched token: #{@last_matched_token}"
+    raise message
+  end
+  def self.compile_file(inFile, out = nil)
+    outfh = (out == nil ? STDOUT : File.open(out, "w"))
+    self.new.compile_string(File.read(inFile), outfh)
+    outfh.close if out == nil
+  end
 def compile_outarg
 begin
-@i.scan /\s*/; s='$'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print '@o.print @t'
-@o.print "\n"
+scan '$'
+if @match
+@out.print '@out.print @match   # Print last matched token on output stream'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 end
-break if @f
-@i.scan /\s*/; @f = @t = @i.scan /\047[^\047]*\047/
-if @f
-@o.print '@o.print '
-@o.print @t
-@o.print "\n"
+break if @match
+scan /\047[^\047]*\047/
+if @match
+@out.print '@out.print '    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print '    # Print literal string on output stream'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 end
-end while false
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_out
 begin
-@i.scan /\s*/; s='<'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
+scan '<'
+if @match
 begin
-compile_outarg
-end while @f
-@f = true
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@i.scan /\s*/; s='>'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print '@o.print "\n"'
-@o.print "\n"
-end
-end while false
+compile_outarg     # Call the method for a rule
+end while @match              # Loop while there is a match
+@match = true                 # Since also zero matches is ok set flag here.
+report_error() unless @match
+scan '>'
+report_error() unless @match
+@out.print '@out.print "\n"     # Print newline on output stream'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_exp3
 begin
-@i.scan /\s*/; @f = @t = @i.scan /[A-Za-z]+[A-Za-z0-9_]+/
-if @f
-@o.print 'compile_'
-@o.print @t
-@o.print "\n"
-end
-break if @f
-@i.scan /\s*/; @f = @t = @i.scan /\047[^\047]*\047/
-if @f
-@o.print '@i.scan /\s*/; s='
-@o.print @t
-@o.print '; l=s.length;'
-@o.print "\n"
-@o.print '@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil'
-@o.print "\n"
-end
-break if @f
-@i.scan /\s*/; s='.id'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print '@i.scan /\s*/; @f = @t = @i.scan /[A-Za-z]+[A-Za-z0-9_]+/'
-@o.print "\n"
-end
-break if @f
-@i.scan /\s*/; s='.string'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print '@i.scan /\s*/; @f = @t = @i.scan /\047[^\047]*\047/'
-@o.print "\n"
-end
-break if @f
-@i.scan /\s*/; s='('; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-compile_exp1
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@i.scan /\s*/; s=')'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-end
-break if @f
-@i.scan /\s*/; s='.e'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print '@f = true'
-@o.print "\n"
-end
-break if @f
-@i.scan /\s*/; s='*'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print 'begin'
-@o.print "\n"
-compile_exp3
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print 'end while @f'
-@o.print "\n"
-@o.print '@f = true'
-@o.print "\n"
-end
-end while false
+scan /[A-Za-z]+[A-Za-z0-9_]+/
+if @match
+@out.print 'compile_'    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print '     # Call the method for a rule'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+scan /\047[^\047]*\047/
+if @match
+@out.print 'scan '    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+scan '.id'
+if @match
+@out.print 'scan /[A-Za-z]+[A-Za-z0-9_]+/'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+scan '.string'
+if @match
+@out.print 'scan /\047[^\047]*\047/'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+scan '('
+if @match
+compile_exp1     # Call the method for a rule
+report_error() unless @match
+scan ')'
+report_error() unless @match
+end
+break if @match
+scan '.e'
+if @match
+@out.print '@match = true        # .e means empty so always matches => set flag.'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+scan '*'
+if @match
+@out.print 'begin'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+compile_exp3     # Call the method for a rule
+report_error() unless @match
+@out.print 'end while @match              # Loop while there is a match'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '@match = true                 # Since also zero matches is ok set flag here.'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_exp2
 begin
 begin
-compile_exp3
-if @f
-@o.print 'if @f'
-@o.print "\n"
-end
-break if @f
-compile_out
-if @f
-@o.print 'if true'
-@o.print "\n"
-end
-end while false
-if @f
+compile_exp3     # Call the method for a rule
+if @match
+@out.print 'if @match'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+break if @match
+compile_out     # Call the method for a rule
+if @match
+@out.print 'if true'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
+if @match
 begin
 begin
-compile_exp3
-if @f
-@o.print 'raise("error at: " + @i.rest.split("\n")[0]) if !@f'
-@o.print "\n"
+compile_exp3     # Call the method for a rule
+if @match
+@out.print 'report_error() unless @match'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 end
-break if @f
-compile_out
-if @f
+break if @match
+compile_out     # Call the method for a rule
+if @match
 end
-end while false
-end while @f
-@f = true
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print 'end'
-@o.print "\n"
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
+end while @match              # Loop while there is a match
+@match = true                 # Since also zero matches is ok set flag here.
+report_error() unless @match
+@out.print 'end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 end
-end while false
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_exp1
 begin
-@o.print 'begin'
-@o.print "\n"
+@out.print 'begin'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 if true
-compile_exp2
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
+compile_exp2     # Call the method for a rule
+report_error() unless @match
 begin
 begin
-@i.scan /\s*/; s='|'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@o.print 'break if @f'
-@o.print "\n"
-compile_exp2
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-end
-end while false
-end while @f
-@f = true
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print 'end while false'
-@o.print "\n"
-end
-end while false
+scan '|'
+if @match
+@out.print 'break if @match'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+compile_exp2     # Call the method for a rule
+report_error() unless @match
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
+end while @match              # Loop while there is a match
+@match = true                 # Since also zero matches is ok set flag here.
+report_error() unless @match
+@out.print 'end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_rule
 begin
-@i.scan /\s*/; @f = @t = @i.scan /[A-Za-z]+[A-Za-z0-9_]+/
-if @f
-@o.print 'def compile_'
-@o.print @t
-@o.print "\n"
-@i.scan /\s*/; s='='; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-compile_exp1
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@i.scan /\s*/; s=';'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print 'end'
-@o.print "\n"
-end
-end while false
+scan /[A-Za-z]+[A-Za-z0-9_]+/
+if @match
+@out.print 'def compile_'    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print "\n"     # Print newline on output stream
+scan '='
+report_error() unless @match
+compile_exp1     # Call the method for a rule
+report_error() unless @match
+scan ';'
+report_error() unless @match
+@out.print 'end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
 end
 def compile_program
 begin
-@i.scan /\s*/; s='.syntax'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-if @f
-@i.scan /\s*/; @f = @t = @i.scan /[A-Za-z]+[A-Za-z0-9_]+/
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print '#!/usr/bin/env ruby'
-@o.print "\n"
-@o.print 'require "strscan"'
-@o.print "\n"
-@o.print 'class C_'
-@o.print @t
-@o.print "\n"
-@o.print '$c = self'
-@o.print "\n"
-@o.print 'def compile(str, out)'
-@o.print "\n"
-@o.print '@i, @o = StringScanner.new(str), out'
-@o.print "\n"
-@o.print 'compile_'
-@o.print @t
-@o.print "\n"
-@o.print 'end'
-@o.print "\n"
+scan '.syntax'
+if @match
+scan /[A-Za-z]+[A-Za-z0-9_]+/
+report_error() unless @match
+@out.print '#!/usr/bin/env ruby'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'require "strscan"'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'class StringScanner'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  # Add scan for string since base StringScanner lack that...'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def scan_str(string)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    return nil unless self.peek(string.length) == string'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    self.pos += string.length           # Advance the position in the input string'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    return string'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  alias :old_scan :scan'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def scan(strOrRegexp)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    String === strOrRegexp ? scan_str(strOrRegexp) : old_scan(strOrRegexp)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'class MetaCompiler_'    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  $compiler_class = self # Save class in global var for later reference below'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def compile_string(string, outFile)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    @in, @out = StringScanner.new(string), outFile'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    compile_'    # Print literal string on output stream
+@out.print @match   # Print last matched token on output stream
+@out.print ' # call the main compile method to start compiling'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  # Scan for a string or regexp and update state based on match. Skips leading whitespace.'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def scan strOrRegexp'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    @in.scan /\s*/   # Skip whitespace'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    @match = @in.scan strOrRegexp'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    # Since nil is same as false in Ruby we can set the flag to the matched token'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    @last_matched_token = @match if @match # Update last matched only if a token was matched'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def report_error'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    pre_lines = @in.string[0, @in.pos].split("\n") # lines of input up to current position'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    post_lines = @in.rest.split("\n")              # lines of input after current position'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    message = "PARSE ERROR at line #{pre_lines.length}:\n  " + pre_lines.last.inspect + " @ "'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    message += post_lines.first.inspect'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    message += "\n  Last matched token: #{@last_matched_token}"'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    raise message'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  def self.compile_file(inFile, out = nil)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    outfh = (out == nil ? STDOUT : File.open(out, "w"))'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    self.new.compile_string(File.read(inFile), outfh)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '    outfh.close if out == nil'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
 begin
-compile_rule
-end while @f
-@f = true
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@i.scan /\s*/; s='.end'; l=s.length;
-@f = (@i.peek(l) == s) ? (@t=s; @i.pos += l) : nil
-raise("error at: " + @i.rest.split("\n")[0]) if !@f
-@o.print 'end'
-@o.print "\n"
-@o.print '$c.new.compile(File.read(ARGV[0]), STDOUT)'
-@o.print "\n"
-end
-end while false
-end
-end
-$c.new.compile(File.read(ARGV[0]), STDOUT)
+compile_rule     # Call the method for a rule
+end while @match              # Loop while there is a match
+@match = true                 # Since also zero matches is ok set flag here.
+report_error() unless @match
+scan '.end'
+report_error() unless @match
+@out.print 'end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'if ARGV.length < 1 || ARGV.length > 2'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  puts "ERROR: wrong number of parameters\n\n"'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  puts "Usage: #{File.basename($0)} <input_file> [output_file]"'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  exit(-1)'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'else'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print '  $compiler_class.compile_file(ARGV[0], ARGV[1])'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+@out.print 'end'    # Print literal string on output stream
+@out.print "\n"     # Print newline on output stream
+end
+end while false  # This "while false" is needed since the break is not parsed correctly by Ruby otherwise
+end
+end
+if ARGV.length < 1 || ARGV.length > 2
+  puts "ERROR: wrong number of parameters\n\n"
+  puts "Usage: #{File.basename($0)} <input_file> [output_file]"
+  exit(-1)
+else
+  $compiler_class.compile_file(ARGV[0], ARGV[1])
+end