]> git.wincent.com - walrat.git/blob - lib/walrat/parslet_repetition_default.rb
Initial import (extraction from Walrus repo, commit 0c9d44c)
[walrat.git] / lib / walrat / parslet_repetition_default.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   # ParsletRepetitionDefault is a subclass that modifies the behaviour of its
27   # parent, ParsletRepetition, in a very small way. Namely, if the outcome of
28   # parsing is a ZeroWidthParse success then it is caught and the default value
29   # (defined at initialization time) is returned instead.
30   class ParsletRepetitionDefault < ParsletRepetition
31     # Possible re-factoring to consider for the future: roll the functionality
32     # of this class in to ParsletRepetition itself.
33     # Benefit of keeping it separate is that the ParsletRepetition itself is
34     # kept simple.
35     def initialize parseable, min, max = nil, default = nil
36       super parseable, min, max
37       self.default  = default
38     end
39
40     def parse string, options = {}
41       catch :ZeroWidthParseSuccess do
42         return super string, options
43       end
44       @default.clone rescue @default
45     end
46
47     def eql?(other)
48       other.instance_of? ParsletRepetitionDefault and
49         @min == other.min and
50         @max == other.max and
51         @parseable.eql? other.parseable and
52         @default == other.default
53     end
54
55   protected
56
57     # For determining equality.
58     attr_reader :default
59
60   private
61
62     def hash_offset
63       69
64     end
65
66     def update_hash
67       # let super calculate its share of the hash first
68       @hash = super + @default.hash
69     end
70
71     def default=(default)
72       @default = (default.clone rescue default)
73       @default.extend LocationTracking
74       update_hash
75     end
76   end # class ParsletRepetitionDefault
77 end # module Walrat