Class: RDoc::Markup::ToHtmlCrossref

Inherits:
ToHtml show all
Defined in:
lib/rdoc/markup/to_html_crossref.rb

Overview

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.

Constant Summary collapse

ALL_CROSSREF_REGEXP =

:stopdoc:

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

Constants inherited from ToHtml

RDoc::Markup::ToHtml::LIST_TYPE_TO_HTML, RDoc::Markup::ToHtml::URL_CHARACTERS_REGEXP_STR

Constants included from Text

Text::MARKUP_FORMAT, Text::SPACE_SEPARATED_LETTER_CLASS, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Attributes inherited from ToHtml

#code_object, #from_path, #in_list_entry, #list, #res

Attributes included from Text

#language

Instance Method Summary collapse

Methods inherited from ToHtml

#accept_blank_line, #accept_block_quote, #accept_heading, #accept_list_end, #accept_list_item_end, #accept_list_item_start, #accept_list_start, #accept_paragraph, #accept_raw, #accept_rule, #accept_table, #accept_verbatim, #convert_string, #deduplicate_heading_id, #emit_inline, #end_accepting, #handle_BOLD, #handle_BOLD_WORD, #handle_EM, #handle_EM_WORD, #handle_HARD_BREAK, #handle_PLAIN_TEXT, #handle_RDOCLINK, #handle_REGEXP_HANDLING_TEXT, #handle_STRIKE, #handle_TIDYLINK, #handle_inline, #handle_regexp_SUPPRESSED_CROSSREF, #html_list_name, #in_tidylink_label?, #init_regexp_handlings, #list_end_for, #list_item_start, #parseable?, #start_accepting, #to_html

Methods included from Text

decode_legacy_label, encode_fallback, expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #snippet, #strip_hashes, #strip_newlines, #strip_stars, to_anchor, #to_html, #to_html_characters, #wrap

Methods inherited from Formatter

#accept_document, #add_regexp_handling_RDOCLINK, #annotate, #apply_regexp_handling, #convert, #convert_string, gen_relative_url, #handle_BOLD, #handle_BOLD_WORD, #handle_EM, #handle_EM_WORD, #handle_HARD_BREAK, #handle_PLAIN_TEXT, #handle_REGEXP_HANDLING_TEXT, #handle_STRIKE, #handle_TEXT, #handle_TIDYLINK, #handle_inline, #ignore, #parse_url, #traverse_inline_nodes, #tt?

Constructor Details

#initialize(options, from_path, context, markup = nil) ⇒ ToHtmlCrossref

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.

Raises:

  • (ArgumentError) 


32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 32

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

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

Instance Attribute Details

#context ⇒ Object

RDoc::CodeObject for generating references



19
20
21
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 19

def context
  @context
end

#show_hash ⇒ Object

Should we show ‘#’ characters on method references?



24
25
26
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 24

def show_hash
  @show_hash
end

Instance Method Details

Applies additional special handling on top of the one defined in ToHtml. When a tidy link is {Foo}[rdoc-ref:Foo], the label part is surrounded by <code></code>. TODO: reconsider this workaround.



216
217
218
219
220
221
222
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 216

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
  end
end

#cross_reference(name, text = nil, code = true, rdoc_ref: false) ⇒ Object

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.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 59

def cross_reference(name, text = nil, code = true, rdoc_ref: false)
  lookup = name

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

  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 lookup, text, code, rdoc_ref: rdoc_ref
end

#gen_url(url, text) ⇒ Object

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



140
141
142
143
144
145
146
147
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 140

def gen_url(url, text)
  if url =~ /\Ardoc-ref:/
    name = $'
    cross_reference name, text, name == text, rdoc_ref: true
  else
    super
  end
end

#handle_regexp_CROSSREF(name) ⇒ Object

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.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 84

def handle_regexp_CROSSREF(name)
  return convert_string(name) if in_tidylink_label?
  return name if @options.autolink_excluded_words&.include?(name)

  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, rdoc_ref: false
end

#handle_regexp_HYPERLINK(url) ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 104

def handle_regexp_HYPERLINK(url)
  return convert_string(url) if in_tidylink_label?

  case url
  when /\Ardoc-ref:/
    cross_reference $', rdoc_ref: true
  else
    super
  end
end

#handle_regexp_RDOCLINK(url) ⇒ Object

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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 123

def handle_regexp_RDOCLINK(url)
  case url
  when /\Ardoc-ref:/
    if in_tidylink_label?
      convert_string(url)
    else
      cross_reference $', rdoc_ref: true
    end
  else
    super
  end
end

#handle_TT(code) ⇒ Object 



209
210
211
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 209

def handle_TT(code)
  emit_inline(tt_cross_reference(code) || "<code>#{CGI.escapeHTML code}</code>")
end

#init_link_notation_regexp_handlings ⇒ Object

:nodoc:



46
47
48
49
50
51
52
53
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 46

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

#link(name, text, code = true, rdoc_ref: false) ⇒ Object

Creates an HTML link to name with the given text.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 152

def link(name, text, code = true, rdoc_ref: false)
  if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
    name = $1
    label = $'
  end

  ref = @cross_reference.resolve name, text if name

  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}`"
    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>"
    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
      else
        path << "##{formatted_label}"
      end
    end

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

#tt_cross_reference(code) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/rdoc/markup/to_html_crossref.rb', line 224

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