]> git.wincent.com - walrat.git/blob - lib/walrat/symbol_parslet.rb
Initial import (extraction from Walrus repo, commit 0c9d44c)
[walrat.git] / lib / walrat / symbol_parslet.rb
1 # Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
2 # Redistribution and use in source and binary forms, with or without
3 # modification, are permitted provided that the following conditions are met:
4 #
5 # 1. Redistributions of source code must retain the above copyright notice,
6 #    this list of conditions and the following disclaimer.
7 # 2. Redistributions in binary form must reproduce the above copyright notice,
8 #    this list of conditions and the following disclaimer in the documentation
9 #    and/or other materials provided with the distribution.
10 #
11 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
12 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
13 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
15 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
16 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
17 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
18 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
19 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
20 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
21 # POSSIBILITY OF SUCH DAMAGE.
22
23 require 'walrat'
24
25 module Walrat
26   # A SymbolParslet allows for evaluation of a parslet to be deferred until
27   # runtime (or parse time, to be more precise).
28   class SymbolParslet < Parslet
29     attr_reader :hash
30
31     def initialize symbol
32       raise ArgumentError, 'nil symbol' if symbol.nil?
33       @symbol = symbol
34
35       # fixed offset to avoid collisions with @parseable objects
36       @hash = @symbol.hash + 20
37     end
38
39     # SymbolParslets don't actually know what Grammar they are associated with
40     # at the time of their definition. They expect the Grammar to be passed in
41     # with the options hash under the ":grammar" key.
42     # Raises if string is nil, or if the options hash does not include a
43     # :grammar key.
44     def parse string, options = {}
45       raise ArgumentError if string.nil?
46       raise ArgumentError unless options.has_key?(:grammar)
47       grammar = options[:grammar]
48       augmented_options = options.clone
49       augmented_options[:rule_name] = @symbol
50       augmented_options[:skipping_override] = grammar.skipping_overrides[@symbol] if grammar.skipping_overrides.has_key?(@symbol)
51       result = grammar.rules[@symbol].memoizing_parse(string, augmented_options)
52       grammar.wrap(result, @symbol)
53     end
54
55     # We override the to_s method as it can make parsing error messages more
56     # readable. Instead of messages like this:
57     #
58     #   predicate not satisfied (expected "#<Walrat::SymbolParslet:0x10cd504>")
59     #   while parsing "hello world"
60     #
61     # We can print messages like this:
62     #
63     #   predicate not satisfied (expected "rule: end_of_input") while parsing
64     #   "hello world"
65     def to_s
66       'rule: ' + @symbol.to_s
67     end
68
69     def ==(other)
70       eql?(other)
71     end
72
73     def eql?(other)
74       other.instance_of? SymbolParslet and other.symbol == @symbol
75     end
76
77   protected
78
79     # For equality comparisons.
80     attr_reader :symbol
81   end # class SymbolParslet
82 end # module Walrat