walrat 0.1

data/lib/walrat/skipped_substring_exception.rb

@@ -0,0 +1,46 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'walrat'
+
+module Walrat
+  # I don't really like using Exceptions for non-error situations, but it seems
+  # that using throw/catch here would not be adequate (not possible to embed
+  # information in the thrown symbol).
+  class SkippedSubstringException < Exception
+    include Walrat::LocationTracking
+
+    def initialize substring, info = {}
+      super substring
+
+      # TODO: this code is just like the code in ParseError. could save
+      # repeating it by setting up inheritance but would need to pay careful
+      # attention to the ordering of my rescue blocks and also change many
+      # instances of "kind_of" in my specs to "instance_of "
+      # alternatively, could look at using a mix-in
+      self.line_start     = info[:line_start]
+      self.column_start   = info[:column_start]
+      self.line_end       = info[:line_end]
+      self.column_end     = info[:column_end]
+    end
+  end # class SkippedSubstringException
+end # module Walrat

data/lib/walrat/string_enumerator.rb

@@ -0,0 +1,47 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'strscan'
+require 'walrat'
+
+module Walrat
+  # Unicode-aware (UTF-8) string enumerator.
+  # For Unicode support $KCODE must be set to 'U' (UTF-8).
+  class StringEnumerator
+    # Returns the char most recently scanned before the last "next" call, or
+    # nil if nothing previously scanned.
+    attr_reader :last
+
+    def initialize string
+      raise ArgumentError, 'nil string' if string.nil?
+      @scanner  = StringScanner.new string
+      @current  = nil
+      @last     = nil
+    end
+
+    # This method will only work as expected if $KCODE is set to 'U' (UTF-8).
+    def next
+      @last     = @current
+      @current  = @scanner.scan(/./m) # must use multiline mode or "." won't match newlines
+    end
+  end # class StringEnumerator
+end # module Walrus

data/lib/walrat/string_parslet.rb

@@ -0,0 +1,89 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'walrat'
+
+module Walrat
+  class StringParslet < Parslet
+    attr_reader :hash
+
+    def initialize string
+      raise ArgumentError if string.nil?
+      self.expected_string = string
+    end
+
+    def parse string, options = {}
+      raise ArgumentError if string.nil?
+      chars         = StringEnumerator.new string
+      parsed        = StringResult.new
+      parsed.start  = [options[:line_start], options[:column_start]]
+      parsed.end    = parsed.start
+      expected_string.each_char do |expected_char|
+        actual_char = chars.next
+        if actual_char.nil?
+          raise ParseError.new('unexpected end-of-string (expected "%s") while parsing "%s"' %
+                               [ expected_char, expected_string ],
+                               :line_end    => parsed.line_end,
+                               :column_end  => parsed.column_end)
+        elsif actual_char != expected_char
+          raise ParseError.new('unexpected character "%s" (expected "%s") while parsing "%s"' %
+                               [ actual_char, expected_char, expected_string],
+                               :line_end    => parsed.line_end,
+                               :column_end  => parsed.column_end)
+        else
+          if actual_char == "\r" or
+            (actual_char == "\n" and chars.last != "\r")  # catches Mac, Windows and UNIX end-of-line markers
+            parsed.column_end = 0
+            parsed.line_end   = parsed.line_end + 1
+          elsif actual_char != "\n"                     # \n is ignored if it is preceded by an \r (already counted above)
+            parsed.column_end = parsed.column_end + 1   # everything else gets counted
+          end
+          parsed << actual_char
+        end
+      end
+      parsed.source_text = parsed.to_s.clone
+      parsed
+    end
+
+    def eql?(other)
+      other.instance_of? StringParslet and
+        other.expected_string == @expected_string
+    end
+
+  protected
+
+    # For equality comparisons.
+    attr_reader :expected_string
+
+  private
+
+    def expected_string=(string)
+      @expected_string = (string.clone rescue string)
+      update_hash
+    end
+
+    def update_hash
+      # fixed offset to avoid collisions with @parseable objects
+      @hash = @expected_string.hash + 20
+    end
+  end # class StringParslet
+end # module Walrat

data/lib/walrat/string_result.rb

@@ -0,0 +1,34 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'walrat'
+
+module Walrat
+  class StringResult < String
+    include Walrat::LocationTracking
+
+    def initialize string = ""
+      self.source_text = string
+      super
+    end
+  end # class StringResult
+end # module Walrat

