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 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 584

def tidy_link_capturing?
  !!@tidy_link_buffer
end

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

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 305

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

  label = heading.label @code_object

  @res << if @options.output_decoration
            "\n<h#{level} id=\"#{label}\">"
          else
            "\n<h#{level}>"
          end
  @res << to_html(heading.text)
  unless @options.pipe then
    @res << "<span><a href=\"##{label}\">&para;</a>"
    @res << " <a href=\"#top\">&uarr;</a></span>"
  end
  @res << "</h#{level}>\n"
end

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

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 290

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 279

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 259

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 209

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 326

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

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

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

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

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 222

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

  klass = nil

  content = if verbatim.ruby? or parseable? text then
              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
              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 480

def append_flow_fragment(res, fragment)
  return if fragment.nil? || fragment.empty?

  emit_tidy_link_fragment(res, fragment)
end

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

def append_to_tidy_label(fragment)
  @tidy_link_buffer << fragment
end

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

def convert_complete_tidy_link(text)
  return text unless
    text =~ TIDY_LINK_WITH_BRACES or text =~ TIDY_LINK_SINGLE_WORD

  label = $1
  url   = CGI.escapeHTML($2)

  label_html = if /^rdoc-image:/ =~ label
                 handle_RDOCLINK(label)
               else
                 render_tidy_link_label(label)
               end

  gen_url url, label_html
end

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

def convert_flow(flow_items)
  res = []

  flow_items.each do |item|
    case item
    when String
      append_flow_fragment res, convert_string(item)
    when RDoc::Markup::AttrChanger
      off_tags res, item
      on_tags  res, item
    when RDoc::Markup::RegexpHandling
      append_flow_fragment res, convert_regexp_handling(item)
    else
      raise "Unknown flow element: #{item.inspect}"
    end
  end

  res.join
end

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

def convert_string(text)
  CGI.escapeHTML text
end

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

def emit_tidy_link_fragment(res, fragment)
  if tidy_link_capturing?
    append_to_tidy_label fragment
  else
    res << fragment
  end
end

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

def end_accepting
  @res.join
end

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

def extract_tidy_link_parts(text)
  if text =~ TIDY_LINK_WITH_BRACES
    [$1, CGI.escapeHTML($2), $3]
  elsif text =~ TIDY_LINK_WITH_BRACES_TAIL
    [$1, CGI.escapeHTML($2), $3]
  elsif text =~ TIDY_LINK_SINGLE_WORD
    [$1, CGI.escapeHTML($2), $3]
  else
    [text, nil, '']
  end
end

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

def finish_tidy_link(text)
  label_tail, url, trailing = extract_tidy_link_parts(text)
  append_to_tidy_label CGI.escapeHTML(label_tail) unless label_tail.empty?

  return '' unless url

  label_html = @tidy_link_buffer
  @tidy_link_buffer = nil
  link = gen_url(url, label_html)

  return link if trailing.empty?

  link + CGI.escapeHTML(trailing)
end

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

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

  if %w[http https link].include?(scheme) and
     url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
    "<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>"

    link = "<sup>#{link}</sup>" if /"foot/ =~ id

    link
  end
end

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

def handle_RDOCLINK(url) # :nodoc:
  case url
  when /^rdoc-ref:/
    CGI.escapeHTML($')
  when /^rdoc-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 119

def handle_regexp_HARD_BREAK(target)
  '<br>'
end

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

def handle_regexp_HYPERLINK(target)
  url = CGI.escapeHTML(target.text)

  gen_url url, url
end

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

def handle_regexp_RDOCLINK(target)
  handle_RDOCLINK target.text
end

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

def handle_regexp_TIDYLINK(target)
  text = target.text

  if tidy_link_capturing?
    return finish_tidy_link(text)
  end

  if text.start_with?('{') && !text.include?('}')
    start_tidy_link text
    return ''
  end

  convert_complete_tidy_link(text)
end

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

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 81

def init_link_notation_regexp_handlings
  add_regexp_handling_RDOCLINK
  add_regexp_handling_TIDYLINK
end

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

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

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

def init_tags
  add_tag :BOLD, "<strong>", "</strong>"
  add_tag :TT,   "<code>",   "</code>"
  add_tag :EM,   "<em>",     "</em>"
end

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

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 410

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 572

def off_tags(res, item)
  each_attr_tag(item.turn_off, true) do |tag|
    emit_tidy_link_fragment(res, annotate(tag.off))
    @in_tt -= 1 if tt? tag
  end
end

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

def on_tags(res, item)
  each_attr_tag(item.turn_on) do |tag|
    emit_tidy_link_fragment(res, annotate(tag.on))
    @in_tt += 1 if tt? tag
  end
end

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

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 588

def render_tidy_link_label(label)
  RDoc::Markup::LinkLabelToHtml.render(label, @options, @from_path)
end

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

def start_accepting
  @res = []
  @in_list_entry = []
  @list = []
end

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

def start_tidy_link(text)
  @tidy_link_buffer = String.new
  append_to_tidy_label CGI.escapeHTML(text.delete_prefix('{'))
end

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

def to_html(item)
  super convert_flow @am.flow item
end