Class: RDoc::Markdown::Literals

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/markdown/literals.rb

Overview

– This set of literals is for Ruby 1.9 regular expressions and gives full unicode support.

Unlike peg-markdown, this set of literals recognizes Unicode alphanumeric characters, newlines and spaces.

Defined Under Namespace

Classes: MemoEntry, ParseError, RuleInfo

Constant Summary collapse

Rules = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(str, debug = false) ⇒ Literals

This is distinct from setup_parser so that a standalone parser can redefine #initialize and still have access to the proper parser setup code.



18
19
20
 
# File 'lib/rdoc/markdown/literals.rb', line 18

def initialize(str, debug=false)
  setup_parser(str, debug)
end

Instance Attribute Details

#failed_rule ⇒ Object (readonly)

Returns the value of attribute failed_rule.



164
165
166
 
# File 'lib/rdoc/markdown/literals.rb', line 164

def failed_rule
  @failed_rule
end

#failing_rule_offset ⇒ Object (readonly)

Returns the value of attribute failing_rule_offset.



37
38
39
 
# File 'lib/rdoc/markdown/literals.rb', line 37

def failing_rule_offset
  @failing_rule_offset
end

#pos ⇒ Object

Returns the value of attribute pos.



38
39
40
 
# File 'lib/rdoc/markdown/literals.rb', line 38

def pos
  @pos
end

#result ⇒ Object

Returns the value of attribute result.



38
39
40
 
# File 'lib/rdoc/markdown/literals.rb', line 38

def result
  @result
end

#string ⇒ Object (readonly)

Returns the value of attribute string.



36
37
38
 
# File 'lib/rdoc/markdown/literals.rb', line 36

def string
  @string
end

Class Method Details

.rule_info(name, rendered) ⇒ Object 



358
359
360
 
# File 'lib/rdoc/markdown/literals.rb', line 358

def self.rule_info(name, rendered)
  RuleInfo.new(name, rendered)
end

Instance Method Details

#_Alphanumeric ⇒ Object

Alphanumeric = /pWord/



368
369
370
371
372
 
# File 'lib/rdoc/markdown/literals.rb', line 368

def _Alphanumeric
  _tmp = scan(/\A(?-mix:\p{Word})/)
  set_failed_rule :_Alphanumeric unless _tmp
  return _tmp
end

#_AlphanumericAscii ⇒ Object

AlphanumericAscii = /[A-Za-z0-9]/



375
376
377
378
379
 
# File 'lib/rdoc/markdown/literals.rb', line 375

def _AlphanumericAscii
  _tmp = scan(/\A(?-mix:[A-Za-z0-9])/)
  set_failed_rule :_AlphanumericAscii unless _tmp
  return _tmp
end

#_BOM ⇒ Object

BOM = “uFEFF”



382
383
384
385
386
 
# File 'lib/rdoc/markdown/literals.rb', line 382

def _BOM
  _tmp = match_string("uFEFF")
  set_failed_rule :_BOM unless _tmp
  return _tmp
end

#_Newline ⇒ Object

Newline = /n|rn?|pZl|pZp/



389
390
391
392
393
 
# File 'lib/rdoc/markdown/literals.rb', line 389

def _Newline
  _tmp = scan(/\A(?-mix:\n|\r\n?|\p{Zl}|\p{Zp})/)
  set_failed_rule :_Newline unless _tmp
  return _tmp
end

#_NonAlphanumeric ⇒ Object

NonAlphanumeric = /p^Word/



396
397
398
399
400
 
# File 'lib/rdoc/markdown/literals.rb', line 396

def _NonAlphanumeric
  _tmp = scan(/\A(?-mix:\p{^Word})/)
  set_failed_rule :_NonAlphanumeric unless _tmp
  return _tmp
end

#_Spacechar ⇒ Object

Spacechar = /t|pZs/



403
404
405
406
407
 
# File 'lib/rdoc/markdown/literals.rb', line 403

def _Spacechar
  _tmp = scan(/\A(?-mix:\t|\p{Zs})/)
  set_failed_rule :_Spacechar unless _tmp
  return _tmp
end

#apply(rule) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/rdoc/markdown/literals.rb', line 295

