Class: RDoc::Markup::ToHtml

# File 'lib/rdoc/markup/to_html.rb', line 39

attr_accessor :from_path

# File 'lib/rdoc/markup/to_html.rb', line 27

attr_reader :in_list_entry # :nodoc:

# File 'lib/rdoc/markup/to_html.rb', line 173

def in_tidylink_label?
  @in_tidylink_label
end

# File 'lib/rdoc/markup/to_html.rb', line 28

attr_reader :list # :nodoc:

# File 'lib/rdoc/markup/to_html.rb', line 26

attr_reader :res # :nodoc:

# File 'lib/rdoc/markup/to_html.rb', line 298

def accept_block_quote(block_quote)
  @res << "\n<blockquote>"

  block_quote.parts.each do |part|
    part.accept self
  end

  @res << "</blockquote>\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 413

def accept_heading(heading)
  level = [6, heading.level].min

  label = deduplicate_heading_id(heading.label(@code_object))
  legacy_label = deduplicate_heading_id(heading.legacy_label(@code_object))

  # Add legacy anchor before the heading for backward compatibility.
  # This allows old links with label- prefix to still work.
  if @options.output_decoration && !@options.pipe
    @res << "\n<span id=\"#{legacy_label}\" class=\"legacy-anchor\"></span>"
  end

  @res << if @options.output_decoration
            "\n<h#{level} id=\"#{label}\">"
          else
            "\n<h#{level}>"
          end

  if @options.pipe
    @res << to_html(heading.text)
  else
    @res << "<a href=\"##{label}\">#{to_html(heading.text)}</a>"
  end

  @res << "</h#{level}>\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 376

def accept_list_end(list)
  @list.pop
  if tag = @in_list_entry.pop
    @res << tag
  end
  @res << html_list_name(list.type, false) << "\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 398

def accept_list_item_end(list_item)
  @in_list_entry[-1] = list_end_for(@list.last)
end

# File 'lib/rdoc/markup/to_html.rb', line 387

def accept_list_item_start(list_item)
  if tag = @in_list_entry.last
    @res << tag
  end

  @res << list_item_start(list_item, @list.last)
end

# File 'lib/rdoc/markup/to_html.rb', line 367

def accept_list_start(list)
  @list << list.type
  @res << html_list_name(list.type, true)
  @in_list_entry.push false
end

# File 'lib/rdoc/markup/to_html.rb', line 311

