rdoc 7.2.0 → 8.1.0

data/lib/rdoc/markup/to_html_crossref.rb

@@ -1,235 +1,265 @@
 # frozen_string_literal: true
-##
-# Subclass of the RDoc::Markup::ToHtml class that supports looking up method
-# names, classes, etc to create links.  RDoc::CrossReference is used to
-# generate those links based on the current context.
+module RDoc
+  class Markup
+    ##
+    # Subclass of the RDoc::Markup::ToHtml class that supports looking up method
+    # names, classes, etc to create links.  RDoc::CrossReference is used to
+    # generate those links based on the current context.
 
-class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
+    class ToHtmlCrossref < Markup::ToHtml
 
-  # :stopdoc:
-  ALL_CROSSREF_REGEXP = RDoc::CrossReference::ALL_CROSSREF_REGEXP
-  CLASS_REGEXP_STR    = RDoc::CrossReference::CLASS_REGEXP_STR
-  CROSSREF_REGEXP     = RDoc::CrossReference::CROSSREF_REGEXP
-  METHOD_REGEXP_STR   = RDoc::CrossReference::METHOD_REGEXP_STR
-  # :startdoc:
+      # :stopdoc:
+      ALL_CROSSREF_REGEXP = CrossReference::ALL_CROSSREF_REGEXP
+      CROSSREF_REGEXP     = CrossReference::CROSSREF_REGEXP
+      # :startdoc:
 
-  ##
-  # RDoc::CodeObject for generating references
+      ##
+      # RDoc::CodeObject for generating references
 
-  attr_accessor :context
+      attr_accessor :context
 
-  ##
-  # Should we show '#' characters on method references?
+      ##
+      # Should we show '#' characters on method references?
 
-  attr_accessor :show_hash
+      attr_accessor :show_hash
 
-  ##
-  # Creates a new crossref resolver that generates links relative to +context+
-  # which lives at +from_path+ in the generated files.  '#' characters on
-  # references are removed unless +show_hash+ is true.  Only method names
-  # preceded by '#' or '::' are linked, unless +hyperlink_all+ is true.
+      ##
+      # Creates a new crossref resolver that generates links relative to +context+
+      # which lives at +from_path+ in the generated files.  '#' characters on
+      # references are removed unless +show_hash+ is true.  Only method names
+      # preceded by '#' or '::' are linked, unless +hyperlink_all+ is true.
 
-  def initialize(options, from_path, context, markup = nil)
-    raise ArgumentError, 'from_path cannot be nil' if from_path.nil?
+      def initialize(from_path, context, pipe: false, output_decoration: true,
+                     hyperlink_all: false, show_hash: false,
+                     autolink_excluded_words: [], warn_missing_rdoc_ref: true)
+        raise ArgumentError, 'from_path cannot be nil' if from_path.nil?
 
-    super options, markup
+        super(pipe: pipe, output_decoration: output_decoration)
 
-    @context       = context
-    @from_path     = from_path
-    @hyperlink_all = @options.hyperlink_all
-    @show_hash     = @options.show_hash
+        @context       = context
+        @from_path     = from_path
+        @hyperlink_all = hyperlink_all
+        @show_hash     = show_hash
+        @autolink_excluded_words = autolink_excluded_words
+        @warn_missing_rdoc_ref = warn_missing_rdoc_ref
 
-    @cross_reference = RDoc::CrossReference.new @context
-  end
-
-  # :nodoc:
-  def init_link_notation_regexp_handlings
-    add_regexp_handling_RDOCLINK
-
-    # The crossref must be linked before tidylink because Klass.method[:sym]
-    # will be processed as a tidylink first and will be broken.
-    crossref_re = @options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
-    @markup.add_regexp_handling crossref_re, :CROSSREF
-  end
+        @cross_reference = CrossReference.new @context
+      end
 
-  ##
-  # Creates a link to the reference +name+ if the name exists.  If +text+ is
-  # given it is used as the link text, otherwise +name+ is used.
+      # :nodoc:
+      def init_link_notation_regexp_handlings
+        add_regexp_handling_RDOCLINK
 
-  def cross_reference(name, text = nil, code = true, rdoc_ref: false)
-    lookup = name
+        # The crossref must be linked before tidylink because Klass.method[:sym]
+        # will be processed as a tidylink first and will be broken.
+        crossref_re = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
+        @markup.add_regexp_handling crossref_re, :CROSSREF
+      end
 
