@@ -19,129 +19,3 @@ If a grammar by the name of `Foo` is defined, the compiled Ruby source will defi else puts 'failure' end - -##Defining Grammars Directly in Ruby -It is possible to define parser directly in Ruby source file. - -###Grammars -Defining parsers in Ruby code is as much similar to original definition as it is possible. To create a grammar just write: - - include Treetop::Syntax - grammar :Foo do - end - parser = FooParser.new - -Treetop will automatically compile and load it into memory, thus an instance of `FooParser` can be created. - -###Syntactic Recognition -To create a rule inside of a grammar simply write: - - include Treetop::Syntax - grammar :Foo do - rule :bar do - ... - end - end - -Inside the rule any of Treetop syntactic elements can be used. Each element of a rule is created with standard Ruby classes: Strings act as Terminals, Symbols stand for Nonterminals, Arrays are sequences, Regexps are character classes. - -_Note: it is better not to use Numbers, as terminal symbols; use Strings instead._ - -Sequences can be defined as follows: - - rule :sequence do - [ "foo", "bar", "baz" ] - end - -Ordered choices use `/` operator: - - rule :choice do - "foo" / "bar" - end - -Sequences have higher precedence than choices, so choices must be parenthesized to be used as the elements of a sequence. For example: - - rule :nested do - ["foo", "bar", "baz" / "bop" ] # -> "foo" "bar" ( "baz" / "bop" ) - end - -Special operators like `!`, `&`, `?`, `+` and `*` are available through methods (all of the methods return element itself so calls can be chained) of elements in a rule: - - Op. | Method - ----------- - ! | bang - & | amper - ? | mark - + | plus - * | kleene - -For example grammar: - - grammar :Foo do - rule :bar do - [ "baz" / "bop" ].kleene - end - end - -can generate any word that contain words "bar" and "bop". - -###Semantic Interpretation - -Syntax node declaration can be added by `node` method (which may be called the same as operators above): - - grammar :Parens do - rule :parenthesized_letter do - ([ '(', :parenthesized_letter, ')'] / /[a-z]/ ).node(:ParenNode) - end - end - -It is also possible to add inline blocks of code. They are in fact strings strictly inserted into generated grammar: - - grammar :Parens do - rule :parenthesized_letter do - (['(', :parenthesized_letter, ')'] / /[a-z]/ ).block(%{ - def depth - if nonterminal? - parenthesized_letter.depth + 1 - else - 0 - end - end - }) - end - end - -Labels in rule definitions can be written as follow (example taken from documentation): - - rule :labels do - [/[a-z]/.label(:first_letter), [', ', /[a-z]/.kleene.label(:letter)].label(:rest_letters)].block(%{ - ... - }) - end - -###Composition - -Inclusion of a grammar works thanks to `include` function call inside the grammar definition: - - grammar :One do - rule :a do - foo" - end - - rule :b do - "baz" - end - end - - grammar :Two do - include :One - rule :a do - :super / "bar" / :c - end - - rule :c do - :b - end - end - -Grammar Two can generate `"foo"`, `"bar"` and `"baz"` words. doc/using_in_ruby.markdown @@ -11,7 +11,6 @@ TREETOP_ROOT = File.join(dir, 'treetop') require File.join(TREETOP_ROOT, "ruby_extensions") require File.join(TREETOP_ROOT, "runtime") require File.join(TREETOP_ROOT, "compiler") -require File.join(TREETOP_ROOT, "syntax") require 'polyglot' Polyglot.register(Treetop::VALID_GRAMMAR_EXT, Treetop) lib/treetop.rb @@ -1,4 +1,2 @@ dir = File.dirname(__FILE__) -Dir.glob("#{dir}/ruby_extensions/*.rb").each do |file| - require file -end +require "#{dir}/ruby_extensions/string" \ No newline at end of file lib/treetop/ruby_extensions.rb @@ -8,7 +8,7 @@ class String index + 1 end end - + def line_of(index) self[0...index].count("\n") + 1 end @@ -36,33 +36,7 @@ class String end end - def indent_paragraph(n) - out = "" - self.each_line {|line| out += line.indent(n) } - out - end - - # Removes indentation uniformly. - def justify - min = self.length - self.each_line {|line| - next if line.strip == "" - if line =~ /^( *)\S/ - min = $1.length if min > $1.length - else - min = 0 - end - } - out = "" - self.each_line {|line| out += line.slice(min...line.length) || "\n" } - out.strip - end - def treetop_camelize to_s.gsub(/\/(.?)/){ "::" + $1.upcase }.gsub(/(^|_)(.)/){ $2.upcase } end - - def to_tt - "'#{self}'" - end -end +end \ No newline at end of file lib/treetop/ruby_extensions/string.rb @@ -2,7 +2,7 @@ module Treetop #:nodoc: module VERSION #:nodoc: MAJOR = 1 MINOR = 4 - TINY = 1 + TINY = 2 STRING = [MAJOR, MINOR, TINY].join('.') end lib/treetop/version.rb examples/ruby_syntax/syntax_test.rb examples/ruby_syntax/test_helper.rb lib/treetop/ruby_extensions/array.rb lib/treetop/ruby_extensions/nil.rb lib/treetop/ruby_extensions/object.rb lib/treetop/ruby_extensions/regexp.rb lib/treetop/ruby_extensions/symbol.rb lib/treetop/syntax.rb a1450e84df5ce30d46d026b63d37288f519faeb2 Clifford Heath clifford.heath@gmail.com http://github.com/nathansobo/treetop/commit/523f83c903be832aeb56f28edd8c12e1e1a28c59 523f83c903be832aeb56f28edd8c12e1e1a28c59 2009-09-10T16:25:50-07:00 2009-09-10T16:25:50-07:00 Removed Dawid Fatyga's Treetop-in-Ruby because it breaks core classes cf3708337439e36b6bd6cf51a134e61318d061c8 Clifford Heath clifford.heath@gmail.com