data/lib/walrat/symbol_parslet.rb

@@ -0,0 +1,82 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'walrat'
+
+module Walrat
+  # A SymbolParslet allows for evaluation of a parslet to be deferred until
+  # runtime (or parse time, to be more precise).
+  class SymbolParslet < Parslet
+    attr_reader :hash
+
+    def initialize symbol
+      raise ArgumentError, 'nil symbol' if symbol.nil?
+      @symbol = symbol
+
+      # fixed offset to avoid collisions with @parseable objects
+      @hash = @symbol.hash + 20
+    end
+
+    # SymbolParslets don't actually know what Grammar they are associated with
+    # at the time of their definition. They expect the Grammar to be passed in
+    # with the options hash under the ":grammar" key.
+    # Raises if string is nil, or if the options hash does not include a
+    # :grammar key.
+    def parse string, options = {}
+      raise ArgumentError if string.nil?
+      raise ArgumentError unless options.has_key?(:grammar)
+      grammar = options[:grammar]
+      augmented_options = options.clone
+      augmented_options[:rule_name] = @symbol
+      augmented_options[:skipping_override] = grammar.skipping_overrides[@symbol] if grammar.skipping_overrides.has_key?(@symbol)
+      result = grammar.rules[@symbol].memoizing_parse(string, augmented_options)
+      grammar.wrap(result, @symbol)
+    end
+
+    # We override the to_s method as it can make parsing error messages more
+    # readable. Instead of messages like this:
+    #
+    #   predicate not satisfied (expected "#<Walrat::SymbolParslet:0x10cd504>")
+    #   while parsing "hello world"
+    #
+    # We can print messages like this:
+    #
+    #   predicate not satisfied (expected "rule: end_of_input") while parsing
+    #   "hello world"
+    def to_s
+      'rule: ' + @symbol.to_s
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      other.instance_of? SymbolParslet and other.symbol == @symbol
+    end
+
+  protected
+
+    # For equality comparisons.
+    attr_reader :symbol
+  end # class SymbolParslet
+end # module Walrat

data/lib/walrat/version.rb

@@ -0,0 +1,26 @@
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+module Walrat
+  VERSION   = '0.1'
+  COPYRIGHT = 'Copyright 2007-2010 Wincent Colaiuta'
+end # module Walrat

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: walrat
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Wincent Colaiuta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: "    Walrat is a Parsing Expression Grammar (PEG) parser generator that\n    creates integrated lexers, \"packrat\" parsers, and Abstract Syntax Tree\n    (AST) builders.\n"
+email: win@wincent.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/walrat/additions/proc.rb
+- lib/walrat/additions/regexp.rb
+- lib/walrat/additions/string.rb
+- lib/walrat/additions/symbol.rb
+- lib/walrat/and_predicate.rb
+- lib/walrat/array_result.rb
+- lib/walrat/continuation_wrapper_exception.rb
+- lib/walrat/grammar.rb
+- lib/walrat/left_recursion_exception.rb
+- lib/walrat/location_tracking.rb
+- lib/walrat/match_data_wrapper.rb
+- lib/walrat/memoizing.rb
+- lib/walrat/memoizing_cache.rb
+- lib/walrat/no_parameter_marker.rb
+- lib/walrat/node.rb
+- lib/walrat/not_predicate.rb
+- lib/walrat/parse_error.rb
+- lib/walrat/parser_state.rb
+- lib/walrat/parslet.rb
+- lib/walrat/parslet_choice.rb
+- lib/walrat/parslet_combination.rb
+- lib/walrat/parslet_combining.rb
+- lib/walrat/parslet_merge.rb
+- lib/walrat/parslet_omission.rb
+- lib/walrat/parslet_repetition.rb
+- lib/walrat/parslet_repetition_default.rb
+- lib/walrat/parslet_sequence.rb
+- lib/walrat/predicate.rb
+- lib/walrat/proc_parslet.rb
+- lib/walrat/regexp_parslet.rb
+- lib/walrat/skipped_substring_exception.rb
+- lib/walrat/string_enumerator.rb
+- lib/walrat/string_parslet.rb
+- lib/walrat/string_result.rb
+- lib/walrat/symbol_parslet.rb
+- lib/walrat/version.rb
+- lib/walrat.rb
+has_rdoc: true
+homepage: https://wincent.com/products/walrat
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: walrus
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Object-oriented templating system
+test_files: []
+