def accept_paragraph(paragraph)
  @res << "\n<p>"
  text = paragraph.text @hard_break
  text = text.gsub(/(#{SPACE_SEPARATED_LETTER_CLASS})?\K\r?\n(?=(?(1)(#{SPACE_SEPARATED_LETTER_CLASS})?))/o) {
    defined?($2) && ' '
  }
  @res << to_html(text)
  @res << "</p>\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 443

def accept_raw(raw)
  @res << raw.parts.join("\n")
end

# File 'lib/rdoc/markup/to_html.rb', line 360

def accept_rule(rule)
  @res << "<hr>\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 450

def accept_table(header, body, aligns)
  @res << "\n<table role=\"table\">\n<thead>\n<tr>\n"
  header.zip(aligns) do |text, align|
    @res << '<th'
    @res << ' align="' << align << '"' if align
    @res << '>' << to_html(text) << "</th>\n"
  end
  @res << "</tr>\n</thead>\n<tbody>\n"
  body.each do |row|
    @res << "<tr>\n"
    row.zip(aligns) do |text, align|
      @res << '<td'
      @res << ' align="' << align << '"' if align
      @res << '>' << to_html(text) << "</td>\n"
    end
    @res << "</tr>\n"
  end
  @res << "</tbody>\n</table>\n"
end

# File 'lib/rdoc/markup/to_html.rb', line 324

def accept_verbatim(verbatim)
  text = verbatim.text.rstrip
  format = verbatim.format

  klass = nil

  # Apply Ruby syntax highlighting if
  # - explicitly marked as Ruby (via ruby? which accepts :ruby or :rb)
  # - no format specified but the text is parseable as Ruby
  # Otherwise, add language class when applicable and skip Ruby highlighting
  content = if verbatim.ruby? || (format.nil? && parseable?(text))
              begin
                tokens = RDoc::Parser::RipperStateLex.parse text
                klass  = ' class="ruby"'

                result = RDoc::TokenStream.to_html tokens
                result = result + "\n" unless "\n" == result[-1]
                result
              rescue
                CGI.escapeHTML text
              end
            else
              klass = " class=\"#{format}\"" if format
              CGI.escapeHTML text
            end

  if @options.pipe then
    @res << "\n<pre><code>#{CGI.escapeHTML text}\n</code></pre>\n"
  else
    @res << "\n<pre#{klass}>#{content}</pre>\n"
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 184

def apply_tidylink_label_special_handling(label, url)
  # ^1 *1 will be converted to just 1 in tidy link label.
  return label[1..] if label.match?(/\A[*^]\d+\z/)

  # rdoc-image in label specially allows spaces in alt text.
  return handle_RDOCLINK(label) if label.start_with?('rdoc-image:')
end

# File 'lib/rdoc/markup/to_html.rb', line 489

def convert_string(text)
  CGI.escapeHTML text
end

# File 'lib/rdoc/markup/to_html.rb', line 476

def deduplicate_heading_id(id)
  if @heading_ids.key?(id)
    @heading_ids[id] += 1
    "#{id}-#{@heading_ids[id]}"
  else
    @heading_ids[id] = 0
    id
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 167

def emit_inline(text)
  @inline_output << text
end

# File 'lib/rdoc/markup/to_html.rb', line 291

def end_accepting
  @res.join
end

# File 'lib/rdoc/markup/to_html.rb', line 502

def gen_url(url, text)
  scheme, url, id = parse_url url

  if %w[http https link].include?(scheme) && url =~ /\.(gif|png|jpg|jpeg|bmp)\z/
    "<img src=\"#{url}\" />"
  else
    if scheme != 'link' and %r%\A((?!https?:)(?:[^/#]*/)*)([^/#])\.(rb|rdoc|md)(?=\z|#)%i =~ url
      url = "#$1#{$2.tr('.', '_')}_#$3.html#$'"
    end

    text = text.sub %r%^#{scheme}:/*%i, ''
    text = text.sub %r%^[*\^](\d+)$%,   '\1'

    link = "<a#{id} href=\"#{url}\">#{text}</a>"

    if /"foot/.match?(id)
      "<sup>#{link}</sup>"
    else
      link
    end
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 127

def handle_BOLD(nodes)
  emit_inline('<strong>')
  super
  emit_inline('</strong>')
end

# File 'lib/rdoc/markup/to_html.rb', line 139

def handle_BOLD_WORD(word)
  emit_inline('<strong>')
  super
  emit_inline('</strong>')
end

# File 'lib/rdoc/markup/to_html.rb', line 133

def handle_EM(nodes)
  emit_inline('<em>')
  super
  emit_inline('</em>')
end

# File 'lib/rdoc/markup/to_html.rb', line 145

def handle_EM_WORD(word)
  emit_inline('<em>')
  super
  emit_inline('</em>')
end

# File 'lib/rdoc/markup/to_html.rb', line 163

def handle_HARD_BREAK
  emit_inline('<br>')
end

# File 'lib/rdoc/markup/to_html.rb', line 228

def handle_inline(text) # :nodoc:
  @inline_output = +''
  super
  out = @inline_output
  @inline_output = nil
  out
end

# File 'lib/rdoc/markup/to_html.rb', line 119

def handle_PLAIN_TEXT(text)
  emit_inline(convert_string(text))
end

# File 'lib/rdoc/markup/to_html.rb', line 88

def handle_RDOCLINK(url) # :nodoc:
  case url
  when /^rdoc-ref:/
    CGI.escapeHTML($')
  when /^rdoc-label:/
    return CGI.escapeHTML(url) if in_tidylink_label?
    text = $'

    text = case text
           when /\Alabel-/    then $'
           when /\Afootmark-/ then $'
           when /\Afoottext-/ then $'
           else                    text
           end

    gen_url CGI.escapeHTML(url), CGI.escapeHTML(text)
  when /^rdoc-image:/
    # Split the string after "rdoc-image:" into url and alt.
    #   "path/to/image.jpg:alt text" => ["path/to/image.jpg", "alt text"]
    #   "http://example.com/path/to/image.jpg:alt text" => ["http://example.com/path/to/image.jpg", "alt text"]
    url, alt = $'.split(/:(?!\/)/, 2)
    if alt && !alt.empty?
      %[<img src="#{CGI.escapeHTML(url)}" alt="#{CGI.escapeHTML(alt)}">]
    else
      %[<img src="#{CGI.escapeHTML(url)}">]
    end
  when /\Ardoc-[a-z]+:/
    CGI.escapeHTML($')
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 123

def handle_REGEXP_HANDLING_TEXT(text)
  emit_inline(text)
end

# File 'lib/rdoc/markup/to_html.rb', line 254

def handle_regexp_HYPERLINK(text)
  return convert_string(text) if in_tidylink_label?

  url = CGI.escapeHTML(text)
  gen_url url, url
end

# File 'lib/rdoc/markup/to_html.rb', line 270

def handle_regexp_RDOCLINK(text)
  handle_RDOCLINK text
end

# File 'lib/rdoc/markup/to_html.rb', line 238

def handle_regexp_SUPPRESSED_CROSSREF(text)
  convert_string(text.delete_prefix('\\'))
end

# File 'lib/rdoc/markup/to_html.rb', line 157

def handle_STRIKE(nodes)
  emit_inline('<del>')
  super
  emit_inline('</del>')
end

# File 'lib/rdoc/markup/to_html.rb', line 192

def handle_TIDYLINK(label_part, url)
  # When url is an image, ignore label part (maybe bug?) and just generate img tag.
  if url.match?(/\Ahttps?:\/\/.+\.(png|gif|jpg|jpeg|bmp)\z/)
    emit_inline("<img src=\"#{CGI.escapeHTML(url)}\" />")
    return
  elsif url.match?(/\Ardoc-image:/)
    emit_inline(handle_RDOCLINK(url))
    return
  end

  if label_part.size == 1 && String === label_part[0]
    raw_label = label_part[0]

    @in_tidylink_label = true
    special = apply_tidylink_label_special_handling(raw_label, url)
    @in_tidylink_label = false

    if special
      tag = gen_url(CGI.escapeHTML(url), special)
      unless tag.empty?
        emit_inline(tag)
        return
      end
    end
  end

  tag = gen_url(CGI.escapeHTML(url), '')
  open_tag, close_tag = tag.split(/(?=<\/a>)/, 2)
  valid_tag = open_tag && close_tag
  emit_inline(open_tag) if valid_tag
  @in_tidylink_label = true
  traverse_inline_nodes(label_part)
  @in_tidylink_label = false
  emit_inline(close_tag) if valid_tag
end

# File 'lib/rdoc/markup/to_html.rb', line 151

def handle_TT(code)
  emit_inline('<code>')
  super
  emit_inline('</code>')
end

# File 'lib/rdoc/markup/to_html.rb', line 528

def html_list_name(list_type, open_tag)
  tags = LIST_TYPE_TO_HTML[list_type]
  raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless tags
  tags[open_tag ? 0 : 1]
end

# File 'lib/rdoc/markup/to_html.rb', line 84

def init_link_notation_regexp_handlings
  add_regexp_handling_RDOCLINK
end

# File 'lib/rdoc/markup/to_html.rb', line 70

def init_regexp_handlings
  # external links
  @markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)#{URL_CHARACTERS_REGEXP_STR}+\w/,
                              :HYPERLINK)

  # suppress crossref: \#method \::method \ClassName \method_with_underscores
  @markup.add_regexp_handling(/\\(?:[#:A-Z]|[a-z]+_[a-z0-9])/, :SUPPRESSED_CROSSREF)

  init_link_notation_regexp_handlings
end

# File 'lib/rdoc/markup/to_html.rb', line 554

def list_end_for(list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "</li>"
  when :LABEL, :NOTE then
    "</dd>"
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 538

def list_item_start(list_item, list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "<li>"
  when :LABEL, :NOTE then
    Array(list_item.label).map do |label|
      "<dt>#{to_html label}</dt>\n"
    end.join << "<dd>"
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end

# File 'lib/rdoc/markup/to_html.rb', line 568

def parseable?(text)
  verbose, $VERBOSE = $VERBOSE, nil
  catch(:valid) do
    eval("BEGIN { throw :valid, true }\n#{text}")
  end
rescue SyntaxError
  false
ensure
  $VERBOSE = verbose
end

# File 'lib/rdoc/markup/to_html.rb', line 281

def start_accepting
  @res = []
  @in_list_entry = []
  @list = []
  @heading_ids = {}
end

# File 'lib/rdoc/markup/to_html.rb', line 582

def to_html(item)
  # Ideally, we should convert html characters at handle_PLAIN_TEXT or somewhere else,
  # but we need to convert it here for now because to_html_characters converts pair of backticks to ’‘ and pair of double backticks to ”“.
  # Known bugs: `...` in `<code>def f(...); end</code>` and `(c) in `<a href="(c)">` will be wrongly converted.
  to_html_characters(handle_inline(item))
end