Module: EBNF::Parser

Included in:
Base
Defined in:
lib/ebnf/parser.rb

Instance Method Summary collapse

Instance Method Details

#alt(s) ⇒ Array

Parse alt

>>> alt("a | b | c")
((alt, \[('id', 'a'), ('id', 'b'), ('id', 'c')\]), '')

Parameters:

  • s (String)

Returns:

  • (Array) 


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ebnf/parser.rb', line 120

def alt(s)
  debug("alt") {"(#{s.inspect})"}
  args = []
  while !s.empty?
    e, s = depth {seq(s)}
    debug {"=> seq returned #{[e, s].inspect}"}
    if e.to_s.empty?
      break unless args.empty?
      e = [:seq, []] # empty sequence
    end
    args << e
    unless s.empty?
      t, ss = depth {terminal(s)}
      break unless t[0] == :alt
      s = ss
    end
  end
  args.length > 1 ? [args.unshift(:alt), s] : [e, s]
end

#diff(s) ⇒ Object

parse diff

>>> diff("a - b")
((diff, \[('id', 'a'), ('id', 'b')\]), '')



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ebnf/parser.rb', line 175

def diff(s)
  debug("diff") {"(#{s.inspect})"}
  e1, s = depth {postfix(s)}
  debug {"=> postfix returned #{[e1, s].inspect}"}
  unless e1.to_s.empty?
    unless s.empty?
      t, ss = depth {terminal(s)}
      debug {"diff #{[t, ss].inspect}"}
      if t.is_a?(Array) && t.first == :diff
        s = ss
        e2, s = primary(s)
        unless e2.to_s.empty?
          return [[:diff, e1, e2], s]
        else
          error("diff", "Syntax Error")
          raise "Syntax Error"
        end
      end
    end
  end
  [e1, s]
end

#eachRule(scanner) {|rule_string| ... } ⇒ Object

