lib/rdoc/markup/to_html_crossref.rb

   1 require 'rdoc/markup/to_html'
   2
   3 ##
   4 # Subclass of the RDoc::Markup::ToHtml class that supports looking up words in
   5 # the AllReferences list. Those that are found (like AllReferences in this
   6 # comment) will be hyperlinked
   7
   8 class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   9
  10   attr_accessor :context
  11
  12   ##
  13   # We need to record the html path of our caller so we can generate
  14   # correct relative paths for any hyperlinks that we find
  15
  16   def initialize(from_path, context, show_hash)
  17     super()
  18
  19     # class names, variable names, or instance variables
  20     @markup.add_special(/(
  21                            # A::B.meth(**) (for operator in Fortran95)
  22                            \w+(::\w+)*[.\#]\w+(\([\.\w+\*\/\+\-\=\<\>]+\))?
  23                            # meth(**) (for operator in Fortran95)
  24                          | \#\w+(\([.\w\*\/\+\-\=\<\>]+\))?
  25                          | \b([A-Z]\w*(::\w+)*[.\#]\w+)  #    A::B.meth
  26                          | \b([A-Z]\w+(::\w+)*)          #    A::B
  27                          | \#\w+[!?=]?                   #    #meth_name
  28                          | \\?\b\w+([_\/\.]+\w+)*[!?=]?  #    meth_name
  29                          )/x,
  30                         :CROSSREF)
  31
  32     @from_path = from_path
  33     @context = context
  34     @show_hash = show_hash
  35
  36     @seen = {}
  37   end
  38
  39   ##
  40   # We're invoked when any text matches the CROSSREF pattern
  41   # (defined in MarkUp). If we fine the corresponding reference,
  42   # generate a hyperlink. If the name we're looking for contains
  43   # no punctuation, we look for it up the module/class chain. For
  44   # example, HyperlinkHtml is found, even without the Generator::
  45   # prefix, because we look for it in module Generator first.
  46
  47   def handle_special_CROSSREF(special)
  48     name = special.text
  49
  50     return @seen[name] if @seen.include? name
  51
  52     if name[0,1] == '#' then
  53       lookup = name[1..-1]
  54       name = lookup unless @show_hash
  55     else
  56       lookup = name
  57     end
  58
  59     # Find class, module, or method in class or module.
  60     if /([A-Z]\w*)[.\#](\w+[!?=]?)/ =~ lookup then
  61       container = $1
  62       method = $2
  63       ref = @context.find_symbol container, method
  64     elsif /([A-Za-z]\w*)[.\#](\w+(\([\.\w+\*\/\+\-\=\<\>]+\))?)/ =~ lookup then
  65       container = $1
  66       method = $2
  67       ref = @context.find_symbol container, method
  68     else
  69       ref = @context.find_symbol lookup
  70     end
  71
  72     out = if lookup =~ /^\\/ then
  73             $'
  74           elsif ref and ref.document_self then
  75             "<a href=\"#{ref.as_href(@from_path)}\">#{name}</a>"
  76           else
  77             name
  78           end
  79
  80     @seen[name] = out
  81
  82     out
  83   end
  84
  85 end
  86