aboutsummaryrefslogtreecommitdiff
path: root/src/parcom.cr
blob: 8c55014849613befc1244e4ea3df664c6491d5db (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
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 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