add tag v2_2_9

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/tags/v2_2_9@61257 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 169 insertions, 0 deletions

diff --git a/ruby_2_2/lib/rdoc/generator/markup.rb b/ruby_2_2/lib/rdoc/generator/markup.rb
new file mode 100644
index 0000000000..788e5a485d
--- /dev/null
+++ b/ruby_2_2/lib/rdoc/generator/markup.rb
@@ -0,0 +1,169 @@
+##
+# Handle common RDoc::Markup tasks for various CodeObjects
+#
+# This module is loaded by generators.  It allows RDoc's CodeObject tree to
+# avoid loading generator code to improve startup time for +ri+.
+
+module RDoc::Generator::Markup
+
+  ##
+  # Generates a relative URL from this object's path to +target_path+
+
+  def aref_to(target_path)
+    RDoc::Markup::ToHtml.gen_relative_url path, target_path
+  end
+
+  ##
+  # Generates a relative URL from +from_path+ to this object's path
+
+  def as_href(from_path)
+    RDoc::Markup::ToHtml.gen_relative_url from_path, path
+  end
+
+  ##
+  # Handy wrapper for marking up this object's comment
+
+  def description
+    markup @comment
+  end
+
+  ##
+  # Creates an RDoc::Markup::ToHtmlCrossref formatter
+
+  def formatter
+    return @formatter if defined? @formatter
+
+    options = @store.rdoc.options
+    this = RDoc::Context === self ? self : @parent
+
+    @formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this
+    @formatter.code_object = self
+    @formatter
+  end
+
+  ##
+  # Build a webcvs URL starting for the given +url+ with +full_path+ appended
+  # as the destination path.  If +url+ contains '%s' +full_path+ will be
+  # will replace the %s using sprintf on the +url+.
+
+  def cvs_url(url, full_path)
+    if /%s/ =~ url then
+      sprintf url, full_path
+    else
+      url + full_path
+    end
+  end
+
+end
+
+class RDoc::CodeObject
+
+  include RDoc::Generator::Markup
+
+end
+
+class RDoc::MethodAttr
+
+  @add_line_numbers = false
+
+  class << self
+    ##
+    # Allows controlling whether <tt>#markup_code</tt> adds line numbers to
+    # the source code.
+
+    attr_accessor :add_line_numbers
+  end
+
+  ##
+  # Prepend +src+ with line numbers.  Relies on the first line of a source
+  # code listing having:
+  #
+  #   # File xxxxx, line dddd
+  #
+  # If it has this comment then line numbers are added to +src+ and the <tt>,
+  # line dddd</tt> portion of the comment is removed.
+
+  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
+
+  ##
+  # Turns the method's token stream into HTML.
+  #
+  # Prepends line numbers if +add_line_numbers+ is true.
+
+  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
+
+end
+
+class RDoc::ClassModule
+
+  ##
+  # Handy wrapper for marking up this class or module's comment
+
+  def description
+    markup @comment_location
+  end
+
+end
+
+class RDoc::Context::Section
+
+  include RDoc::Generator::Markup
+
+end
+
+class RDoc::TopLevel
+
+  ##
+  # Returns a URL for this source file on some web repository.  Use the -W
+  # command line option to set.
+
+  def cvs_url
+    url = @store.rdoc.options.webcvs
+
+    if /%s/ =~ url then
+      url % @relative_name
+    else
+      url + @relative_name
+    end
+  end
+
+end
+