Outputs RDoc markup as RDoc markup! (mostly)
- A
- E
- H
- I
- N
- S
- U
- W
[RW] | indent | Current indent amount for output in characters |
[R] | list_index | Stack of current list indexes for alphabetic and numeric lists |
[R] | list_type | Stack of list types |
[R] | list_width | Stack of list widths for indentation |
[R] | prefix | Prefix for the next list item. See use_prefix |
[R] | res | Output accumulator |
[RW] | width | Output width in characters |
Creates a new formatter that will output (mostly) RDoc markup
# File ../ruby/lib/rdoc/markup/to_rdoc.rb, line 47 def initialize markup = nil super @markup.add_special(/\\S/, :SUPPRESSED_CROSSREF) @width = 78 init_tags @headings = {} @headings.default = [] @headings[1] = ['= ', ''] @headings[2] = ['== ', ''] @headings[3] = ['=== ', ''] @headings[4] = ['==== ', ''] @headings[5] = ['===== ', ''] @headings[6] = ['====== ', ''] end
Adds blank_line
to the output
Adds heading
to the output
Adds paragraph
to the output
Finishes consumption of list
Finishes consumption of list_item
# File ../ruby/lib/rdoc/markup/to_rdoc.rb, line 104 def accept_list_item_end list_item width = case @list_type.last when :BULLET then 2 when :NOTE, :LABEL then @res << "\n" 2 else bullet = @list_index.last.to_s @list_index[-1] = @list_index.last.succ bullet.length + 2 end @indent -= width end
Prepares the visitor for consuming list_item
# File ../ruby/lib/rdoc/markup/to_rdoc.rb, line 123 def accept_list_item_start list_item type = @list_type.last case type when :NOTE, :LABEL then bullet = attributes(list_item.label) + ":\n" @prefix = ' ' * @indent @indent += 2 @prefix << bullet + (' ' * @indent) else bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.' @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1) width = bullet.length + 1 @indent += width end end
Prepares the visitor for consuming list
# File ../ruby/lib/rdoc/markup/to_rdoc.rb, line 143 def accept_list_start list case list.type when :BULLET then @list_index << nil @list_width << 1 when :LABEL, :NOTE then @list_index << nil @list_width << 2 when :LALPHA then @list_index << 'a' @list_width << list.items.length.to_s.length when :NUMBER then @list_index << 1 @list_width << list.items.length.to_s.length when :UALPHA then @list_index << 'A' @list_width << list.items.length.to_s.length else raise RDoc::Error, "invalid list type #{list.type}" end @list_type << list.type end
Adds paragraph
to the output
Adds raw
to the output
Adds rule
to the output
Outputs verbatim
indented 2 columns
Applies attribute-specific markup to text
using
RDoc::AttributeManager
Returns the generated output
Removes preceding \ from the suppressed crossref special
Prepares the visitor for text generation
Adds the stored prefix to the output and clears it. Lists generate a prefix for later consumption.
Wraps text
to width
# File ../ruby/lib/rdoc/markup/to_rdoc.rb, line 265 def wrap text return unless text && !text.empty? text_len = @width - @indent text_len = 20 if text_len < 20 re = /^(.{0,#{text_len}})[ \n]/ next_prefix = ' ' * @indent prefix = @prefix || next_prefix @prefix = nil @res << prefix while text.length > text_len if text =~ re then @res << $1 text.slice!(0, $&.length) else @res << text.slice!(0, text_len) end @res << "\n" << next_prefix end if text.empty? then @res.pop @res.pop else @res << text @res << "\n" end end