def apply(rule)
  if m = @memoizations[rule][@pos]
    @pos = m.pos
    if !m.set
      m.left_rec = true
      return nil
    end

    @result = m.result

    return m.ans
  else
    m = MemoEntry.new(nil, @pos)
    @memoizations[rule][@pos] = m
    start_pos = @pos

    ans = __send__ rule

    lr = m.left_rec

    m.move! ans, @pos, @result

    # Don't bother trying to grow the left recursion
    # if it's failing straight away (thus there is no seed)
    if ans and lr
      return grow_lr(rule, nil, start_pos, m)
    else
      return ans
    end
  end
end

#apply_with_args(rule, *args) ⇒ Object 



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
 
# File 'lib/rdoc/markdown/literals.rb', line 262

def apply_with_args(rule, *args)
  memo_key = [rule, args]
  if m = @memoizations[memo_key][@pos]
    @pos = m.pos
    if !m.set
      m.left_rec = true
      return nil
    end

    @result = m.result

    return m.ans
  else
    m = MemoEntry.new(nil, @pos)
    @memoizations[memo_key][@pos] = m
    start_pos = @pos

    ans = __send__ rule, *args

    lr = m.left_rec

    m.move! ans, @pos, @result

    # Don't bother trying to grow the left recursion
    # if it's failing straight away (thus there is no seed)
    if ans and lr
      return grow_lr(rule, args, start_pos, m)
    else
      return ans
    end
  end
end

#current_column(target = pos) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/rdoc/markdown/literals.rb', line 40

def current_column(target=pos)
  if c = string.rindex("\n", target-1)
    return target - c - 1
  end

  target + 1
end

#current_line(target = pos) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rdoc/markdown/literals.rb', line 48

def current_line(target=pos)
  cur_offset = 0
  cur_line = 0

  string.each_line do |line|
    cur_line += 1
    cur_offset += line.size
    return cur_line if cur_offset >= target
  end

  -1
end

#external_invoke(other, rule, *args) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rdoc/markdown/literals.rb', line 243

def external_invoke(other, rule, *args)
  old_pos = @pos
  old_string = @string

  set_string other.string, other.pos

  begin
    if val = __send__(rule, *args)
      other.pos = @pos
      other.result = @result
    else
      other.set_failed_rule "#{self.class}##{rule}"
    end
    val
  ensure
    set_string old_string, old_pos
  end
end

#failure_caret ⇒ Object 



101
102
103
104
105
106
107
 
# File 'lib/rdoc/markdown/literals.rb', line 101

def failure_caret
  l = current_line @failing_rule_offset
  c = current_column @failing_rule_offset

  line = lines[l-1]
  "#{line}\n#{' ' * (c - 1)}^"
end

#failure_character ⇒ Object 



109
110
111
112
113
 
# File 'lib/rdoc/markdown/literals.rb', line 109

def failure_character
  l = current_line @failing_rule_offset
  c = current_column @failing_rule_offset
  lines[l-1][c-1, 1]
end

#failure_info ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rdoc/markdown/literals.rb', line 89

def failure_info
  l = current_line @failing_rule_offset
  c = current_column @failing_rule_offset

  if @failed_rule.kind_of? Symbol
    info = self.class::Rules[@failed_rule]
    "line #{l}, column #{c}: failed rule '#{info.name}' = '#{info.rendered}'"
  else
    "line #{l}, column #{c}: failed rule '#{@failed_rule}'"
  end
end

#failure_oneline ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rdoc/markdown/literals.rb', line 115

def failure_oneline
  l = current_line @failing_rule_offset
  c = current_column @failing_rule_offset

  char = lines[l-1][c-1, 1]

  if @failed_rule.kind_of? Symbol
    info = self.class::Rules[@failed_rule]
    "@#{l}:#{c} failed rule '#{info.name}', got '#{char}'"
  else
    "@#{l}:#{c} failed rule '#{@failed_rule}', got '#{char}'"
  end
end

#get_byte ⇒ Object 



187
188
189
190
191
192
193
194
195
 
# File 'lib/rdoc/markdown/literals.rb', line 187

def get_byte
  if @pos >= @string_size
    return nil
  end

  s = @string[@pos].ord
  @pos += 1
  s
end

#get_text(start) ⇒ Object 



69
70
71
 
# File 'lib/rdoc/markdown/literals.rb', line 69

