class RDoc::TopLevel

A TopLevel context is a representation of the contents of a single file

Attributes

Absolute name of this file

All the classes or modules that were declared in this file. These are assigned to either #classes_hash or #modules_hash once we know what they really are.

file_stat [RW]

This TopLevel’s File::Stat struct

parser [R]

The parser class that processed this file

relative_name [RW]

Relative name of this file

Public Class Methods

new (absolute_name, relative_name = absolute_name)

Source

# File lib/rdoc/code_object/top_level.rb, line 43
def initialize absolute_name, relative_name = absolute_name
  super()
  @name = nil
  @absolute_name = absolute_name
  @relative_name = relative_name
  @file_stat     = File.stat(absolute_name) rescue nil # HACK for testing
  @diagram       = nil
  @parser        = nil

  @classes_or_modules = []
end

Creates a new TopLevel for the file at absolute_name. If documentation is being generated outside the source dir relative_name is relative to the source directory.

Calls superclass method RDoc::Context::new

Public Instance Methods

== (other)

Source

# File lib/rdoc/code_object/top_level.rb, line 67
def == other
  self.class === other and @relative_name == other.relative_name
end

An RDoc::TopLevel is equal to another with the same relative_name

Also aliased as: eql?

add_alias (an_alias)

Source

# File lib/rdoc/code_object/top_level.rb, line 76
def add_alias(an_alias)
  object_class.record_location self
  return an_alias unless @document_self
  object_class.add_alias an_alias
end

Adds an_alias to Object instead of self.

add_constant (constant)

Source

# File lib/rdoc/code_object/top_level.rb, line 85
def add_constant constant
  object_class.record_location self
  return constant unless @document_self
  object_class.add_constant constant
end

Adds constant to Object instead of self.

add_include (include)

Source

