]> git.wincent.com - walrat.git/blob - lib/walrat/predicate.rb
Initial import (extraction from Walrus repo, commit 0c9d44c)
[walrat.git] / lib / walrat / predicate.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   # Predicates parse input without consuming it.
27   # On success they throw a subclass-specific symbol (see the AndPredicate and
28   # NotPredicate classes).
29   # On failure they raise a ParseError.
30   class Predicate
31     include Walrat::ParsletCombining
32     include Walrat::Memoizing
33
34     attr_reader :hash
35
36     # Raises if parseable is nil.
37     def initialize parseable
38       raise ArgumentError, 'nil parseable' if parseable.nil?
39       @parseable = parseable
40
41       # fixed offset to avoid collisions with @parseable objects
42       @hash = @parseable.hash + hash_offset
43     end
44
45     def to_parseable
46       self
47     end
48
49     def parse string, options = {}
50       raise NotImplementedError # subclass responsibility
51     end
52
53     def eql? other
54       other.instance_of? self.class and other.parseable.eql? @parseable
55     end
56
57   protected
58
59     # for equality comparisons
60     attr_reader :parseable
61
62   private
63
64     def hash_offset
65       10
66     end
67   end
68 end # module Walrat