rdoc 3.9.5 → 3.10.pre.1

data/lib/rdoc/markup/attr_changer.rb

@@ -0,0 +1,25 @@
+class RDoc::Markup
+
+  AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:
+
+end
+
+##
+# An AttrChanger records a change in attributes. It contains a bitmap of the
+# attributes to turn on, and a bitmap of those to turn off.
+
+class RDoc::Markup::AttrChanger
+
+  def to_s # :nodoc:
+    "Attr: +#{RDoc::Markup::Attribute.as_string turn_on}/-#{RDoc::Markup::Attribute.as_string turn_off}"
+  end
+
+  def inspect # :nodoc:
+    "+%s/-%s" % [
+      RDoc::Markup::Attribute.as_string(turn_on),
+      RDoc::Markup::Attribute.as_string(turn_off),
+    ]
+  end
+
+end
+

data/lib/rdoc/markup/attr_span.rb

@@ -0,0 +1,29 @@
+##
+# An array of attributes which parallels the characters in a string.
+
+class RDoc::Markup::AttrSpan
+
+  ##
+  # Creates a new AttrSpan for +length+ characters
+
+  def initialize(length)
+    @attrs = Array.new(length, 0)
+  end
+
+  ##
+  # Toggles +bits+ from +start+ to +length+
+  def set_attrs(start, length, bits)
+    for i in start ... (start+length)
+      @attrs[i] |= bits
+    end
+  end
+
+  ##
+  # Accesses flags for character +n+
+
+  def [](n)
+    @attrs[n]
+  end
+
+end
+

data/lib/rdoc/markup/attribute.rb

@@ -0,0 +1,51 @@
+##
+# We manage a set of attributes. Each attribute has a symbol name and a bit
+# value.
+
+class RDoc::Markup::Attribute
+
+  ##
+  # Special attribute type.  See RDoc::Markup#add_special
+
+  SPECIAL = 1
+
+  @@name_to_bitmap = { :_SPECIAL_ => SPECIAL }
+  @@next_bitmap = 2
+
+  ##
+  # Returns a unique bit for +name+
+
+  def self.bitmap_for(name)
+    bitmap = @@name_to_bitmap[name]
+    unless bitmap then
+      bitmap = @@next_bitmap
+      @@next_bitmap <<= 1
+      @@name_to_bitmap[name] = bitmap
+    end
+    bitmap
+  end
+
+  ##
+  # Returns a string representation of +bitmap+
+
+  def self.as_string(bitmap)
+    return "none" if bitmap.zero?
+    res = []
+    @@name_to_bitmap.each do |name, bit|
+      res << name if (bitmap & bit) != 0
+    end
+    res.join(",")
+  end
+
+  ##
+  # yields each attribute name in +bitmap+
+
+  def self.each_name_of(bitmap)
+    @@name_to_bitmap.each do |name, bit|
+      next if bit == SPECIAL
+      yield name.to_s if (bitmap & bit) != 0
+    end
+  end
+
+end
+

data/lib/rdoc/markup/document.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::Document
   # The file this document was created from.  See also
   # RDoc::ClassModule#add_comment
 
-  attr_accessor :file
+  attr_reader :file
 
   ##
   # The parts of the Document
@@ -74,6 +74,18 @@ class RDoc::Markup::Document
     @parts.empty? or (@parts.length == 1 and merged? and @parts.first.empty?)
   end
 
+  ##
+  # The file this Document was created from.
+
+  def file= location
+    @file = case location
+            when RDoc::TopLevel then
+              location.absolute_name
+            else
+              location
+            end
+  end
+
   ##
   # When this is a collection of documents (#file is not set and this document
   # contains only other documents as its direct children) #merge replaces
@@ -123,5 +135,14 @@ class RDoc::Markup::Document
     self.parts.push(*parts)
   end
 
+  ##
+  # Returns an Array of headings in the document.
+  #
+  # Require 'rdoc/markup/formatter' before calling this method.
+
+  def table_of_contents
+    accept RDoc::Markup::ToTableOfContents.to_toc
+  end
+
 end
 

data/lib/rdoc/markup/formatter.rb

@@ -1,9 +1,9 @@
-require 'rdoc/markup'
-
 ##
 # Base class for RDoc markup formatters
 #
