Class: RDoc::Markup::ToRdoc

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: ToAnsi, ToBs, ToMarkdown
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Formatter
Instance Chain: self, Formatter
Inherits:	RDoc::Markup::Formatter Object RDoc::Markup::Formatter RDoc::Markup::ToRdoc
Defined in:	lib/rdoc/markup/to_rdoc.rb

Overview

Outputs RDoc markup as ::RDoc::RDoc markup! (mostly)

Class Method Summary

.new(markup = nil) ⇒ ToRdoc constructor

Creates a new formatter that will output (mostly) RDoc markup.

Formatter - Inherited

.gen_relative_url	Converts a target url to one that is relative to a given path.
.new	Creates a new Formatter.

Instance Attribute Summary

#indent rw

Current indent amount for output in characters.
#width rw

Output width in characters.
#list_index readonly

Stack of current list indexes for alphabetic and numeric lists.
#list_type readonly

Stack of list types.
#list_width readonly

Stack of list widths for indentation.
#prefix readonly

Prefix for the next list item.
#res readonly

Output accumulator.

Formatter - Inherited

#in_tt?

Are we currently inside tt tags?

Instance Method Summary

#accept_blank_line(blank_line)

Adds blank_line to the output.
#accept_block_quote(block_quote)

Adds paragraph to the output.
#accept_heading(heading)

Adds heading to the output.
#accept_indented_paragraph(paragraph)

Adds paragraph 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_verbatim(verbatim)

Outputs verbatim indented 2 columns.
#attributes(text)

Applies attribute-specific markup to text using RDoc::AttributeManager
#end_accepting

Returns the generated output.
#handle_special_HARD_BREAK(special)

Adds a newline to the output.
#handle_special_SUPPRESSED_CROSSREF(special)

Removes preceding \ from the suppressed crossref special
#init_tags

Maps attributes to HTML sequences.
#start_accepting

Prepares the visitor for text generation.
#use_prefix

Adds the stored #prefix to the output and clears it.
#wrap(text)

Wraps text to #width

Formatter - Inherited

#accept_document	Adds `document` to the output.
#add_special_RDOCLINK	Adds a special for links of the form rdoc-…:
#add_special_TIDYLINK	Adds a special for links of the form `<text>` and <#add_tag	Add a new set of tags for an attribute.
#annotate	Allows `tag` to be decorated with additional information.
#convert	Marks up `content`
#convert_flow	Converts flow items `flow`
#convert_special	Converts added specials.
#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 `item` on #res
#on_tags	Turns on tags for `item` on #res
#parse_url	Extracts and a scheme, url and an anchor id from `url` and returns them.
#tt?	Is `tag` a tt tag?

Constructor Details

.new(markup = nil) ⇒ `ToRdoc`

Creates a new formatter that will output (mostly) RDoc markup

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 45


def initialize markup = nil
  super nil, markup

  @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] = ['====== ', '']

  @hard_break = "\n"
end

Instance Attribute Details

#indent (rw)

Current indent amount for output in characters

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 10


attr_accessor :indent

#list_index (readonly)

Stack of current list indexes for alphabetic and numeric lists

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 20


attr_reader :list_index

#list_type (readonly)

Stack of list types

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 25


attr_reader :list_type

#list_width (readonly)

Stack of list widths for indentation

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 30


attr_reader :list_width

#prefix (readonly)

Prefix for the next list item. See #use_prefix

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 35


attr_reader :prefix

#res (readonly)

Output accumulator

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 40


attr_reader :res

#width (rw)

Output width in characters

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 15


attr_accessor :width

Instance Method Details

#accept_blank_line(blank_line)

Adds blank_line to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 77


def accept_blank_line blank_line
  @res << "\n"
end

#accept_block_quote(block_quote)

Adds paragraph to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 84


def accept_block_quote block_quote
  @indent += 2

  block_quote.parts.each do |part|
    @prefix = '> '

    part.accept self
  end

  @indent -= 2
end

#accept_heading(heading)

Adds heading to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 99


def accept_heading heading
  use_prefix or @res << ' ' * @indent
  @res << @headings[heading.level][0]
  @res << attributes(heading.text)
  @res << @headings[heading.level][1]
  @res << "\n"
end

#accept_indented_paragraph(paragraph)

Adds paragraph to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 203


def accept_indented_paragraph paragraph
  @indent += paragraph.indent
  text = paragraph.text @hard_break
  wrap attributes text
  @indent -= paragraph.indent
end

#accept_list_end(list)

Finishes consumption of list

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 110


