Class RDoc::MethodAttr < RDoc::CodeObject

# File lib/rdoc/method_attr.rb, line 77
def initialize text, name
  super()

  @text = text
  @name = name

  @aliases      = []
  @is_alias_for = nil
  @parent_name  = nil
  @singleton    = nil
  @visibility   = :public
  @see = false

  @arglists     = nil
  @block_params = nil
  @call_seq     = nil
  @param_seq    = nil
  @params       = nil
end

# File lib/rdoc/method_attr.rb, line 100
def <=>(other)
  [     @singleton ? 0 : 1,       name] <=>
  [other.singleton ? 0 : 1, other.name]
end

# File lib/rdoc/method_attr.rb, line 193
def add_alias(an_alias, context)
  raise NotImplementedError
end

# File lib/rdoc/generator/markup.rb, line 86
def add_line_numbers(src)
  return unless src.sub!(/\A(.*)(, line (\d+))/, '\1')
  first = $3.to_i - 1
  last  = first + src.count("\n")
  size = last.to_s.length

  line = first
  src.gsub!(/^/) do
    res = if line == first then
            " " * (size + 1)
          else
            "<span class=\"line-num\">%2$*1$d</span> " % [size, line]
          end

    line += 1
    res
  end
end

# File lib/rdoc/method_attr.rb, line 200
def aref
  type = singleton ? 'c' : 'i'
  # % characters are not allowed in html names => dash instead
  "#{aref_prefix}-#{type}-#{html_name}"
end

# File lib/rdoc/method_attr.rb, line 209
def aref_prefix
  raise NotImplementedError
end

# File lib/rdoc/method_attr.rb, line 217
def block_params=(value)
  # 'yield.to_s' or 'assert yield, msg'
  return @block_params = '' if value =~ /^[\.,]/

  # remove trailing 'if/unless ...'
  return @block_params = '' if value =~ /^(if|unless)\s/

  value = $1.strip if value =~ /^(.+)\s(if|unless)\s/

  # outer parentheses
  value = $1 if value =~ /^\s*\((.*)\)\s*$/
  value = value.strip

  # proc/lambda
  return @block_params = $1 if value =~ /^(proc|lambda)(\s*\{|\sdo)/

  # surrounding +...+ or [...]
  value = $1.strip if value =~ /^\+(.*)\+$/
  value = $1.strip if value =~ /^\[(.*)\]$/

  return @block_params = '' if value.empty?

  # global variable
  return @block_params = 'str' if value =~ /^\$[&0-9]$/

  # wipe out array/hash indices
  value.gsub!(/(\w)\[[^\[]+\]/, '\1')

  # remove @ from class/instance variables
  value.gsub!(/@@?([a-z0-9_]+)/, '\1')

  # method calls => method name
  value.gsub!(/([A-Z:a-z0-9_]+)\.([a-z0-9_]+)(\s*\(\s*[a-z0-9_.,\s]*\s*\)\s*)?/) do
    case $2
    when 'to_s'      then $1
    when 'const_get' then 'const'
    when 'new' then
      $1.split('::').last.  # ClassName => class_name
        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
        gsub(/([a-z\d])([A-Z])/,'\1_\2').
        downcase
    else
      $2
    end
  end

  # class prefixes
  value.gsub!(/[A-Za-z0-9_:]+::/, '')

  # simple expressions
  value = $1 if value =~ /^([a-z0-9_]+)\s*[-*+\/]/

  @block_params = value.strip
end

# File lib/rdoc/method_attr.rb, line 116
def documented?
  super or
    (is_alias_for and is_alias_for.documented?) or
    (see and see.documented?)
end

# File lib/rdoc/method_attr.rb, line 284
def full_name
  @full_name ||= "#{parent_name}#{pretty_name}"
end

# File lib/rdoc/method_attr.rb, line 275
def html_name
  require 'cgi'

  CGI.escape(@name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
end

# File lib/rdoc/generator/markup.rb, line 110
def markup_code
  return '' unless @token_stream

  src = RDoc::TokenStream.to_html @token_stream

  # dedent the source
  indent = src.length
  lines = src.lines.to_a
  lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
  lines.each do |line|
    if line =~ /^ *(?=\S)/
      n = $&.length
      indent = n if n < indent
      break if n == 0
    end
  end
  src.gsub!(/^#{' ' * indent}/, '') if indent > 0

  add_line_numbers(src) if RDoc::MethodAttr.add_line_numbers

  src
end

# File lib/rdoc/method_attr.rb, line 303
def name_prefix
  @singleton ? '::' : '#'
end

# File lib/rdoc/method_attr.rb, line 314
def output_name context
  return "#{name_prefix}#{@name}" if context == parent

  "#{parent_name}#{@singleton ? '.' : '#'}#{@name}"
end

# File lib/rdoc/method_attr.rb, line 344
def parent_name
  @parent_name || super
end

# File lib/rdoc/method_attr.rb, line 337
def path
  "#{@parent.path}##{aref}"
end

# File lib/rdoc/method_attr.rb, line 323
def pretty_name
  "#{name_prefix}#{@name}"
end

# File lib/rdoc/method_attr.rb, line 377
def search_record
  [
    @name,
    full_name,
    @name,
    @parent.full_name,
    path,
    params,
    snippet(@comment),
  ]
end

# File lib/rdoc/method_attr.rb, line 136
def see
  @see = find_see if @see == false
  @see
end

# File lib/rdoc/method_attr.rb, line 144
def store= store
  super

  @file = @store.add_file @file.full_name if @file
end

# File lib/rdoc/method_attr.rb, line 330
def type
  singleton ? 'class' : 'instance'
end