-    name = name[1..-1] unless @show_hash if name[0, 1] == '#'
+      ##
+      # Creates a link to the reference +name+ if the name exists.  If +text+ is
+      # given it is used as the link text, otherwise +name+ is used.
+      # Returns +nil+ if the link target could not be resolved.
+
+      def cross_reference(name, text = nil, code = true, rdoc_ref: false)
+        # Strip '#' for link display text (e.g. #method shows as "method" in links)
+        display = !@show_hash && name.start_with?('#') ? name[1..] : name
+
+        if !display.end_with?('+@', '-@') && match = display.match(/(.*[^#:])?@(.*)/)
+          context_name = match[1]
+          label = convert_string(Text.decode_legacy_label(match[2]))
+          text ||= "#{label} at <code>#{convert_string(context_name)}</code>" if context_name
+          text ||= label
+          code = false
+        else
+          text ||= convert_string(display)
+        end
 
-    if !name.end_with?('+@', '-@') && match = name.match(/(.*[^#:])?@(.*)/)
-      context_name = match[1]
-      label = RDoc::Text.decode_legacy_label(match[2])
-      text ||= "#{label} at <code>#{context_name}</code>" if context_name
-      text ||= label
-      code = false
-    else
-      text ||= name
-    end
+        link(name, text, code, rdoc_ref: rdoc_ref)
+      end
 
-    link lookup, text, code, rdoc_ref: rdoc_ref
-  end
+      ##
+      # We're invoked when any text matches the CROSSREF pattern.  If we find the
+      # corresponding reference, generate a link.  If the name we're looking for
+      # contains no punctuation, we look for it up the module/class chain.  For
+      # example, ToHtml is found, even without the <tt>RDoc::Markup::</tt> prefix,
+      # because we look for it in module Markup first.
 
-  ##
-  # We're invoked when any text matches the CROSSREF pattern.  If we find the
-  # corresponding reference, generate a link.  If the name we're looking for
-  # contains no punctuation, we look for it up the module/class chain.  For
-  # example, ToHtml is found, even without the <tt>RDoc::Markup::</tt> prefix,
-  # because we look for it in module Markup first.
+      def handle_regexp_CROSSREF(name)
+        return convert_string(name) if in_tidylink_label?
+        return convert_string(name) if @autolink_excluded_words&.include?(name)
 
-  def handle_regexp_CROSSREF(name)
-    return convert_string(name) if in_tidylink_label?
-    return name if @options.autolink_excluded_words&.include?(name)
+        return convert_string(name) if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
 
-    return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
+        unless @hyperlink_all
+          # This ensures that words entirely consisting of lowercase letters will
+          # not have cross-references generated (to suppress lots of erroneous
+          # cross-references to "new" in text, for instance)
+          return name if name =~ /\A[a-z]*\z/
+        end
+        cross_reference(name, rdoc_ref: false) || convert_string(name)
+      end
 
-    unless @hyperlink_all then
-      # This ensures that words entirely consisting of lowercase letters will
-      # not have cross-references generated (to suppress lots of erroneous
-      # cross-references to "new" in text, for instance)
-      return name if name =~ /\A[a-z]*\z/
-    end
+      ##
+      # Handles <tt>rdoc-ref:</tt> scheme links and allows RDoc::Markup::ToHtml to
+      # handle other schemes.
 
-    cross_reference name, rdoc_ref: false
-  end
+      def handle_regexp_HYPERLINK(url)
+        return convert_string(url) if in_tidylink_label?
 
-  ##
-  # Handles <tt>rdoc-ref:</tt> scheme links and allows RDoc::Markup::ToHtml to
-  # handle other schemes.
+        case url
+        when /\Ardoc-ref:/
+          ref = $'
+          cross_reference(ref, rdoc_ref: true) || convert_string(ref)
+        else
+          super
+        end
+      end
 
-  def handle_regexp_HYPERLINK(url)
-    return convert_string(url) if in_tidylink_label?
+      ##
+      # +target+ is an rdoc-schemed link that will be converted into a hyperlink.
+      # For the rdoc-ref scheme the cross-reference will be looked up and the
+      # given name will be used.
+      #
+      # All other contents are handled by
+      # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]
+
+      def handle_regexp_RDOCLINK(url)
+        case url
+        when /\Ardoc-ref:/
+          if in_tidylink_label?
+            convert_string(url)
+          else
+            ref = $'
+            cross_reference(ref, rdoc_ref: true) || convert_string(ref)
+          end
+        else
+          super
+        end
+      end
 
-    case url
-    when /\Ardoc-ref:/
-      cross_reference $', rdoc_ref: true
-    else
-      super
-    end
-  end
+      ##
+      # Generates links for <tt>rdoc-ref:</tt> scheme URLs and allows
+      # RDoc::Markup::ToHtml to handle other schemes.
 
-  ##
-  # +target+ is an rdoc-schemed link that will be converted into a hyperlink.
-  # For the rdoc-ref scheme the cross-reference will be looked up and the
-  # given name will be used.
-  #
-  # All other contents are handled by
-  # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]
-
-  def handle_regexp_RDOCLINK(url)
-    case url
-    when /\Ardoc-ref:/
-      if in_tidylink_label?
-        convert_string(url)
-      else
-        cross_reference $', rdoc_ref: true
+      def gen_url(url, text)
+        if url =~ /\Ardoc-ref:/
+          name = $'
+          cross_reference(name, text, name == text, rdoc_ref: true) || text
+        else
+          super
+        end
       end
-    else
-      super
-    end
-  end
 
-  ##
-  # Generates links for <tt>rdoc-ref:</tt> scheme URLs and allows
-  # RDoc::Markup::ToHtml to handle other schemes.
+      ##
+      # Creates an HTML link to +name+ with the given +html_string+.
+      # +html_string+ should be already escaped and may contain HTML tags.
+      # Returns the link HTML string, or +nil+ if the reference could not be resolved.
 
-  def gen_url(url, text)
-    if url =~ /\Ardoc-ref:/
-      name = $'
-      cross_reference name, text, name == text, rdoc_ref: true
-    else
-      super
-    end
-  end
+      def link(name, html_string, code = true, rdoc_ref: false)
+        if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
+          name = $1
+          label = $'
+        end
 
-  ##
-  # Creates an HTML link to +name+ with the given +text+.
+        ref = @cross_reference.resolve name if name
 
-  def link(name, text, code = true, rdoc_ref: false)
-    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
-      name = $1
-      label = $'
-    end
+        # Non-text source files (C, Ruby, etc.) don't get HTML pages generated,
+        # so don't auto-link to them. Explicit rdoc-ref: links are still allowed.
+        if !rdoc_ref && TopLevel === ref && !ref.text?
+          return
+        end
+
+        if ref
+          path = ref.as_href(@from_path)
+
+          if code and CodeObject === ref and !(TopLevel === ref)
+            html_string = "<code>#{html_string}</code>"
+          end
+        elsif name
+          if rdoc_ref && @warn_missing_rdoc_ref
+            puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{html_string}`"
+          end
+          return
+        else
+          # A bare label reference like @foo still produces a valid anchor link
+          return unless label
+          path = +""
+        end
 
-    ref = @cross_reference.resolve name, text if name
+        if label
+          # Decode legacy labels (e.g., "What-27s+Here" -> "What's Here")
+          # then convert to GitHub-style anchor format
+          decoded_label = Text.decode_legacy_label(label)
+          formatted_label = Text.to_anchor(decoded_label)
+
+          # Case 1: Path already has an anchor (e.g., method link)
+          #   Input:  C1#method@label -> path="C1.html#method-i-m"
+          #   Output: C1.html#method-i-m-label
+          if path =~ /#/
+            path << "-#{formatted_label}"
+
+          # Case 2: Label matches a section title
+          #   Input:  C1@Section -> path="C1.html", section "Section" exists
+          #   Output: C1.html#section (uses section.aref for GitHub-style)
+          elsif (section = ref&.sections&.find { |s| decoded_label == s.title })
+            path << "##{section.aref}"
+
+          # Case 3: Ref has an aref (class/module context)
+          #   Input:  C1@heading -> path="C1.html", ref=C1 class
+          #   Output: C1.html#class-c1-heading
+          elsif ref.respond_to?(:aref)
+            path << "##{ref.aref}-#{formatted_label}"
+
+          # Case 4: No context, just the label (e.g., TopLevel/file)
+          #   Input:  README@section -> path="README_md.html"
+          #   Output: README_md.html#section
+          else
+            path << "##{formatted_label}"
+          end
+        end
 
-    case ref
-    when String then
-      if rdoc_ref && @options.warn_missing_rdoc_ref
-        puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{text}`"
+        "<a href=\"#{path}\">#{html_string}</a>"
       end
-      ref
-    else
-      path = ref ? ref.as_href(@from_path) : +""
 
-      if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
-        text = "<code>#{CGI.escapeHTML text}</code>"
+      def handle_TT(code)
+        emit_inline(tt_cross_reference(code) || "<code>#{convert_string(code)}</code>")
       end
 
-      if label
-        # Decode legacy labels (e.g., "What-27s+Here" -> "What's Here")
-        # then convert to GitHub-style anchor format
-        decoded_label = RDoc::Text.decode_legacy_label(label)
-        formatted_label = RDoc::Text.to_anchor(decoded_label)
-
-        # Case 1: Path already has an anchor (e.g., method link)
-        #   Input:  C1#method@label -> path="C1.html#method-i-m"
-        #   Output: C1.html#method-i-m-label
-        if path =~ /#/
-          path << "-#{formatted_label}"
-
-        # Case 2: Label matches a section title
-        #   Input:  C1@Section -> path="C1.html", section "Section" exists
-        #   Output: C1.html#section (uses section.aref for GitHub-style)
-        elsif (section = ref&.sections&.find { |s| decoded_label == s.title })
-          path << "##{section.aref}"
-
-        # Case 3: Ref has an aref (class/module context)
-        #   Input:  C1@heading -> path="C1.html", ref=C1 class
-        #   Output: C1.html#class-c1-heading
-        elsif ref.respond_to?(:aref)
-          path << "##{ref.aref}-#{formatted_label}"
-
-        # Case 4: No context, just the label (e.g., TopLevel/file)
-        #   Input:  README@section -> path="README_md.html"
-        #   Output: README_md.html#section
+      # Applies additional special handling on top of the one defined in ToHtml.
+      # When a tidy link is <tt>{Foo}[rdoc-ref:Foo]</tt>, the label part is surrounded by <tt><code></code></tt>.
+      # TODO: reconsider this workaround.
+      def apply_tidylink_label_special_handling(label, url)
+        if url == "rdoc-ref:#{label}" && cross_reference(label)&.include?('<code>')
+          "<code>#{convert_string(label)}</code>"
         else
-          path << "##{formatted_label}"
+          super
         end
       end
 
-      "<a href=\"#{path}\">#{text}</a>"
-    end
-  end
-
-  def handle_TT(code)
-    emit_inline(tt_cross_reference(code) || "<code>#{CGI.escapeHTML code}</code>")
-  end
-
-  # Applies additional special handling on top of the one defined in ToHtml.
-  # When a tidy link is <tt>{Foo}[rdoc-ref:Foo]</tt>, the label part is surrounded by <tt><code></code></tt>.
-  # TODO: reconsider this workaround.
-  def apply_tidylink_label_special_handling(label, url)
-    if url == "rdoc-ref:#{label}" && cross_reference(label).include?('<code>')
-      "<code>#{convert_string(label)}</code>"
-    else
-      super
+      # Handles cross-reference and suppressed-crossref inside tt tag.
+      # Returns nil if code is not an existing cross-reference nor a suppressed-crossref.
+      def tt_cross_reference(code)
+        return if in_tidylink_label?
+
+        crossref_regexp = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
+        # REGEXP sometimes matches a string that starts with a backslash but is not a
+        # suppressed cross-reference (for example, `\+`), so the backslash-removed
+        # part needs to be checked against crossref_regexp.
+        match = crossref_regexp.match(code.delete_prefix('\\'))
+        return unless match && match.begin(1).zero?
+        return unless match.post_match.match?(/\A[[:punct:]\s]*\z/)
+
+        # cross_reference(file_page) may return a link without code tag.
+        # We need to check it because this method shouldn't return an html text without code tag.
+        if code.start_with?('\\')
+          # Remove leading backslash if crossref exists
+          "<code>#{convert_string(code[1..])}</code>" if cross_reference(code[1..])&.include?('<code>')
+        else
+          html = cross_reference(code)
+          html if html&.include?('<code>')
+        end
+      end
     end
   end
-
-  def tt_cross_reference(code)
-    return if in_tidylink_label?
-
-    crossref_regexp = @options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
-    match = crossref_regexp.match(code)
-    return unless match && match.begin(1).zero?
-    return unless match.post_match.match?(/\A[[:punct:]\s]*\z/)
-
-    ref = cross_reference(code)
-    ref if ref != code
-  end
 end