mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
1c279a7d27
* bin/rdoc: ditto * test/rdoc: ditto * NEWS: Updated with RDoc 4.0 information git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
74 lines
1.8 KiB
Ruby
74 lines
1.8 KiB
Ruby
require 'cgi'
|
|
|
|
##
|
|
# Creates HTML-safe labels suitable for use in id attributes. Tidylinks are
|
|
# converted to their link part and cross-reference links have the suppression
|
|
# marks removed (\\SomeClass is converted to SomeClass).
|
|
|
|
class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
|
|
|
|
attr_reader :res # :nodoc:
|
|
|
|
##
|
|
# Creates a new formatter that will output HTML-safe labels
|
|
|
|
def initialize markup = nil
|
|
super nil, markup
|
|
|
|
@markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
|
|
@markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
|
|
|
|
add_tag :BOLD, '', ''
|
|
add_tag :TT, '', ''
|
|
add_tag :EM, '', ''
|
|
|
|
@res = []
|
|
end
|
|
|
|
##
|
|
# Converts +text+ to an HTML-safe label
|
|
|
|
def convert text
|
|
label = convert_flow @am.flow text
|
|
|
|
CGI.escape label
|
|
end
|
|
|
|
##
|
|
# Converts the CROSSREF +special+ to plain text, removing the suppression
|
|
# marker, if any
|
|
|
|
def handle_special_CROSSREF special
|
|
text = special.text
|
|
|
|
text.sub(/^\\/, '')
|
|
end
|
|
|
|
##
|
|
# Converts the TIDYLINK +special+ to just the text part
|
|
|
|
def handle_special_TIDYLINK special
|
|
text = special.text
|
|
|
|
return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
|
|
|
|
$1
|
|
end
|
|
|
|
alias accept_blank_line ignore
|
|
alias accept_block_quote ignore
|
|
alias accept_heading ignore
|
|
alias accept_list_end ignore
|
|
alias accept_list_item_end ignore
|
|
alias accept_list_item_start ignore
|
|
alias accept_list_start ignore
|
|
alias accept_paragraph ignore
|
|
alias accept_raw ignore
|
|
alias accept_rule ignore
|
|
alias accept_verbatim ignore
|
|
alias end_accepting ignore
|
|
alias handle_special_HARD_BREAK ignore
|
|
alias start_accepting ignore
|
|
|
|
end
|
|
|