def get_text(start)
  @string[start..@pos-1]
end

#grow_lr(rule, args, start_pos, m) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/rdoc/markdown/literals.rb', line 327

def grow_lr(rule, args, start_pos, m)
  while true
    @pos = start_pos
    @result = m.result

    if args
      ans = __send__ rule, *args
    else
      ans = __send__ rule
    end
    return nil unless ans

    break if @pos <= m.pos

    m.move! ans, @pos, @result
  end

  @result = m.result
  @pos = m.pos
  return m.ans
end

#lines ⇒ Object 



61
62
63
64
65
 
# File 'lib/rdoc/markdown/literals.rb', line 61

def lines
  lines = []
  string.each_line { |l| lines << l }
  lines
end

#match_string(str) ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/rdoc/markdown/literals.rb', line 166

def match_string(str)
  len = str.size
  if @string[pos,len] == str
    @pos += len
    return str
  end

  return nil
end

#parse(rule = nil) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/rdoc/markdown/literals.rb', line 208

def parse(rule=nil)
  # We invoke the rules indirectly via apply
  # instead of by just calling them as methods because
  # if the rules use left recursion, apply needs to
  # manage that.

  if !rule
    apply(:_root)
  else
    method = rule.gsub("-","_hyphen_")
    apply :"_#{method}"
  end
end

#raise_error ⇒ Object

Raises:



132
133
134
 
# File 'lib/rdoc/markdown/literals.rb', line 132

def raise_error
  raise ParseError, failure_oneline
end

#scan(reg) ⇒ Object 



176
177
178
179
180
181
182
183
184
 
# File 'lib/rdoc/markdown/literals.rb', line 176

def scan(reg)
  if m = reg.match(@string[@pos..-1])
    width = m.end(0)
    @pos += width
    return true
  end

  return nil
end

#set_failed_rule(name) ⇒ Object 



157
158
159
160
161
162
 
# File 'lib/rdoc/markdown/literals.rb', line 157

def set_failed_rule(name)
  if @pos > @failing_rule_offset
    @failed_rule = name
    @failing_rule_offset = @pos
  end
end

#set_string(string, pos) ⇒ Object

Sets the string and current parsing position for the parser.



74
75
76
77
78
 
# File 'lib/rdoc/markdown/literals.rb', line 74

def set_string string, pos
  @string = string
  @string_size = string ? string.size : 0
  @pos = pos
end

#setup_foreign_grammar ⇒ Object

:startdoc: :stopdoc:



365
 
# File 'lib/rdoc/markdown/literals.rb', line 365

def setup_foreign_grammar; end

#setup_parser(str, debug = false) ⇒ Object

Prepares for parsing str. If you define a custom initialize you must call this method before #parse



26
27
28
29
30
31
32
33
34
 
# File 'lib/rdoc/markdown/literals.rb', line 26

def setup_parser(str, debug=false)
  set_string str, 0
  @memoizations = Hash.new { |h,k| h[k] = {} }
  @result = nil
  @failed_rule = nil
  @failing_rule_offset = -1

  setup_foreign_grammar
end

#show_error(io = STDOUT) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/rdoc/markdown/literals.rb', line 136

def show_error(io=STDOUT)
  error_pos = @failing_rule_offset
  line_no = current_line(error_pos)
  col_no = current_column(error_pos)

  io.puts "On line #{line_no}, column #{col_no}:"

  if @failed_rule.kind_of? Symbol
    info = self.class::Rules[@failed_rule]
    io.puts "Failed to match '#{info.rendered}' (rule '#{info.name}')"
  else
    io.puts "Failed to match rule '#{@failed_rule}'"
  end

  io.puts "Got: #{string[error_pos,1].inspect}"
  line = lines[line_no-1]
  io.puts "=> #{line}"
  io.print(" " * (col_no + 3))
  io.puts "^"
end

#show_pos ⇒ Object 



80
81
82
83
84
85
86
87
 
# File 'lib/rdoc/markdown/literals.rb', line 80

def show_pos
  width = 10
  if @pos < width
    "#{@pos} (\"#{@string[0,@pos]}\" @ \"#{@string[@pos,width]}\")"
  else
    "#{@pos} (\"... #{@string[@pos - width, width]}\" @ \"#{@string[@pos,width]}\")"
  end
end