# File lib/rdoc/code_object/top_level.rb, line 94
  def add_include(include)
    object_class.record_location self
    return include unless @document_self
    object_class.add_include include
  end

  ##
  # Adds +method+ to +Object+ instead of +self+.

  def add_method(method)
    object_class.record_location self
    return method unless @document_self
    object_class.add_method method
  end

  ##
  # Adds class or module +mod+. Used in the building phase
  # by the Ruby parser.

  def add_to_classes_or_modules mod
    @classes_or_modules << mod
  end

  ##
  # Base name of this file

  def base_name
    File.basename @relative_name
  end

  alias name base_name

  ##
  # Only a TopLevel that contains text file) will be displayed.  See also
  # RDoc::CodeObject#display?

  def display?
    text? and super
  end

  ##
  # See RDoc::TopLevel::find_class_or_module
  #--
  # TODO Why do we search through all classes/modules found, not just the
  #       ones of this instance?

  def find_class_or_module name
    @store.find_class_or_module name
  end

  ##
  # Finds a class or module named +symbol+

  def find_local_symbol(symbol)
    find_class_or_module(symbol) || super
  end

  ##
  # Finds a module or class with +name+

  def find_module_named(name)
    find_class_or_module(name)
  end

  ##
  # Returns the relative name of this file

  def full_name
    @relative_name
  end

  ##
  # An RDoc::TopLevel has the same hash as another with the same
  # relative_name

  def hash
    @relative_name.hash
  end

  ##
  # URL for this with a +prefix+

  def http_url(prefix)
    path = [prefix, @relative_name.tr('.', '_')]

    File.join(*path.compact) + '.html'
  end

  def inspect # :nodoc:
    "#<%s:0x%x %p modules: %p classes: %p>" % [
      self.class, object_id,
      base_name,
      @modules.map { |n, m| m },
      @classes.map { |n, c| c }
    ]
  end

  ##
  # Time this file was last modified, if known

  def last_modified
    @file_stat ? file_stat.mtime : nil
  end

  ##
  # Dumps this TopLevel for use by ri.  See also #marshal_load

  def marshal_dump
    [
      MARSHAL_VERSION,
      @relative_name,
      @parser,
      parse(@comment),
    ]
  end

  ##
  # Loads this TopLevel from +array+.

  def marshal_load array # :nodoc:
    initialize array[1]

    @parser  = array[2]
    @comment = array[3]

    @file_stat          = nil
  end

  ##
  # Returns the NormalClass "Object", creating it if not found.
  #
  # Records +self+ as a location in "Object".

  def object_class
    @object_class ||= begin
      oc = @store.find_class_named('Object') || add_class(RDoc::NormalClass, 'Object')
      oc.record_location self
      oc
    end
  end

  ##
  # Base name of this file without the extension

  def page_name
    basename = File.basename @relative_name
    basename =~ /\.(rb|rdoc|txt|md)$/i

    $` || basename
  end

  ##
  # Path to this file for use with HTML generator output.

  def path
    http_url @store.rdoc.generator.file_dir
  end

  def pretty_print q # :nodoc:
    q.group 2, "[#{self.class}: ", "]" do
      q.text "base name: #{base_name.inspect}"
      q.breakable

      items = @modules.map { |n, m| m }
      items.concat @modules.map { |n, c| c }
      q.seplist items do |mod| q.pp mod end
    end
  end

  ##
  # Search record used by RDoc::Generator::JsonIndex

  def search_record
    return unless @parser < RDoc::Parser::Text

    [
      page_name,
      '',
      page_name,
      '',
      path,
      '',
      snippet(@comment),
    ]
  end

  ##
  # Is this TopLevel from a text file instead of a source code file?

  def text?
    @parser and @parser.include? RDoc::Parser::Text
  end

  def to_s # :nodoc:
    "file #{full_name}"
  end

end

Adds include to Object instead of self.

add_method (method)

Source

# File lib/rdoc/code_object/top_level.rb, line 103
def add_method(method)
  object_class.record_location self
  return method unless @document_self
  object_class.add_method method
end

Adds method to Object instead of self.

add_to_classes_or_modules (mod)

Source

# File lib/rdoc/code_object/top_level.rb, line 113
def add_to_classes_or_modules mod
  @classes_or_modules << mod
end

Adds class or module mod. Used in the building phase by the Ruby parser.

base_name ()

Source

# File lib/rdoc/code_object/top_level.rb, line 120
def base_name
  File.basename @relative_name
end

Base name of this file

cvs_url ()

Source

# File lib/rdoc/generator/markup.rb, line 149
def cvs_url
  url = @store.rdoc.options.webcvs

  if /%s/ =~ url then
    url % @relative_name
  else
    url + @relative_name
  end
end

Returns a URL for this source file on some web repository. Use the -W command line option to set.

display? ()

Source

# File lib/rdoc/code_object/top_level.rb, line 130
def display?
  text? and super
end

Only a TopLevel that contains text file) will be displayed. See also RDoc::CodeObject#display?

Calls superclass method RDoc::CodeObject#display?

eql? (other)

Alias for: ==

find_class_or_module (name)

Source

# File lib/rdoc/code_object/top_level.rb, line 140
def find_class_or_module name
  @store.find_class_or_module name
end

See RDoc::TopLevel::find_class_or_module

find_local_symbol (symbol)

Source

# File lib/rdoc/code_object/top_level.rb, line 147
def find_local_symbol(symbol)
  find_class_or_module(symbol) || super
end

Finds a class or module named symbol

Calls superclass method RDoc::Context#find_local_symbol

find_module_named (name)

Source

# File lib/rdoc/code_object/top_level.rb, line 154
def find_module_named(name)
  find_class_or_module(name)
end

Finds a module or class with name

full_name ()

Source

# File lib/rdoc/code_object/top_level.rb, line 161
def full_name
  @relative_name
end

Returns the relative name of this file

hash ()

Source

# File lib/rdoc/code_object/top_level.rb, line 169
def hash
  @relative_name.hash
end

An RDoc::TopLevel has the same hash as another with the same relative_name

http_url (prefix)

Source

# File lib/rdoc/code_object/top_level.rb, line 176
def http_url(prefix)
  path = [prefix, @relative_name.tr('.', '_')]

  File.join(*path.compact) + '.html'
end

URL for this with a prefix

last_modified ()

Source

# File lib/rdoc/code_object/top_level.rb, line 194
def last_modified
  @file_stat ? file_stat.mtime : nil
end

Time this file was last modified, if known

marshal_dump ()

Source

# File lib/rdoc/code_object/top_level.rb, line 201
def marshal_dump
  [
    MARSHAL_VERSION,
    @relative_name,
    @parser,
    parse(@comment),
  ]
end

Dumps this TopLevel for use by ri. See also marshal_load

object_class ()

Source

# File lib/rdoc/code_object/top_level.rb, line 227
def object_class
  @object_class ||= begin
    oc = @store.find_class_named('Object') || add_class(RDoc::NormalClass, 'Object')
    oc.record_location self
    oc
  end
end

Returns the NormalClass “Object”, creating it if not found.

Records self as a location in “Object”.

page_name ()

Source

# File lib/rdoc/code_object/top_level.rb, line 238
def page_name
  basename = File.basename @relative_name
  basename =~ /\.(rb|rdoc|txt|md)$/i

  $` || basename
end

Base name of this file without the extension

parser= (val)

Source

# File lib/rdoc/code_object/top_level.rb, line 58
def parser=(val)
  @parser = val
  @store.update_parser_of_file(absolute_name, val) if @store
  @parser
end

Sets the parser for this toplevel context, also the store.

path ()

Source

# File lib/rdoc/code_object/top_level.rb, line 248
def path
  http_url @store.rdoc.generator.file_dir
end

Path to this file for use with HTML generator output.

search_record ()

Source

# File lib/rdoc/code_object/top_level.rb, line 266
def search_record
  return unless @parser < RDoc::Parser::Text

  [
    page_name,
    '',
    page_name,
    '',
    path,
    '',
    snippet(@comment),
  ]
end

Search record used by RDoc::Generator::JsonIndex

text? ()

Source

# File lib/rdoc/code_object/top_level.rb, line 283
def text?
  @parser and @parser.include? RDoc::Parser::Text
end

Is this TopLevel from a text file instead of a source code file?