Class: RDoc::Markup::ToHtml
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Formatter
|
|
Instance Chain:
self,
::RDoc::Text ,
Formatter
|
|
Inherits: |
RDoc::Markup::Formatter
|
Defined in: | lib/rdoc/markup/to_html.rb |
Overview
Outputs RDoc markup as HTML.
Constant Summary
-
LIST_TYPE_TO_HTML =
Maps Parser::LIST_TOKENS types to HTML tags
{ :BULLET => ['<ul>', '</ul>'], :LABEL => ['<dl class="rdoc-list label-list">', '</dl>'], :LALPHA => ['<ol style="list-style-type: lower-alpha">', '</ol>'], :NOTE => ['<dl class="rdoc-list note-list">', '</dl>'], :NUMBER => ['<ol>', '</ol>'], :UALPHA => ['<ol style="list-style-type: upper-alpha">', '</ol>'], }
-
URL_CHARACTERS_REGEXP_STR =
Internal use only
# File 'lib/rdoc/markup/to_html.rb', line 65/[A-Za-z0-9\-._~:\/\?#\[\]@!$&'\(\)*+,;%=]/.source
::RDoc::Text
- Included
MARKUP_FORMAT, SPACE_SEPARATED_LETTER_CLASS, TO_HTML_CHARACTERS
Utilities
-
#code_object
rw
The
::RDoc::CodeObject
HTML is being generated for. -
#convert_string(text)
CGI-escapes
text
-
#from_path
rw
Path to this document for relative links.
-
#gen_url(url, text)
Generate a link to
url
with contenttext
. -
#html_list_name(list_type, open_tag)
Determines the HTML list element for
list_type
andopen_tag
- #in_list_entry readonly Internal use only
-
#init_tags
Maps attributes to HTML tags.
- #list readonly Internal use only
-
#list_end_for(list_type)
Returns the HTML end-tag for
list_type
-
#list_item_start(list_item, list_type)
Returns the HTML tag for
list_type
, possible using a label fromlist_item
-
#parseable?(text) ⇒ Boolean
Returns true if text is valid ruby syntax.
- #res readonly Internal use only
-
#to_html(item)
Converts
item
to HTML using Text#to_html
Regexp Handling
- #handle_RDOCLINK(url) Internal use only
-
#handle_regexp_HARD_BREAK(target)
target
is a<br>
. -
#handle_regexp_HYPERLINK(target)
target
is a potential link. -
#handle_regexp_RDOCLINK(target)
target
is an rdoc-schemed link that will be converted into a hyperlink. -
#handle_regexp_TIDYLINK(target)
This
target
is a link where the label is different from the URLlabel[url]
or{url long label}
. -
#init_link_notation_regexp_handlings
Adds regexp handlings about link notations.
-
#init_regexp_handlings
Adds regexp handlings.
Visitor
-
#accept_blank_line(blank_line)
Adds
blank_line
to the output. -
#accept_block_quote(block_quote)
Adds
block_quote
to the output. -
#accept_heading(heading)
Adds
heading
to the output. -
#accept_list_end(list)
Finishes consumption of #list
-
#accept_list_item_end(list_item)
Finishes consumption of
list_item
-
#accept_list_item_start(list_item)
Prepares the visitor for consuming
list_item
-
#accept_list_start(list)
Prepares the visitor for consuming #list
-
#accept_paragraph(paragraph)
Adds
paragraph
to the output. -
#accept_raw(raw)
Adds
raw
to the output. -
#accept_rule(rule)
Adds
rule
to the output. -
#accept_table(header, body, aligns)
Adds
table
to the output. -
#accept_verbatim(verbatim)
Adds
verbatim
to the output. -
#end_accepting
Returns the generated output.
-
#start_accepting
Prepares the visitor for HTML generation.
Class Method Summary
-
.new(options, markup = nil) ⇒ ToHtml
constructor
Creates a new formatter that will output HTML.
Formatter
- Inherited
.gen_relative_url | Converts a target url to one that is relative to a given path. |
.new | Creates a new |
Instance Attribute Summary
::RDoc::Text
- Included
#language | The language for this text. |
Formatter
- Inherited
#in_tt? | Are we currently inside tt tags? |
Instance Method Summary
::RDoc::Text
- Included
#expand_tabs | Expands tab characters in |
#flush_left | Flush |
#markup | Convert a string in markup format into HTML. |
#normalize_comment | Strips hashes, expands tabs then flushes |
#parse | Normalizes |
#snippet | The first |
#strip_hashes | Strips leading # characters from |
#strip_newlines | Strips leading and trailing n characters from |
#strip_stars | Strips /* */ style comments. |
#to_html | Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in |
#wrap | Wraps |
Formatter
- Inherited
#accept_document | Adds |
#add_regexp_handling_RDOCLINK | Adds a regexp handling for links of the form rdoc-…: |
#add_regexp_handling_TIDYLINK | Adds a regexp handling for links of the form |
#add_tag | Add a new set of tags for an attribute. |
#annotate | Allows |
#convert | Marks up |
#convert_flow | Converts flow items |
#convert_regexp_handling | Converts added regexp handlings. |
#convert_string | Converts a string to be fancier if desired. |
#ignore | Use ignore in your subclass to ignore the content of a node. |
#off_tags | Turns off tags for |
#on_tags | Turns on tags for |
#parse_url | Extracts and a scheme, url and an anchor id from |
#tt? | Is |
Constructor Details
.new(options, markup = nil) ⇒ ToHtml
Creates a new formatter that will output HTML
# File 'lib/rdoc/markup/to_html.rb', line 45
def initialize , markup = nil super @code_object = nil @from_path = '' @in_list_entry = nil @list = nil @th = nil @hard_break = "<br>\n" init_regexp_handlings end
Instance Attribute Details
#code_object (rw)
The ::RDoc::CodeObject
HTML is being generated for. This is used to generate namespaced URI fragments
# File 'lib/rdoc/markup/to_html.rb', line 33
attr_accessor :code_object
#from_path (rw)
Path to this document for relative links
# File 'lib/rdoc/markup/to_html.rb', line 38
attr_accessor :from_path
#in_list_entry (readonly)
# File 'lib/rdoc/markup/to_html.rb', line 26
attr_reader :in_list_entry # :nodoc:
#list (readonly)
# File 'lib/rdoc/markup/to_html.rb', line 27
attr_reader :list # :nodoc:
#res (readonly)
# File 'lib/rdoc/markup/to_html.rb', line 25
attr_reader :res # :nodoc:
Instance Method Details
#accept_blank_line(blank_line)
Adds blank_line
to the output
# File 'lib/rdoc/markup/to_html.rb', line 291
def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end
#accept_block_quote(block_quote)
Adds block_quote
to the output
# File 'lib/rdoc/markup/to_html.rb', line 190
def accept_block_quote block_quote @res << "\n<blockquote>" block_quote.parts.each do |part| part.accept self end @res << "</blockquote>\n" end
#accept_heading(heading)
Adds heading
to the output. The headings greater than 6 are trimmed to level 6.
# File 'lib/rdoc/markup/to_html.rb', line 299
def accept_heading heading level = [6, heading.level].min label = heading.label @code_object @res << if @options.output_decoration "\n<h#{level} id=\"#{label}\">" else "\n<h#{level}>" end @res << to_html(heading.text) unless @options.pipe then @res << "<span><a href=\"##{label}\">¶</a>" @res << " <a href=\"#top\">↑</a></span>" end @res << "</h#{level}>\n" end
#accept_list_end(list)
Finishes consumption of #list
# File 'lib/rdoc/markup/to_html.rb', line 262
def accept_list_end(list) @list.pop if tag = @in_list_entry.pop @res << tag end @res << html_list_name(list.type, false) << "\n" end
#accept_list_item_end(list_item)
Finishes consumption of list_item
# File 'lib/rdoc/markup/to_html.rb', line 284
def accept_list_item_end(list_item) @in_list_entry[-1] = list_end_for(@list.last) end
#accept_list_item_start(list_item)
Prepares the visitor for consuming list_item
# File 'lib/rdoc/markup/to_html.rb', line 273
def accept_list_item_start(list_item) if tag = @in_list_entry.last @res << tag end @res << list_item_start(list_item, @list.last) end
#accept_list_start(list)
Prepares the visitor for consuming #list
# File 'lib/rdoc/markup/to_html.rb', line 253
def accept_list_start(list) @list << list.type @res << html_list_name(list.type, true) @in_list_entry.push false end
#accept_paragraph(paragraph)
Adds paragraph
to the output
# File 'lib/rdoc/markup/to_html.rb', line 203
def accept_paragraph paragraph @res << "\n<p>" text = paragraph.text @hard_break text = text.gsub(/(#{SPACE_SEPARATED_LETTER_CLASS})?\K\r?\n(?=(?(1)(#{SPACE_SEPARATED_LETTER_CLASS})?))/o) { defined?($2) && ' ' } @res << to_html(text) @res << "</p>\n" end
#accept_raw(raw)
Adds raw
to the output
# File 'lib/rdoc/markup/to_html.rb', line 320
def accept_raw raw @res << raw.parts.join("\n") end
#accept_rule(rule)
Adds rule
to the output
# File 'lib/rdoc/markup/to_html.rb', line 246
def accept_rule rule @res << "<hr>\n" end
#accept_table(header, body, aligns)
Adds table
to the output
# File 'lib/rdoc/markup/to_html.rb', line 327
def accept_table header, body, aligns @res << "\n<table role=\"table\">\n<thead>\n<tr>\n" header.zip(aligns) do |text, align| @res << '<th' @res << ' align="' << align << '"' if align @res << '>' << to_html(text) << "</th>\n" end @res << "</tr>\n</thead>\n<tbody>\n" body.each do |row| @res << "<tr>\n" row.zip(aligns) do |text, align| @res << '<td' @res << ' align="' << align << '"' if align @res << '>' << to_html(text) << "</td>\n" end @res << "</tr>\n" end @res << "</tbody>\n</table>\n" end
#accept_verbatim(verbatim)
Adds verbatim
to the output
# File 'lib/rdoc/markup/to_html.rb', line 216
def accept_verbatim verbatim text = verbatim.text.rstrip klass = nil content = if verbatim.ruby? or parseable? text then begin tokens = RDoc::Parser::RipperStateLex.parse text klass = ' class="ruby"' result = RDoc::TokenStream.to_html tokens result = result + "\n" unless "\n" == result[-1] result rescue CGI.escapeHTML text end else CGI.escapeHTML text end if @options.pipe then @res << "\n<pre><code>#{CGI.escapeHTML text}\n</code></pre>\n" else @res << "\n<pre#{klass}>#{content}</pre>\n" end end
#convert_string(text)
CGI-escapes text
# File 'lib/rdoc/markup/to_html.rb', line 352
def convert_string(text) CGI.escapeHTML text end
#end_accepting
Returns the generated output
# File 'lib/rdoc/markup/to_html.rb', line 183
def end_accepting @res.join end
#gen_url(url, text)
Generate a link to url
with content text
. Handles the special cases for img: and link: described under handle_regexp_HYPERLINK
# File 'lib/rdoc/markup/to_html.rb', line 360
def gen_url url, text scheme, url, id = parse_url url if %w[http https link].include?(scheme) and url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then "<img src=\"#{url}\" />" else if scheme != 'link' and %r%\A((?!https?:)(?:[^/#]*/)*)([^/#])\.(rb|rdoc|md)(?=\z|#)%i =~ url url = "#$1#{$2.tr('.', '_')}_#$3.html#$'" end text = text.sub %r%^#{scheme}:/*%i, '' text = text.sub %r%^[*\^](\d+)$%, '\1' link = "<a#{id} href=\"#{url}\">#{text}</a>" link = "<sup>#{link}</sup>" if /"foot/ =~ id link end end
#handle_RDOCLINK(url)
# File 'lib/rdoc/markup/to_html.rb', line 85
def handle_RDOCLINK url # :nodoc: case url when /^rdoc-ref:/ CGI.escapeHTML($') when /^rdoc-label:/ text = $' text = case text when /\Alabel-/ then $' when /\Afootmark-/ then $' when /\Afoottext-/ then $' else text end gen_url CGI.escapeHTML(url), CGI.escapeHTML(text) when /^rdoc-image:/ %[<img src=\"#{CGI.escapeHTML($')}\">] when /\Ardoc-[a-z]+:/ CGI.escapeHTML($') end end
#handle_regexp_HARD_BREAK(target)
target
is a <br>
# File 'lib/rdoc/markup/to_html.rb', line 110
def handle_regexp_HARD_BREAK target '<br>' end
#handle_regexp_HYPERLINK(target)
target
is a potential link. The following schemes are handled:
mailto:
-
Inserted as-is.
http:
-
Links are checked to see if they reference an image. If so, that image gets inserted using an
<img>
tag. Otherwise a conventional<a href>
is used. link:
-
Reference to a local file relative to the output directory.
# File 'lib/rdoc/markup/to_html.rb', line 126
def handle_regexp_HYPERLINK(target) url = CGI.escapeHTML(target.text) gen_url url, url end
#handle_regexp_RDOCLINK(target)
target
is an rdoc-schemed link that will be converted into a hyperlink.
For the rdoc-ref
scheme the named reference will be returned without creating a link.
For the rdoc-label
scheme the footnote and label prefixes are stripped when creating a link. All other contents will be linked verbatim.
# File 'lib/rdoc/markup/to_html.rb', line 141
def handle_regexp_RDOCLINK target handle_RDOCLINK target.text end
#handle_regexp_TIDYLINK(target)
This target
is a link where the label is different from the URL label[url]
or {url long label}
# File 'lib/rdoc/markup/to_html.rb', line 149
def handle_regexp_TIDYLINK(target) text = target.text return text unless text =~ /^\{(.*)\}\[(.*?)\]$/ or text =~ /^(\S+)\[(.*?)\]$/ label = $1 url = CGI.escapeHTML($2) if /^rdoc-image:/ =~ label label = handle_RDOCLINK(label) else label = CGI.escapeHTML(label) end gen_url url, label end
#html_list_name(list_type, open_tag)
Determines the HTML list element for list_type
and open_tag
# File 'lib/rdoc/markup/to_html.rb', line 385
def html_list_name(list_type, open_tag) = LIST_TYPE_TO_HTML[list_type] raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless [open_tag ? 0 : 1] end
#init_link_notation_regexp_handlings
Adds regexp handlings about link notations.
# File 'lib/rdoc/markup/to_html.rb', line 80
def init_link_notation_regexp_handlings add_regexp_handling_RDOCLINK add_regexp_handling_TIDYLINK end
#init_regexp_handlings
Adds regexp handlings.
# File 'lib/rdoc/markup/to_html.rb', line 70
def init_regexp_handlings # external links @markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)#{URL_CHARACTERS_REGEXP_STR}+\w/, :HYPERLINK) init_link_notation_regexp_handlings end
#init_tags
Maps attributes to HTML tags
# File 'lib/rdoc/markup/to_html.rb', line 394
def add_tag :BOLD, "<strong>", "</strong>" add_tag :TT, "<code>", "</code>" add_tag :EM, "<em>", "</em>" end
#list_end_for(list_type)
Returns the HTML end-tag for list_type
#list_item_start(list_item, list_type)
Returns the HTML tag for list_type
, possible using a label from list_item
# File 'lib/rdoc/markup/to_html.rb', line 404
def list_item_start(list_item, list_type) case list_type when :BULLET, :LALPHA, :NUMBER, :UALPHA then "<li>" when :LABEL, :NOTE then Array(list_item.label).map do |label| "<dt>#{to_html label}\n" end.join << "<dd>" else raise RDoc::Error, "Invalid list type: #{list_type.inspect}" end end
#parseable?(text) ⇒ Boolean
Returns true if text is valid ruby syntax
# File 'lib/rdoc/markup/to_html.rb', line 434
def parseable? text verbose, $VERBOSE = $VERBOSE, nil catch(:valid) do eval("BEGIN { throw :valid, true }\n#{text}") end rescue SyntaxError false ensure $VERBOSE = verbose end
#start_accepting
Prepares the visitor for HTML generation
# File 'lib/rdoc/markup/to_html.rb', line 174
def start_accepting @res = [] @in_list_entry = [] @list = [] end
#to_html(item)
Converts item
to HTML using Text#to_html
# File 'lib/rdoc/markup/to_html.rb', line 448
def to_html item super convert_flow @am.flow item end