Subclass of the RDoc::Markup::ToHtml class that supports looking up words from a context. Those that are found will be hyperlinked.
Version of CROSSREF_REGEXP used when --hyperlink-all is specified.
Regular expression to match class references
There can be a ‘\’ in front of text to suppress the cross-reference
There can be a ‘::’ in front of class names to reference from the top-level namespace.
The method can be followed by parenthesis (not recommended)
Regular expressions matching text that should potentially have cross-reference links generated are passed to add_special. Note that these expressions are meant to pick up text for which cross-references have been suppressed, since the suppression characters are removed by the code that is triggered.
Regular expression to match method references.
See CLASS_REGEXP_STR
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 hyperlinked, unless hyperlink_all is true.
# File lib/rdoc/markup/to_html_crossref.rb, line 107 def initialize(from_path, context, show_hash, hyperlink_all = false, markup = nil) raise ArgumentError, 'from_path cannot be nil' if from_path.nil? super markup crossref_re = hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP @markup.add_special crossref_re, :CROSSREF @from_path = from_path @context = context @show_hash = show_hash @hyperlink_all = hyperlink_all @seen = {} end
We’re invoked when any text matches the CROSSREF pattern. If we find the corresponding reference, generate a hyperlink. 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 RDoc::Markup:: prefix, because we look for it in module Markup first.
# File lib/rdoc/markup/to_html_crossref.rb, line 131 def handle_special_CROSSREF(special) name = special.text 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 return @seen[name] if @seen.include? name lookup = name name = name[1..-1] unless @show_hash if name[0, 1] == '#' # Find class, module, or method in class or module. # # Do not, however, use an if/elsif/else chain to do so. Instead, test # each possible pattern until one matches. The reason for this is that a # string like "YAML.txt" could be the txt() class method of class YAML (in # which case it would match the first pattern, which splits the string # into container and method components and looks up both) or a filename # (in which case it would match the last pattern, which just checks # whether the string as a whole is a known symbol). if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/ =~ lookup then type = $2 type = '' if type == '.' # will find either #method or ::method method = "#{type}#{$3}" container = @context.find_symbol_module($1) elsif /^([.#]|::)#{METHOD_REGEXP_STR}/ =~ lookup then type = $1 type = '' if type == '.' method = "#{type}#{$2}" container = @context else container = nil end if container then ref = container.find_local_symbol method unless ref || RDoc::TopLevel === container then ref = container.find_ancestor_local_symbol method end end ref = @context.find_symbol lookup unless ref ref = nil if RDoc::Alias === ref # external alias: can't link to it out = if lookup == '\' then lookup elsif lookup =~ /^\\/ then # we remove the \ only in front of what we know: # other backslashes are treated later, only outside of <tt> ref ? $' : lookup elsif ref then if ref.document_self then "<a href=\"#{ref.as_href @from_path}\">#{name}</a>" else name end else lookup end @seen[lookup] = out out end
Generated with the Darkfish Rdoc Generator 2.