Class: RDoc::Markup::ToHtmlCrossref (Ruby 2.2.3)
Description: Class : RDoc::Markup::ToHtmlCrossref - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rdoc/markup/to_html_crossref.rb

### Parent

RDoc::Markup::ToHtml

### Methods

- ::new
- #cross_reference
- #gen_url
- #handle_special_CROSSREF
- #handle_special_HYPERLINK
- #handle_special_RDOCLINK
- #link

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::POT::MessageExtractor
- RDoc::Generator::POT::PO
- RDoc::Generator::POT::POEntry
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::I18n
- RDoc::I18n::Locale
- RDoc::I18n::Text
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::RI::Task
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::TestCase
- RDoc::Text
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- RDocTask
- Test

No matching classes.

# RDoc::Markup::ToHtmlCrossref

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.

### Attributes

context[RW]

RDoc::CodeObject for generating references

show_hash[RW]

Should we show '#' characters on method references?

### Public Class Methods

new(options, from_path, context, markup = nil) click to toggle source

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.

                   # File rdoc/markup/to_html_crossref.rb, line 31
    def initialize(options, from_path, context, markup = nil)
      raise ArgumentError, 'from_path cannot be nil' if from_path.nil?

      super options, markup

      @context       = context
      @from_path     = from_path
      @hyperlink_all = @options.hyperlink_all
      @show_hash     = @options.show_hash

      crossref_re = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
      @markup.add_special crossref_re, :CROSSREF

      @cross_reference = RDoc::CrossReference.new @context
    end

### Public Instance Methods

cross_reference(name, text = nil) click to toggle source

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.

                   # File rdoc/markup/to_html_crossref.rb, line 51
    def cross_reference name, text = nil
      lookup = name

      name = name[1..-1] unless @show_hash if name[0, 1] == '#'

      name = "#{CGI.unescape $'} at #{$1}" if name =~ /(.*[^#:])@/

      text = name unless text

      link lookup, text
    end

gen_url(url, text) click to toggle source

Generates links for `rdoc-ref:` scheme URLs and allows RDoc::Markup::ToHtml to handle other schemes.

                   # File rdoc/markup/to_html_crossref.rb, line 118
    def gen_url url, text
      return super unless url =~ /\Ardoc-ref:/

      cross_reference $', text
    end

handle_special_CROSSREF(special) click to toggle source

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 `RDoc::Markup::` prefix, because we look for it in module Markup first.

                   # File rdoc/markup/to_html_crossref.rb, line 70
    def handle_special_CROSSREF(special)
      name = special.text

      return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails

      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

      cross_reference name
    end

handle_special_HYPERLINK(special) click to toggle source

Handles `rdoc-ref:` scheme links and allows RDoc::Markup::ToHtml to handle other schemes.

                   # File rdoc/markup/to_html_crossref.rb, line 89
    def handle_special_HYPERLINK special
      return cross_reference $' if special.text =~ /\Ardoc-ref:/

      super
    end

handle_special_RDOCLINK(special) click to toggle source

`special` 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

                   # File rdoc/markup/to_html_crossref.rb, line 103
    def handle_special_RDOCLINK special
      url = special.text

      case url
      when /\Ardoc-ref:/ then
        cross_reference $'
      else
        super
      end
    end

link(name, text) click to toggle source

Creates an HTML link to `name` with the given `text`.

                   # File rdoc/markup/to_html_crossref.rb, line 127
    def link name, text
      original_name = name

      if name =~ /(.*[^#:])@/ then
        name = $1
        label = $'
      end

      ref = @cross_reference.resolve name, text

      text = ref.output_name @context if
        RDoc::MethodAttr === ref and text == original_name

      case ref
      when String then
        ref
      else
        path = ref.as_href @from_path

        if path =~ /#/ then
          path << "-label-#{label}"
        elsif ref.sections and
              ref.sections.any? { |section| label == section.title } then
          path << "##{label}"
        else
          path << "#label-#{label}"
        end if label

        "<a href=\"#{path}\">#{text}</a>"
      end
    end