Parser

# File lib/rdoc/parser.rb, line 50
def self.alias_extension(old_ext, new_ext)
  old_ext = old_ext.sub(%r^\.(.*)/, '\1')
  new_ext = new_ext.sub(%r^\.(.*)/, '\1')

  parser = can_parse "xxx.#{old_ext}"
  return false unless parser

  RDoc::Parser.parsers.unshift [%r\.#{new_ext}$/, parser]

  true
end

# File lib/rdoc/parser.rb, line 66
def self.binary?(file)
  return false if file =~ %r\.(rdoc|txt)$/

  s = File.read(file, 1024) or return false

  have_encoding = s.respond_to? :encoding

  if have_encoding then
    return false if s.encoding != Encoding::ASCII_8BIT and s.valid_encoding?
  end

  return true if s[0, 2] == Marshal.dump('')[0, 2] or s.index("\x00")

  if have_encoding then
    s.force_encoding Encoding.default_external

    not s.valid_encoding?
  else
    if 0.respond_to? :fdiv then
      s.count("\x00-\x7F", "^ -~\t\r\n").fdiv(s.size) > 0.3
    else # HACK 1.8.6
      (s.count("\x00-\x7F", "^ -~\t\r\n").to_f / s.size) > 0.3
    end
  end
end

# File lib/rdoc/parser.rb, line 132
def self.can_parse(file_name)
  parser = RDoc::Parser.parsers.find { |regexp,| regexp =~ file_name }.last

  # HACK Selenium hides a jar file using a .txt extension
  return if parser == RDoc::Parser::Simple and zip? file_name

  # The default parser must not parse binary files
  ext_name = File.extname file_name
  return parser if ext_name.empty?
  return if parser == RDoc::Parser::Simple and ext_name !~ %rtxt|rdoc/

  parser
end

# File lib/rdoc/parser.rb, line 150
def self.for top_level, file_name, content, options, stats
  return if binary? file_name

  parser = use_markup content

  unless parser then
    # If no extension, look for shebang
    if file_name !~ %r\.\w+$/ && content =~ %r{\A#!(.+)} then
      shebang = $1
      case shebang
      when %r{env\s+ruby}, %r{/ruby}
        file_name = "dummy.rb"
      end
    end

    parser = can_parse file_name
  end

  return unless parser

  parser.new top_level, file_name, content, options, stats
end

# File lib/rdoc/parser.rb, line 220
def initialize top_level, file_name, content, options, stats
  @top_level = top_level
  @top_level.parser = self.class

  @file_name = file_name
  @content = content
  @options = options
  @stats = stats

  @preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
  @preprocess.options = @options
end

# File lib/rdoc/parser.rb, line 178
def self.parse_files_matching(regexp)
  RDoc::Parser.parsers.unshift [regexp, self]
end

# File lib/rdoc/parser.rb, line 97
def self.process_directive code_object, directive, value
  warn "RDoc::Parser::process_directive is deprecated and wil be removed in RDoc 4.  Use RDoc::Markup::PreProcess#handle_directive instead" if $-w

  case directive
  when 'nodoc' then
    code_object.document_self = nil # notify nodoc
    code_object.document_children = value.downcase != 'all'
  when 'doc' then
    code_object.document_self = true
    code_object.force_documentation = true
  when 'yield', 'yields' then
    # remove parameter &block
    code_object.params.sub!(%r,?\s*&\w+/, '') if code_object.params

    code_object.block_params = value
  when 'arg', 'args' then
    code_object.params = value
  end
end

# File lib/rdoc/parser.rb, line 199
def self.use_markup content
  markup = content.lines.first(3).grep(%rmarkup:\s+(\w+)/) { $1 }.first

  return unless markup

  # TODO Ruby should be returned only when the filename is correct
  return RDoc::Parser::Ruby if %w[tomdoc markdown].include? markup

  markup = Regexp.escape markup

  RDoc::Parser.parsers.find do |_, parser|
    %r^#{markup}$/ =~ parser.name.sub(%r.*:/, '')
  end.last
end

# File lib/rdoc/parser.rb, line 121
def self.zip? file
  zip_signature = File.read file, 4

  zip_signature == "PK\x03\x04" or
    zip_signature == "PK\x05\x06" or
    zip_signature == "PK\x07\x08"
end