aboutsummaryrefslogtreecommitdiff
path: root/src/parcom.cr
blob: b6e6c3b76a7622a747a6e7227a4573947c54e373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
require "./parcom/*"

module Parcom
  VERSION = "0.1.0"

  # A ParserFail exception should be raised by `Parser#parse` when
  # a parse attempt is unsuccessful.
  # Raising this exception in the `#parse` method of a Parser "Foo"
  # usually follows this pattern to allow for error tracing:
  #
  # ```
  # class Foo(T, V) < Parser(T, V)
  #   def parse(tokens : Tokens(T)) : Result(T, V)
  #     helper.parse(tokens)
  #   rescue ex : ParserFail
  #     raise ParserFail.new("Foo: #{ex.message}")
  #   end
  # ```
  class ParserFail < Exception
  end

  # `Tokens` is an `Array` wrapper struct to store the input
  # stream of one or more `Parser` objects.
  # A `Tokens` can be created from any `Iterable`, along with
  # `String` objects using a special constructor.
  struct Tokens(T)
    getter tokens

    # Constructs a `Tokens(Char)` from a `String`.
    def self.from_string(s : String) : Tokens(Char)
      Tokens.new(s.chars)
    end

    # Constructs a `Tokens` from an `Iterable`.
    def initialize(ts : Iterable(T))
      if ts.responds_to?(:to_a)
        @tokens = ts.to_a
      else
        @tokens = [] of T
        ts.each { |t| @tokens << t }
      end
    end

    # Exposes `Array#[](Int)`.
    def [](index : Int) : T
      @tokens[index]
    end

    # Exposes `Array#[](Int, Int)`, but wraps the returned array in a new `Tokens`.
    def [](start : Int, count : Int) : Tokens(T)
      Tokens.new(@tokens[start, count])
    end

    # Exposes `Array#[](Range)`, but wraps the returned array in a new `Tokens`.
    def [](range : Range) : Tokens(T)
      Tokens.new(@tokens[range])
    end

    # Like `#[]`, but returns `nil` instead of raising an `IndexError`.
    def []?(*args)
      self.[](*args)
    rescue IndexError
      nil
    end

    # Exposes `Array#empty?`.
    def empty? : Bool
      @tokens.empty?
    end
  end

  # A `Result` stores a `Tokens` object and a parsed value,
  # and is effectively used to store the state of a parser chain.
  # This is used instead of a `Tuple` or `NamedTuple` because:
  #   1. This is more idiomatic than a `Tuple`.
  #   2. Crystal does not support generic named tuples.
  struct Result(T, V)
    getter tokens, value

    def initialize(@tokens : Tokens(T), @value : V)
    end
  end

  class TokenSeq(T) < Parser(T, Array(T))
    @p : Sequence(T, T)

    def initialize(expected : Iterable(T))
      ps = [] of Parser(T, T)
      expected.each { |t| ps << Token.new(t) }

      @p = Sequence.new(ps)
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(T))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("TokenSeq: #{ex.message}")
    end
  end

  class Exactly(T, V) < Parser(T, Array(V))
    @p : Sequence(T, V)

    def initialize(i : Int, p : Parser(T, V))
      i = i.negative? ? 0 : i
      @p = Sequence.new(([p] of Parser(T, V)) * i)
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(V))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("Exactly: #{ex.message}")      
    end
  end

  class AtLeast(T, V) < Parser(T, Array(V))
    @p : Map(T, {Array(V), Array(V)}, Array(V))

    def initialize(i : Int, p : Parser(T, V))
      @p = (Exactly.new(i, p) + Many.new(p)).map do |tup|
        tup[0] + tup[1]
      end
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(V))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("AtLeast: #{ex.message}")
    end
  end

  class AtMost(T, V) < Parser(T, Array(V))
    @p : Map(T, Array(V?), Array(V))

    def initialize(i : Int, p : Parser(T, V))
      @p = Exactly.new(i, Optional.new(p)).map(&.compact)
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(V))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("AtMost: #{ex.message}")
    end
  end

  class Between(T, V) < Parser(T, Array(V))
    @p : Map(T, {Array(V), Array(V)}, Array(V))

    def initialize(i : Int, j : Int, p : Parser(T, V))
      lower = i < j ? i : j
      upper = (i - j).abs
      @p = (Exactly.new(lower, p) + AtMost.new(upper, p)).map do |tup|
        tup[0] + tup[1]
      end
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(V))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("Between: #{ex.message}")
    end
  end

  class FirstOf(T, V) < Parser(T, V)
    @p : Parser(T, V)

    def initialize(ps : Iterable(Parser(T, V)))
      ps_iter = ps.each
      p = ps_iter.next

      if p.is_a?(Iterator::Stop)
        raise ArgumentError.new("FirstOf requires atleast one parser, got none")
      end

      @p = p
      p = ps_iter.next

      until p.is_a?(Iterator::Stop)
        @p = @p | p
        p = ps_iter.next
      end
    end

    def parse(tokens : Tokens(T)) : Result(T, V)
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("FirstOf: #{ex.message}")
    end
  end

  class SepBy(T, V, U) < Parser(T, Array(V))
    @p : Map(T, {V, Array(V)}, Array(V))

    def initialize(elem : Parser(T, V), sep : Parser(T, U))
      @p = (elem + Many(T, U).new(sep >> elem)).map do |tup|
        [tup[0]] + tup[1]
      end
    end

    def parse(tokens : Tokens(T)) : Result(T, Array(V))
      @p.parse(tokens)
    rescue ex : ParserFail
      raise ParserFail.new("SepBy: #{ex.message}")
    end
  end
end