raabro 1.0.3 → 1.0.4

data/CHANGELOG.txt

@@ -2,6 +2,11 @@
 = raabro CHANGELOG.txt
 
 
+== raabro 1.0.4  released 2015-09-24
+
+- provide a default .rewrite implementation
+
+
 == raabro 1.0.3  released 2015-09-23
 
 - drop the shrink! concept

data/README.md

@@ -6,7 +6,95 @@
 
 A very dumb PEG parser library.
 
-Son to [aabro](https://github.com/flon-io/aabro), grandson to [neg](https://github.com/jmettraux/neg).
+Son to [aabro](https://github.com/flon-io/aabro), grandson to [neg](https://github.com/jmettraux/neg), grand-grandson to [parslet](https://github.com/kschiess/parslet).
+
+
+## a sample parser/rewriter
+
+You use raabro by providing the parsing rules, then some rewrite rules.
+
+The parsing rules make use of the raabro basic parsers `seq`, `alt`, `str`, `rex`, `eseq`, ...
+
+The rewrite rules match names passed as first argument to the basic parsers to rewrite the resulting parse trees.
+
+```ruby
+require 'raabro'
+
+
+module Fun include Raabro
+
+  # parse
+  #
+  # Last function is the root, "i" stands for "input".
+
+  def pa(i); rex(nil, i, /\(\s*/); end
+  def pz(i); rex(nil, i, /\)\s*/); end
+  def com(i); rex(nil, i, /,\s*/); end
+
+  def num(i); rex(:num, i, /-?[0-9]+\s*/); end
+
+  def args(i); eseq(:args, i, :pa, :exp, :com, :pz); end
+  def funame(i); rex(:funame, i, /[a-z][a-z0-9]*/); end
+  def fun(i); seq(:fun, i, :funame, :args); end
+
+  def exp(i); alt(:exp, i, :fun, :num); end
+
+  # rewrite
+  #
+  # Names above (:num, :fun, ...) get a rewrite_xxx function.
+  # "t" stands for "tree".
+
+  def rewrite_exp(t); rewrite(t.children[0]); end
+  def rewrite_num(t); t.string.to_i; end
+
+  def rewrite_fun(t)
+    [ t.children[0].string ] +
+    t.children[1].children.inject([]) { |a, e| a << rewrite(e) if e.name; a }
+  end
+end
+
+
+p Fun.parse('mul(1, 2)')
+  # => ["mul", 1, 2]
+
+p Fun.parse('mul(1, add(-2, 3))')
+  # => ["mul", 1, ["add", -2, 3]]
+
+p Fun.parse('mul (1, 2)')
+  # => nil (doesn't accept a space after the function name)
+```
+
+This sample is available at: [doc/readme0.rb](doc/readme0.rb).
+
+
+## basic parsers
+
+The first parameter is the name used by rewrite rules.
+The second parameter is a `Raabro::Input` instance, mostly a wrapped string.
+
+```ruby
+def seq(name, input, *parsers)
+  # a sequence of parsers
+
+def alt(name, input, *parsers)
+  # tries the parsers returns as soon as one succeeds
+
+def altg(name, input, *parsers)
+  # tries all the parsers, returns with the longest match
+
+def rep(name, input, parser, min, max=0)
+  # repeats the the wrapped parser
+
+def ren(name, input, parser)
+  # renames the output of the wrapped parser
+
+def jseq(name, input, eltpa, seppa)
+  # seq(name, input, eltpa, seppa, eltpa, seppa, eltpaa, seppa, ...)
+
+def eseq(name, input, startpa, eltpa, seppa, endpa)
+  # seq(name, input, startpa, eltpa, seppa, eltpa, seppa, ..., endpa)
+```
+
 
 ## LICENSE
 

data/lib/raabro.rb

@@ -26,7 +26,7 @@
 
 module Raabro
 
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 
   class Input
 
@@ -388,6 +388,17 @@ module Raabro
     end
     alias jseq eseq
 
+    attr_accessor :last
+
+    def method_added(name)
+
+      m = method(name)
+      return unless m.arity == 1
+      return unless m.parameters[0][1] == :i || m.parameters[0][1] == :input
+
+      @last = name.to_sym
+    end
+
     def parse(input, opts={})
 
       opts[:prune] = true unless opts.has_key?(:prune)
@@ -405,20 +416,17 @@ module Raabro
 
       t = t.children.first if t.parter == :all
 
-      return rewrite(t) if opts[:rewrite] != false && respond_to?(:rewrite)
+      return rewrite(t) if opts[:rewrite] != false && rewrite(0) == true
 
       t
     end
 
-    attr_accessor :last
+    def rewrite(tree)
 
-    def method_added(name)
+      return !! methods.find { |m| m.to_s.match(/^rewrite_/) } if tree == 0
+        # return true when "rewrite_xxx" methods seem to have been provided
 
-      m = method(name)
-      return unless m.arity == 1
-      return unless m.parameters[0][1] == :i || m.parameters[0][1] == :input
-
-      @last = name.to_sym
+      send("rewrite_#{tree.name}", tree)
     end
   end
   extend ModuleMethods

data/spec/sample_xel_spec.rb

@@ -10,7 +10,7 @@ require 'spec_helper'
 
 module Sample::Xel include Raabro
 
-  # parser
+  # parse
 
   def pa(i); str(nil, i, '('); end
   def pz(i); str(nil, i, ')'); end
@@ -27,19 +27,14 @@ module Sample::Xel include Raabro
   #alias root exp
     # not necessary since Raabro takes the last defined parser as the root
 
-  def rewrite(tree)
-
-    case tree.name
-      when :exp
-        rewrite tree.children.first
-      when :num
-        tree.string.to_i
-      when :fun
-        [ tree.children[0].string ] +
-        tree.children[1].children.select(&:name).collect { |e| rewrite(e) }
-      else
-        fail ArgumentError.new("cannot rewrite #{tree.to_a.inspect}")
-    end
+  # rewrite
+
+  def rewrite_exp(t); rewrite(t.children[0]); end
+  def rewrite_num(t); t.string.to_i; end
+
+  def rewrite_fun(t)
+    [ t.children[0].string ] +
+    t.children[1].children.inject([]) { |a, e| a << rewrite(e) if e.name; a }
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raabro
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors: