module YARD::Templates::Helpers::HtmlHelper

def anchor_for(object)
  case object
  when CodeObjects::MethodObject
    "#{object.name}-#{object.scope}_#{object.type}"
  when CodeObjects::ClassVariableObject
    "#{object.name.to_s.gsub('@@', '')}-#{object.type}"
  when CodeObjects::Base
    "#{object.name}-#{object.type}"
  when CodeObjects::Proxy
    object.path
  else
    object.to_s
  end
end

def charset
  return 'utf-8' unless RUBY19 || lang = ENV['LANG']
  if RUBY19
    lang = Encoding.default_external.name.downcase
  else
    lang = lang.downcase.split('.').last
  end
  case lang
  when "ascii-8bit", "us-ascii", "ascii-7bit"; 'iso-8859-1'
  else; lang
  end
end

def convert_method_to_overload(meth)
  # use first overload tag if it has a return type and method itself does not
  if !meth.tag(:return) && meth.tags(:overload).size == 1 && meth.tag(:overload).tag(:return)
    return meth.tag(:overload)
  end
  meth
end

def format_object_name_list(objects)
  objects.sort_by {|o| o.name.to_s.downcase }.map do |o| 
    "<span class='name'>" + linkify(o, o.name) + "</span>" 
  end.join(", ")
end

def format_types(typelist, brackets = true)
  return unless typelist.is_a?(Array)
  list = typelist.map do |type| 
    type = type.gsub(/([<>])/) { h($1) }
    type = type.gsub(/([\w:]+)/) { $1 == "lt" || $1 == "gt" ? $1 : linkify($1, $1) }
    "<tt>" + type + "</tt>"
  end
  list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
end

def h(text)
  CGI.escapeHTML(text.to_s)
end

def html_markup_html(text)
  text
end

def html_markup_markdown(text)
  # TODO: other libraries might be more complex
  markup_class(:markdown).new(text).to_html
end

def html_markup_none(text)
  h(text).gsub(/(?:\r?\n){2}/, '<br/>')
end

def html_markup_rdoc(text)
  doc = markup_class(:rdoc).new(text)
  doc.from_path = url_for(object) if doc.respond_to?(:from_path=)
  doc.to_html
end

def html_markup_text(text)
  "<pre>" + text + "</pre>"
end

def html_markup_textile(text)
  doc = markup_class(:textile).new(text)
  doc.hard_breaks = false if doc.respond_to?(:hard_breaks=)
  doc.to_html
end

def html_syntax_highlight(source, type = nil)
  return "" unless source
  return h(source) if options[:no_highlight]
  type ||= object.source_type || :ruby
  # handle !!!LANG prefix to send to html_syntax_highlight_LANG
  if source =~ /\A(?:[ \t]*\r?\n)?[ \t]*!!!([\w.+-]+)[ \t]*\r?\n/
    type, source = $1, $'
    source = $'
  end
  
  meth = "html_syntax_highlight_#{type}"
  respond_to?(meth) ? send(meth, source) : h(source)
end

def html_syntax_highlight_plain(source)
  h(source)
end

def htmlify(text, markup = options[:markup])
  markup_meth = "html_markup_#{markup}"
  return text unless respond_to?(markup_meth)
  return "" unless text
  return text unless markup
  load_markup_provider(markup)
  html = send(markup_meth, text)
  if html.respond_to?(:encode)
    html = html.force_encoding(text.encoding) # for libs that mess with encoding
    html = html.encode(:invalid => :replace, :replace => '?')
  end
  html = resolve_links(html)
  html = html.gsub(/<pre>(?:\s*<code>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
    str = $1
    str = html_syntax_highlight(CGI.unescapeHTML(str)) unless options[:no_highlight]
    %Q{<pre class="code">#{str}</pre>}
  end unless markup == :text
  html
end

def htmlify_line(*args)
  "<div class='inline'>" + htmlify(*args) + "</div>"
end

def link_file(filename, title = nil, anchor = nil)
  link_url(url_for_file(filename, anchor), title)
end

def link_include_object(obj)
  htmlify(obj.docstring)
end

def link_object(obj, otitle = nil, anchor = nil, relative = true)
  return otitle if obj.nil?
  obj = Registry.resolve(object, obj, true, true) if obj.is_a?(String)
  if !otitle && obj.root?
    title = "Top Level Namespace"
  elsif otitle
    title = otitle.to_s
  elsif object.is_a?(CodeObjects::Base)
    title = h(object.relative_path(obj))
  else
    title = h(obj.to_s)
  end
  return title unless serializer
  return title if obj.is_a?(CodeObjects::Proxy)
        
  link = url_for(obj, anchor, relative)
  link = link ? link_url(link, title, :title => "#{obj.path} (#{obj.type})") : title
  "<span class='object_link'>" + link + "</span>"
end

def link_url(url, title = nil, params = {})
  title ||= url
  title.gsub!(/[\r\n]/, ' ')
  params = SymbolHash.new(false).update(
    :href => url,
    :title  => h(title)
  ).update(params)
  params[:target] ||= '_parent' if url =~ /^(\w+):\/\//
  "<a #{tag_attrs(params)}>#{title}</a>".gsub(/[\r\n]/, ' ')
end

def resolve_links(text)
  code_tags = 0
  text.gsub(/<(\/)?(pre|code|tt)|\{(\S+?)(?:\s(.*?\S))?\}(?=[\W<]|.+<\/|$)/m) do |str|
    closed, tag, name, title, match = $1, $2, $3, $4, $&
    if tag
      code_tags += (closed ? -1 : 1)
      next str
    end
    next str unless code_tags == 0
    
    next(match) if name[0,1] == '|'
    if object.is_a?(String)
      object
    else
      link = linkify(name, title)
      if link == name || link == title
        match = /(.+)?(\{#{Regexp.quote name}(?:\s.*?)?\})(.+)?/.match(text)
        file = (@file ? @file : object.file) || '(unknown)'
        line = (@file ? 1 : (object.docstring.line_range ? object.docstring.line_range.first : 1)) + (match ? $`.count("\n") : 0)
        log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text" + (match ? ":" : ".")
        log.warn((match[1] ? '...' : '') + match[2].gsub("\n","") + (match[3] ? '...' : '')) if match
      end
      
      link
    end
  end
end

def signature(meth, link = true, show_extras = true, full_attr_name = true)
  meth = convert_method_to_overload(meth)
  
  type = signature_types(meth, link)
  scope = meth.scope == :class ? "+" : "-"
  name = full_attr_name ? meth.name : meth.name.to_s.gsub(/^(\w+)=$/, '\1')
  blk = format_block(meth)
  args = !full_attr_name && meth.writer? ? "" : format_args(meth)
  extras = []
  extras_text = ''
  if show_extras
    if rw = meth.attr_info
      attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
      attname = attname.size == 1 ? attname.join('') + 'only' : nil
      extras << attname if attname
    end
    extras << meth.visibility if meth.visibility != :public
    extras_text = ' <span class="extras">(' + extras.join(", ") + ')</span>' unless extras.empty?
  end
  title = "%s %s<strong>%s</strong>%s %s" % [scope, type, h(name), args, blk]
  if link
    if meth.is_a?(YARD::CodeObjects::MethodObject)
      link_title = "#{h meth.name(true)} (#{meth.scope} #{meth.type})"
    else
      link_title = "#{h name} (#{meth.type})"
    end
    link_url(url_for(meth), title, :title => link_title) + extras_text
  else
    title + extras_text
  end
end

def signature_types(meth, link = true)
  meth = convert_method_to_overload(meth)
  type = options[:default_return] || ""
  if meth.tag(:return) && meth.tag(:return).types
    types = meth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
    first = link ? h(types.first) : format_types([types.first], false)
    if types.size == 2 && types.last == 'nil'
      type = first + '<sup>?</sup>'
    elsif types.size == 2 && types.last =~ /^(Array)?<#{Regexp.quote types.first}>$/
      type = first + '<sup>+</sup>'
    elsif types.size > 2
      type = [first, '...'].join(', ')
    elsif types == ['void'] && options[:hide_void_return]
      type = ""
    else
      type = link ? h(types.join(", ")) : format_types(types, false)
    end
  elsif !type.empty?
    type = link ? h(type) : format_types([type], false)
  end
  type = "(#{type}) " unless type.empty?
  type
end

def tag_attrs(opts = {})
  opts.sort_by {|k, v| k.to_s }.map {|k,v| "#{k}=#{v.to_s.inspect}" if v }.join(" ")
end

def url_for(obj, anchor = nil, relative = true)
  link = nil
  return link unless serializer
  
  if obj.is_a?(CodeObjects::Base) && !obj.is_a?(CodeObjects::NamespaceObject)
    # If the obj is not a namespace obj make it the anchor.
    anchor, obj = obj, obj.namespace
  end
  
  objpath = serializer.serialized_path(obj)
  return link unless objpath

  if relative
    fromobj = object
    if object.is_a?(CodeObjects::Base) && 
        !object.is_a?(CodeObjects::NamespaceObject)
      fromobj = fromobj.namespace
    end
    from = serializer.serialized_path(fromobj)
    link = File.relative_path(from, objpath)
  else
    link = objpath
  end

  link + (anchor ? '#' + urlencode(anchor_for(anchor)) : '')
end

def url_for_file(filename, anchor = nil)
  fromobj = object
  if CodeObjects::Base === fromobj && !fromobj.is_a?(CodeObjects::NamespaceObject)
    fromobj = fromobj.namespace
  end
  from = serializer.serialized_path(fromobj)
  if filename == options[:readme]
    filename = 'index'
  else
    filename = 'file.' + File.basename(filename).gsub(/\.[^.]+$/, '')
  end
  link = File.relative_path(from, filename)
  link + '.html' + (anchor ? '#' + urlencode(anchor) : '')
end

def urlencode(text)
  CGI.escape(text.to_s)
end