@@ -4,10 +4,10 @@ Treetop.load_from_string <<-GRAMMAR module SimpleAssignment grammar Grammar rule assignment - lhs:variable space* "=" space* rhs:variable <create_node(:assignment)> + lhs:variable space* "=" space* rhs:variable <node(:assignment)> end rule variable - [a-z]+ <create_node(:variable)> + [a-z]+ <node(:variable)> end rule space [ ]+ examples/simple_assignment.rb @@ -17,7 +17,7 @@ module TireSwing::NodeDefinition # You can define the grammar as # # rule variable - # [a-z]+ <create_node(:variable)> + # [a-z]+ <node(:variable)> # end # # Also note that you can specify alternate namespaces: @@ -28,6 +28,16 @@ module TireSwing::NodeDefinition # # <AST.create_node(:variable)> # + # When you're using the parser extension: + # + # TireSwing.parses_grammar(Grammar, AST) + # + # you can use + # + # <node(...)> + # + # Which is an instance method wrapper for the create_node class method. + # def create_node(name) TireSwing::NodeCreator.new(name, const_get(name.to_s.camelize)) end @@ -82,7 +92,7 @@ module TireSwing::NodeDefinition # Simple example: # # rule assignment - # variable:lhs "=" variable:rhs <create_node(:assignment)> + # variable:lhs "=" variable:rhs <node(:assignment)> # end # rule variable # [a-z]+ @@ -109,7 +119,7 @@ module TireSwing::NodeDefinition # arrays of different kind of nodes, some of which you want to ignore, e.g.: # # rule assignments - # assignment* <create_node(:assignments)> + # assignment* <node(:assignments)> # end # # node :assignments, :assignments => array_of(:assignment) @@ -177,20 +187,13 @@ module TireSwing::NodeDefinition end - # Include this module to get access to the node and create_node methods. - # A good place to include this is in a separate AST module, e.g. + # Include this module to get access to the node and create_node class methods. # # module AST # include NodeDefinition # node :foo # end # - # And then in your grammar: - # - # rule foo - # "foo" <AST.create_node(:foo)> - # end - # def self.included(base) base.extend ModuleMethods end lib/tire_swing/node_definition.rb @@ -17,8 +17,8 @@ module TireSwing # Extends the treetop-provided grammar parser with a .ast class method for simple parsing and building of # an AST defined by TireSwing. Takes the grammar module as an argument. # - # Additionally, in case you are using bare <create_node(...)> calls in your grammar, this defines a method on - # the grammar parser to delegate to the grammar so create_node calls happen correctly. + # Additionally, this defines a #node method on the grammar to delegate to the class or the AST to create + # new nodes, e.g. <node(:variable)> instead of <AST.create_node(:variable)> # # You can specify an alternate module which contains the AST if desired. def self.parses_grammar(grammar, ast=nil) @@ -26,7 +26,7 @@ module TireSwing ast ||= grammar parser.module_eval do extend ParserExtension - define_method(:create_node) { |*args| ast.create_node(*args) } + define_method(:node) { |*args| ast.create_node(*args) } end end lib/tire_swing/parser_extension.rb @@ -5,15 +5,15 @@ Treetop.load_from_string <<-GRAMMAR module Lists grammar Grammar rule lists - (list [\n])+ <create_node(:lists)> + (list [\n])+ <node(:lists)> end rule list - "[" whitespace* number ("," whitespace* number)* "]" <create_node(:list)> + "[" whitespace* number ("," whitespace* number)* "]" <node(:list)> end rule number - [1-9] [0-9]* <create_node(:number)> + [1-9] [0-9]* <node(:number)> end rule whitespace spec/grammars/lists.rb @@ -5,10 +5,10 @@ Treetop.load_from_string <<-GRAMMAR module MagicAssignments grammar Grammar rule assignments - ( blank_line / assignment )* <create_node(:assignments)> + ( blank_line / assignment )* <node(:assignments)> end rule assignment - lhs:variable whitespace* "=" whitespace* rhs:variable [\\n] <create_node(:assignment)> + lhs:variable whitespace* "=" whitespace* rhs:variable [\\n] <node(:assignment)> end rule variable [a-z]+ spec/grammars/magic.rb @@ -16,16 +16,16 @@ describe TireSwing::ParserExtension do FooParser.should respond_to(:ast) end - it "defines a create_node method on the parser that delegates to the grammar" do + it "defines a node method on the parser that delegates to the grammar" do TireSwing.parses_grammar(Foo) Foo.should_receive(:create_node).with("a", "b", "c") - FooParser.new.create_node("a", "b", "c") + FooParser.new.node("a", "b", "c") end it "defines a create_node method on the parser that delegates to the given AST, if provided" do TireSwing.parses_grammar(Foo, AST) AST.should_receive(:create_node).with("a", "b", "c") - FooParser.new.create_node("a", "b", "c") + FooParser.new.node("a", "b", "c") end end @@ -37,10 +37,10 @@ describe TireSwing::ParserExtension do module TestGramma grammar Grammar rule letters - letter* <create_node(:letters)> + letter* <node(:letters)> end rule letter - value:[a-z] [\n]? <create_node(:letter)> + value:[a-z] [\n]? <node(:letter)> end end end spec/parser_extension_spec.rb 3f498bf0a085b2aaae470f109f0f4020d3265172 Nathan Witmer nwitmer@gmail.com http://github.com/aniero/tire_swing/commit/66662475c9179d39547b397172f53c36882c9c5a 66662475c9179d39547b397172f53c36882c9c5a 2008-08-11T06:59:45-07:00 2008-08-11T06:59:45-07:00 Replaced #create_node helper in grammar with #node and updated documentation. 8ec03608777e97e58fd72b82a905f3618899e321 Nathan Witmer nwitmer@gmail.com