def accept_list_end list
  @list_index.pop
  @list_type.pop
  @list_width.pop
end

#accept_list_item_end(list_item)

Finishes consumption of list_item

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 119


def accept_list_item_end list_item
  width = case @list_type.last
          when :BULLET then
            2
          when :NOTE, :LABEL then
            if @prefix then
              @res << @prefix.strip
              @prefix = nil
            end

            @res << "\n"
            2
          else
            bullet = @list_index.last.to_s
            @list_index[-1] = @list_index.last.succ
            bullet.length + 2
          end

  @indent -= width
end

#accept_list_item_start(list_item)

Prepares the visitor for consuming list_item

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 143


def accept_list_item_start list_item
  type = @list_type.last

  case type
  when :NOTE, :LABEL then
    bullets = Array(list_item.label).map do |label|
      attributes(label).strip
    end.join "\n"

    bullets << ":\n" unless bullets.empty?

    @prefix = ' ' * @indent
    @indent += 2
    @prefix << bullets + (' ' * @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

#accept_list_start(list)

Prepares the visitor for consuming list

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 168


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

#accept_paragraph(paragraph)

Adds paragraph to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 195


def accept_paragraph paragraph
  text = paragraph.text @hard_break
  wrap attributes text
end

#accept_raw(raw)

Adds raw to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 213


def accept_raw raw
  @res << raw.parts.join("\n")
end

#accept_rule(rule)

Adds rule to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 220


def accept_rule rule
  use_prefix or @res << ' ' * @indent
  @res << '-' * (@width - @indent)
  @res << "\n"
end

#accept_verbatim(verbatim)

Outputs verbatim indented 2 columns

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 229


def accept_verbatim verbatim
  indent = ' ' * (@indent + 2)

  verbatim.parts.each do |part|
    @res << indent unless part == "\n"
    @res << part
  end

  @res << "\n" unless @res =~ /\n\z/
end

#attributes(text)

Applies attribute-specific markup to text using RDoc::AttributeManager

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 243


def attributes text
  flow = @am.flow text.dup
  convert_flow flow
end

#end_accepting

Returns the generated output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 251


def end_accepting
  @res.join
end

#handle_special_HARD_BREAK(special)

Adds a newline to the output

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 267


def handle_special_HARD_BREAK special
  "\n"
end

#handle_special_SUPPRESSED_CROSSREF(special)

Removes preceding \ from the suppressed crossref special

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 258


def handle_special_SUPPRESSED_CROSSREF special
  text = special.text
  text = text.sub('\\', '') unless in_tt?
  text
end

#init_tags

Maps attributes to HTML sequences

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 68


def init_tags
  add_tag :BOLD, "<b>", "</b>"
  add_tag :TT,   "<tt>", "</tt>"
  add_tag :EM,   "<em>", "</em>"
end

#start_accepting

Prepares the visitor for text generation

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 274


def start_accepting
  @res = [""]
  @indent = 0
  @prefix = nil

  @list_index = []
  @list_type  = []
  @list_width = []
end

#use_prefix

Adds the stored #prefix to the output and clears it. Lists generate a prefix for later consumption.

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 288


def use_prefix
  prefix, @prefix = @prefix, nil
  @res << prefix if prefix

  prefix
end

#wrap(text)

Wraps text to #width

[ GitHub ]

# File 'lib/rdoc/markup/to_rdoc.rb', line 298


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

Class: RDoc::Markup::ToRdoc

Overview

Class Method Summary

Formatter - Inherited

Instance Attribute Summary

Formatter - Inherited

Instance Method Summary

Formatter - Inherited

Constructor Details

.new(markup = nil) ⇒ ToRdoc

Instance Attribute Details

#indent (rw)

#list_index (readonly)

#list_type (readonly)

#list_width (readonly)

#prefix (readonly)

#res (readonly)

#width (rw)

Instance Method Details

#accept_blank_line(blank_line)

#accept_block_quote(block_quote)

#accept_heading(heading)

#accept_indented_paragraph(paragraph)

#accept_list_end(list)

#accept_list_item_end(list_item)

#accept_list_item_start(list_item)

#accept_list_start(list)

#accept_paragraph(paragraph)

#accept_raw(raw)

#accept_rule(rule)

#accept_verbatim(verbatim)

#attributes(text)

#end_accepting

#handle_special_HARD_BREAK(special)

#handle_special_SUPPRESSED_CROSSREF(special)

#init_tags

#start_accepting

#use_prefix

#wrap(text)

.new(markup = nil) ⇒ `ToRdoc`