Iterate over rule strings. a line that starts with ‘[’ or ‘@’ starts a new rule

Parameters:

  • scanner (StringScanner)

Yields:

  • rule_string

Yield Parameters:

  • rule_string (String) 


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
 
# File 'lib/ebnf/parser.rb', line 10

def eachRule(scanner)
  cur_lineno = 1
  r = ''
  until scanner.eos?
    case
    when s = scanner.scan(%r(\s+)m)
      # Eat whitespace
      cur_lineno += s.count("\n")
      #debug("eachRule(ws)") { "[#{cur_lineno}] #{s.inspect}" }
    when s = scanner.scan(%r(/\*([^\*]|\*[^\/])*\*/)m)
      # Eat comments
      debug("eachRule(comment)") { "[#{cur_lineno}] #{s.inspect}" }
    when s = scanner.scan(%r((#|//).*$))
      # Eat comments
      cur_lineno += s.count("\n")
      debug("eachRule(comment)") { "[#{cur_lineno}] #{s.inspect}" }
    when s = scanner.scan(%r(^@terminals))
      #debug("eachRule(@terminals)") { "[#{cur_lineno}] #{s.inspect}" }
      yield(r) unless r.empty?
      @lineno = cur_lineno
      yield(s)
      r = ''
    when s = scanner.scan(/@pass/)
      # Found rule start, if we've already collected a rule, yield it
      #debug("eachRule(@pass)") { "[#{cur_lineno}] #{s.inspect}" }
      yield r unless r.empty?
      @lineno = cur_lineno
      r = s
    when s = scanner.scan(/\[(?=[\w\.]+\])/)
      # Found rule start, if we've already collected a rule, yield it
      yield r unless r.empty?
      #debug("eachRule(rule)") { "[#{cur_lineno}] #{s.inspect}" }
      @lineno = cur_lineno
      r = s
    else
      # Collect until end of line, or start of comment
      s = scanner.scan_until(%r((?:/\*)|$)m)
      cur_lineno += s.count("\n")
      #debug("eachRule(rest)") { "[#{cur_lineno}] #{s.inspect}" }
      r += s
    end
  end
  yield r unless r.empty?
end

#ebnf(s) ⇒ Array

Parse a string into an expression tree and a remaining string

Examples:

>>> ebnf("a b c")
((seq, \[('id', 'a'), ('id', 'b'), ('id', 'c')\]), '')

>>> ebnf("a? b+ c*")
((seq, \[(opt, ('id', 'a')), (plus, ('id', 'b')), ('*', ('id', 'c'))\]), '')

>>> ebnf(" | x xlist")
((alt, \[(seq, \[\]), (seq, \[('id', 'x'), ('id', 'xlist')\])\]), '')

>>> ebnf("a | (b - c)")
((alt, \[('id', 'a'), (diff, \[('id', 'b'), ('id', 'c')\])\]), '')

>>> ebnf("a b | c d")
((alt, \[(seq, \[('id', 'a'), ('id', 'b')\]), (seq, \[('id', 'c'), ('id', 'd')\])\]), '')

>>> ebnf("a | b | c")
((alt, \[('id', 'a'), ('id', 'b'), ('id', 'c')\]), '')

>>> ebnf("a) b c")
(('id', 'a'), ' b c')

>>> ebnf("BaseDecl? PrefixDecl*")
((seq, \[(opt, ('id', 'BaseDecl')), ('*', ('id', 'PrefixDecl'))\]), '')

>>> ebnf("NCCHAR1 | diff | [0-9] | #x00B7 | [#x0300-#x036F] | \[#x203F-#x2040\]")
((alt, \[('id', 'NCCHAR1'), ("'", diff), (range, '0-9'), (hex, '#x00B7'), (range, '#x0300-#x036F'), (range, '#x203F-#x2040')\]), '')

Parameters:

  • s (String)

Returns:

  • (Array) 


102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ebnf/parser.rb', line 102

def ebnf(s)
  debug("ebnf") {"(#{s.inspect})"}
  e, s = depth {alt(s)}
  debug {"=> alt returned #{[e, s].inspect}"}
  unless s.empty?
    t, ss = depth {terminal(s)}
    debug {"=> terminal returned #{[t, ss].inspect}"}
    return [e, ss] if t.is_a?(Array) && t.first == :")"
  end
  [e, s]
end

#postfix(s) ⇒ Object

parse postfix

>>> postfix("a b c")
(('id', 'a'), ' b c')

>>> postfix("a? b c")
((opt, ('id', 'a')), ' b c')



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ebnf/parser.rb', line 206

def postfix(s)
  debug("postfix") {"(#{s.inspect})"}
  e, s = depth {primary(s)}
  debug {"=> primary returned #{[e, s].inspect}"}
  return ["", s] if e.to_s.empty?
  if !s.empty?
    t, ss = depth {terminal(s)}
    debug {"=> #{[t, ss].inspect}"}
    if t.is_a?(Array) && [:opt, :star, :plus].include?(t.first)
      return [[t.first, e], ss]
    end
  end
  [e, s]
end

#primary(s) ⇒ Object

parse primary

>>> primary("a b c")
(('id', 'a'), ' b c')



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ebnf/parser.rb', line 226

def primary(s)
  debug("primary") {"(#{s.inspect})"}
  t, s = depth {terminal(s)}
  debug {"=> terminal returned #{[t, s].inspect}"}
  if t.is_a?(Symbol) || t.is_a?(String)
    [t, s]
  elsif %w(range hex).map(&:to_sym).include?(t.first)
    [t, s]
  elsif t.first == :"("
    e, s = depth {ebnf(s)}
    debug {"=> ebnf returned #{[e, s].inspect}"}
    [e, s]
  else
    ["", s]
  end
end

#ruleParts(rule) ⇒ Rule

Parse a rule into a rule number, a symbol and an expression

Parameters:

  • rule (String)

Returns:



60
61
62
63
64
65
66
67
 
# File 'lib/ebnf/parser.rb', line 60

def ruleParts(rule)
  num_sym, expr = rule.split('::=', 2).map(&:strip)
  num, sym = num_sym.split(']', 2).map(&:strip)
  num = num[1..-1]
  r = Rule.new(sym && sym.to_sym, num, ebnf(expr).first, :ebnf => self)
  debug("ruleParts") { r.inspect }
  r
end

#seq(s) ⇒ Object

parse seq

>>> seq("a b c")
((seq, \[('id', 'a'), ('id', 'b'), ('id', 'c')\]), '')

>>> seq("a b? c")
((seq, \[('id', 'a'), (opt, ('id', 'b')), ('id', 'c')\]), '')



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ebnf/parser.rb', line 148

def seq(s)
  debug("seq") {"(#{s.inspect})"}
  args = []
  while !s.empty?
    e, ss = depth {diff(s)}
    debug {"=> diff returned #{[e, ss].inspect}"}
    unless e.to_s.empty?
      args << e
      s = ss
    else
      break;
    end
  end
  if args.length > 1
    [args.unshift(:seq), s]
  elsif args.length == 1
    args + [s]
  else
    ["", s]
  end
end

#terminal(s) ⇒ Object

parse one terminal; return the terminal and the remaining string

A terminal is represented as a tuple whose 1st item gives the type; some types have additional info in the tuple.

Examples:

>>> terminal("'abc' def")
(("'", 'abc'), ' def')

>>> terminal("[0-9]")
((range, '0-9'), '')
>>> terminal("#x00B7")
((hex, '#x00B7'), '')
>>> terminal ("\[#x0300-#x036F\]")
((range, '#x0300-#x036F'), '')
>>> terminal("\[^<>'{}|^`\]-\[#x00-#x20\]")
((range, "^<>'{}|^`"), '-\[#x00-#x20\]')



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ebnf/parser.rb', line 261

def terminal(s)
  s = s.strip
  case m = s[0,1]
  when '"', "'"
    l, s = s[1..-1].split(m, 2)
    [l, s]
  when '['
    l, s = s[1..-1].split(']', 2)
    [[:range, l], s]
  when '#'
    s.match(/(#\w+)(.*)$/)
    l, s = $1, $2
    [[:hex, l], s]
  when /[\w\.]/
    s.match(/(\w+)(.*)$/)
    l, s = $1, $2
    [l.to_sym, s]
  when '@'
    s.match(/@(#\w+)(.*)$/)
    l, s = $1, $2
    [[:"@", l], s]
  when '-'
    [[:diff], s[1..-1]]
  when '?'
    [[:opt], s[1..-1]]
  when '|'
    [[:alt], s[1..-1]]
  when '+'
    [[:plus], s[1..-1]]
  when '*'
    [[:star], s[1..-1]]
  when /[\(\)]/
    [[m.to_sym], s[1..-1]]
  else
    error("terminal", "unrecognized terminal: #{s.inspect}")
    raise "Syntax Error, unrecognized terminal: #{s.inspect}"
  end
end