Class: RDoc::Markdown::Literals

Relationships & Source Files
Namespace Children
Classes: MemoEntry, RuleInfo
Exceptions: ParseError
Inherits:	Object
Defined in:	lib/rdoc/markdown/literals.rb

Constant Summary

Rules =
# File 'lib/rdoc/markdown/literals.rb', line 408
```
{}
```

Class Method Summary

.new(str, debug = false) ⇒ Literals constructor Internal use only

This is distinct from setup_parser so that a standalone parser can redefine #initialize and still have access to the proper parser setup code.
.rule_info(name, rendered) Internal use only

Instance Attribute Summary

#failed_rule readonly Internal use only
#failing_rule_offset readonly Internal use only
#pos rw Internal use only
#result rw Internal use only
#string readonly Internal use only

Instance Method Summary

#_Alphanumeric

Alphanumeric = /pWord/.
#_AlphanumericAscii

AlphanumericAscii = /[A-Za-z0-9]/.
#_BOM

BOM = “uFEFF”.
#_Newline

Newline = /n|rn?|pZl|pZp/.
#_NonAlphanumeric

NonAlphanumeric = /p^Word/.
#_Spacechar

Spacechar = /t|pZs/.
#setup_foreign_grammar
#apply(rule) Internal use only
#apply_with_args(rule, *args) Internal use only
#current_column(target = pos) Internal use only
#current_line(target = pos) Internal use only
#external_invoke(other, rule, *args) Internal use only
#failure_caret Internal use only
#failure_character Internal use only
#failure_info Internal use only
#failure_oneline Internal use only
#get_byte Internal use only

See additional method definition at line 186.
#get_text(start) Internal use only
#grow_lr(rule, args, start_pos, m) Internal use only
#lines Internal use only
#match_string(str) Internal use only
#parse(rule = nil) Internal use only
#raise_error Internal use only
#scan(reg) Internal use only
#set_failed_rule(name) Internal use only
#set_string(string, pos) Internal use only

Sets the string and current parsing position for the parser.
#setup_parser(str, debug = false) Internal use only

Prepares for parsing str.
#show_error(io = STDOUT) Internal use only
#show_pos Internal use only

Constructor Details

.new(str, debug = false) ⇒ `Literals`

This method is for internal use only.

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

[ GitHub ]

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


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

Class Method Details

.rule_info(name, rendered)

This method is for internal use only.

[ GitHub ]

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


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

Instance Attribute Details

#failed_rule (readonly)

This method is for internal use only.

[ GitHub ]

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


attr_reader :failed_rule

#failing_rule_offset (readonly)

This method is for internal use only.

[ GitHub ]

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


attr_reader :failing_rule_offset

#pos (rw)

This method is for internal use only.

[ GitHub ]

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


attr_accessor :result, :pos

#result (rw)

This method is for internal use only.

[ GitHub ]

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


attr_accessor :result, :pos

#string (readonly)

This method is for internal use only.

[ GitHub ]

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


attr_reader :string

Instance Method Details

#_Alphanumeric

Alphanumeric = /pWord/

[ GitHub ]

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


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

#_AlphanumericAscii

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

[ GitHub ]

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


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

#_BOM

BOM = “uFEFF”

[ GitHub ]

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


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

#_Newline

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

[ GitHub ]

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


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

#_NonAlphanumeric

NonAlphanumeric = /p^Word/

[ GitHub ]

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


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

#_Spacechar

Spacechar = /t|pZs/

[ GitHub ]

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


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

#apply(rule)

This method is for internal use only.

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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

  target + 1
end

#current_line(target = pos)

This method is for internal use only.

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

[ GitHub ]

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


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

#failure_info

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

See additional method definition at line 186.

[ GitHub ]

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


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

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

#get_text(start)

This method is for internal use only.

[ GitHub ]

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


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

#grow_lr(rule, args, start_pos, m)

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

[ GitHub ]

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


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

#match_string(str)

This method is for internal use only.

[ GitHub ]

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


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

  return nil
end

#parse(rule = nil)

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

Raises:

(ParseError)

[ GitHub ]

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


def raise_error
  raise ParseError, failure_oneline
end

#scan(reg)

This method is for internal use only.

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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

#set_string(string, pos)

This method is for internal use only.

Sets the string and current parsing position for the parser.

[ GitHub ]

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


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

#setup_foreign_grammar

[ GitHub ]

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


def setup_foreign_grammar; end

#setup_parser(str, debug = false)

This method is for internal use only.

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

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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

This method is for internal use only.

[ GitHub ]

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


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

Class: RDoc::Markdown::Literals

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(str, debug = false) ⇒ Literals

Class Method Details

.rule_info(name, rendered)

Instance Attribute Details

#failed_rule (readonly)

#failing_rule_offset (readonly)

#pos (rw)

#result (rw)

#string (readonly)

Instance Method Details

#_Alphanumeric

#_AlphanumericAscii

#_BOM

#_Newline

#_NonAlphanumeric

#_Spacechar

#apply(rule)

#apply_with_args(rule, *args)

#current_column(target = pos)

#current_line(target = pos)

#external_invoke(other, rule, *args)

#failure_caret

#failure_character

#failure_info

#failure_oneline

#get_byte

#get_text(start)

#grow_lr(rule, args, start_pos, m)

#lines

#match_string(str)

#parse(rule = nil)

#raise_error

#scan(reg)

#set_failed_rule(name)

#set_string(string, pos)

#setup_foreign_grammar

#setup_parser(str, debug = false)

#show_error(io = STDOUT)

#show_pos

.new(str, debug = false) ⇒ `Literals`