-# Formatters use a visitor pattern to convert content into output.
+# Formatters are a visitor that converts an RDoc::Markup tree (from a comment)
+# into some kind of output.  RDoc ships with formatters for converting back to
+# rdoc, ANSI text, HTML, a Table of Contents and other formats.
 #
 # If you'd like to write your own Formatter use
 # RDoc::Markup::FormatterTestCase.  If you're writing a text-output formatter
@@ -58,7 +58,7 @@ class RDoc::Markup::Formatter
   ##
   # Marks up +content+
 
-  def convert(content)
+  def convert content
     @markup.convert content, self
   end
 
@@ -160,10 +160,3 @@ class RDoc::Markup::Formatter
 
 end
 
-class RDoc::Markup
-  autoload :ToAnsi,         'rdoc/markup/to_ansi'
-  autoload :ToBs,           'rdoc/markup/to_bs'
-  autoload :ToHtml,         'rdoc/markup/to_html'
-  autoload :ToHtmlCrossref, 'rdoc/markup/to_html_crossref'
-  autoload :ToRdoc,         'rdoc/markup/to_rdoc'
-end

data/lib/rdoc/markup/formatter_test_case.rb

@@ -1,5 +1,4 @@
 require 'minitest/unit'
-require 'rdoc/markup/formatter'
 
 ##
 # Test case for creating new RDoc::Markup formatters.  See
@@ -54,8 +53,8 @@ class RDoc::Markup::FormatterTestCase < MiniTest::Unit::TestCase
   def setup
     super
 
-    @m = RDoc::Markup.new
     @RM = RDoc::Markup
+    @m = @RM.new
 
     @bullet_list = @RM::List.new(:BULLET,
       @RM::ListItem.new(nil, @RM::Paragraph.new('l1')),

data/lib/rdoc/markup/heading.rb

@@ -3,6 +3,35 @@
 
 class RDoc::Markup::Heading < Struct.new :level, :text
 
+  @to_html = nil
+  @to_label = nil
+
+  ##
+  # A singleton RDoc::Markup::ToLabel formatter for headings.
+
+  def self.to_label
+    @to_label ||= RDoc::Markup::ToLabel.new
+  end
+
+  ##
+  # A singleton plain HTML formatter for headings.  Used for creating labels
+  # for the Table of Contents
+
+  def self.to_html
+    return @to_html if @to_html
+
+    markup = RDoc::Markup.new
+    markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
+
+    @to_html = RDoc::Markup::ToHtml.new
+
+    def @to_html.handle_special_CROSSREF special
+      special.text.sub(/^\\/, '')
+    end
+
+    @to_html
+  end
+
   ##
   # Calls #accept_heading on +visitor+
 
@@ -10,6 +39,21 @@ class RDoc::Markup::Heading < Struct.new :level, :text
     visitor.accept_heading self
   end
 
+  ##
+  # An HTML-safe label for this header.
+
+  def label
+    "label-#{self.class.to_label.convert text.dup}"
+  end
+
+  ##
+  # HTML markup of the text of this label without the surrounding header
+  # element.
+
+  def plain_html
+    self.class.to_html.to_html(text.dup)
+  end
+
   def pretty_print q # :nodoc:
     q.group 2, "[head: #{level} ", ']' do
       q.pp text

data/lib/rdoc/markup/include.rb

@@ -0,0 +1,42 @@
+##
+# A file included at generation time.  Objects of this class are created by
+# RDoc::RD for an extension-less include.
+#
+# This implementation in incomplete.
+
+class RDoc::Markup::Include
+
+  ##
+  # The filename to be included, without extension
+
+  attr_reader :file
+
+  ##
+  # Directories to search for #file
+
+  attr_reader :include_path
+
+  ##
+  # Creates a new include that will import +file+ from +include_path+
+
+  def initialize file, include_path
+    @file = file
+    @include_path = include_path
+  end
+
+  def == other # :nodoc:
+    self.class === other and
+      @file == other.file and @include_path == other.include_path
+  end
+
+  def pretty_print q # :nodoc:
+    q.group 2, '[incl ', ']' do
+      q.text file
+      q.breakable
+      q.text 'from '
+      q.pp include_path
+    end
+  end
+
+end
+

data/lib/rdoc/markup/inline.rb

@@ -1,144 +1 @@
-require 'rdoc'
-class RDoc::Markup
-
-  ##
-  # We manage a set of attributes. Each attribute has a symbol name and a bit
-  # value.
-
-  class Attribute
-
-    ##
-    # Special attribute type.  See RDoc::Markup#add_special
-
-    SPECIAL = 1
-
-    @@name_to_bitmap = { :_SPECIAL_ => SPECIAL }
-    @@next_bitmap = 2
-
-    ##
-    # Returns a unique bit for +name+
-
-    def self.bitmap_for(name)
-      bitmap = @@name_to_bitmap[name]
-      unless bitmap then
-        bitmap = @@next_bitmap
-        @@next_bitmap <<= 1
-        @@name_to_bitmap[name] = bitmap
-      end
-      bitmap
-    end
-
-    ##
-    # Returns a string representation of +bitmap+
-
-    def self.as_string(bitmap)
-      return "none" if bitmap.zero?
-      res = []
-      @@name_to_bitmap.each do |name, bit|
-        res << name if (bitmap & bit) != 0
-      end
-      res.join(",")
-    end
-
-    ##
-    # yields each attribute name in +bitmap+
-
-    def self.each_name_of(bitmap)
-      @@name_to_bitmap.each do |name, bit|
-        next if bit == SPECIAL
-        yield name.to_s if (bitmap & bit) != 0
-      end
-    end
-
-  end
-
-  AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:
-
-  ##
-  # An AttrChanger records a change in attributes. It contains a bitmap of the
-  # attributes to turn on, and a bitmap of those to turn off.
-
-  class AttrChanger
-    def to_s # :nodoc:
-      "Attr: +#{Attribute.as_string turn_on}/-#{Attribute.as_string turn_off}"
-    end
-
-    def inspect # :nodoc:
-      "+%s/-%s" % [
-        Attribute.as_string(turn_on),
-        Attribute.as_string(turn_off),
-      ]
-    end
-  end
-
-  ##
-  # An array of attributes which parallels the characters in a string.
-
-  class AttrSpan
-
-    ##
-    # Creates a new AttrSpan for +length+ characters
-
-    def initialize(length)
-      @attrs = Array.new(length, 0)
-    end
-
-    ##
-    # Toggles +bits+ from +start+ to +length+
-    def set_attrs(start, length, bits)
-      for i in start ... (start+length)
-        @attrs[i] |= bits
-      end
-    end
-
-    ##
-    # Accesses flags for character +n+
-
-    def [](n)
-      @attrs[n]
-    end
-
-  end
-
-  ##
-  # Hold details of a special sequence
-
-  class Special
-
-    ##
-    # Special type
-
-    attr_reader   :type
-
-    ##
-    # Special text
-
-    attr_accessor :text
-
-    ##
-    # Creates a new special sequence of +type+ with +text+
-
-    def initialize(type, text)
-      @type, @text = type, text
-    end
-
-    ##
-    # Specials are equal when the have the same text and type
-
-    def ==(o)
-      self.text == o.text && self.type == o.type
-    end
-
-    def inspect # :nodoc:
-      "#<RDoc::Markup::Special:0x%x @type=%p, name=%p @text=%p>" % [
-        object_id, @type, RDoc::Markup::Attribute.as_string(type), text.dump]
-    end
-
-    def to_s # :nodoc:
-      "Special: type=#{type}, name=#{RDoc::Markup::Attribute.as_string type}, text=#{text.dump}"
-    end
-
-  end
-
-end
-
+warn "requiring rdoc/markup/inline is deprecated and will be removed in RDoc 4." if $-w

data/lib/rdoc/markup/list.rb

@@ -14,7 +14,8 @@ class RDoc::Markup::List
   attr_reader :items
 
   ##
-  # Creates a new list of +type+ with +items+
+  # Creates a new list of +type+ with +items+.  Valid list types are:
+  # +:BULLET+, +:LABEL+, +:LALPHA+, +:NOTE+, +:NUMBER+, +:UALPHA+ 
 
   def initialize type = nil, *items
     @type = type