Gecko [ beacons-mine.com ]

Name	Size	Permission	Date
attribute_manager.rb	7.8 KB	-rw-r--r--	2011-02-02 06:02
blank_line.rb	361 B	-rw-r--r--	2010-12-20 08:52
document.rb	2.42 KB	-rw-r--r--	2011-08-06 02:51
formatter.rb	3.3 KB	-rw-r--r--	2011-08-24 05:32
formatter_test_case.rb	15.71 KB	-rw-r--r--	2011-06-16 10:29
heading.rb	314 B	-rw-r--r--	2011-02-02 06:02
indented_paragraph.rb	534 B	-rw-r--r--	2011-06-16 10:29
inline.rb	2.76 KB	-rw-r--r--	2011-06-28 07:58
list.rb	1.08 KB	-rw-r--r--	2010-12-20 08:52
list_item.rb	1.26 KB	-rw-r--r--	2010-12-20 08:52
paragraph.rb	191 B	-rw-r--r--	2010-12-20 08:52
parser.rb	12.65 KB	-rw-r--r--	2011-08-06 02:51
pre_process.rb	6.33 KB	-rw-r--r--	2011-08-06 02:51
raw.rb	965 B	-rw-r--r--	2010-12-20 08:52
rule.rb	285 B	-rw-r--r--	2010-12-20 08:52
text_formatter_test_case.rb	2.53 KB	-rw-r--r--	2011-05-15 17:25
to_ansi.rb	1.79 KB	-rw-r--r--	2011-06-28 07:58
to_bs.rb	1.7 KB	-rw-r--r--	2011-06-16 10:29
to_html.rb	6.66 KB	-rw-r--r--	2011-08-24 05:32
to_html_crossref.rb	3.34 KB	-rw-r--r--	2011-08-06 02:51
to_rdoc.rb	5.58 KB	-rw-r--r--	2011-06-16 10:29
to_test.rb	1.16 KB	-rw-r--r--	2011-06-16 10:29
to_tt_only.rb	2.11 KB	-rw-r--r--	2011-06-16 10:29
verbatim.rb	634 B	-rw-r--r--	2010-12-20 08:52

Rename

require 'rdoc/markup/formatter'
require 'rdoc/markup/inline'

##
# Extracts sections of text enclosed in plus, tt or code.  Used to discover
# undocumented parameters.

class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter

##
  # Stack of list types

attr_reader :list_type

##
  # Output accumulator

attr_reader :res

##
  # Creates a new tt-only formatter.

def initialize markup = nil
    super

add_tag :TT, nil, nil
  end

##
  # Pops the list type for +list+ from #list_type

def accept_list_end list
    @list_type.pop
  end

##
  # Pushes the list type for +list+ onto #list_type

def accept_list_start list
    @list_type << list.type
  end

##
  # Prepares the visitor for consuming +list_item+

def accept_list_item_start list_item
    case @list_type.last
    when :NOTE, :LABEL then
      tt_sections(list_item.label)
    end
  end

##
  # Adds +paragraph+ to the output

def accept_paragraph paragraph
    tt_sections(paragraph.text)
  end

##
  # Does nothing to +markup_item+ because it doesn't have any user-built
  # content

def do_nothing markup_item
  end

alias accept_blank_line    do_nothing # :nodoc:
  alias accept_heading       do_nothing # :nodoc:
  alias accept_list_item_end do_nothing # :nodoc:
  alias accept_raw           do_nothing # :nodoc:
  alias accept_rule          do_nothing # :nodoc:
  alias accept_verbatim      do_nothing # :nodoc:

##
  # Extracts tt sections from +text+

def tt_sections text
    flow = @am.flow text.dup

flow.each do |item|
      case item
      when String then
        @res << item if in_tt?
      when RDoc::Markup::AttrChanger then
        off_tags res, item
        on_tags res, item
      when RDoc::Markup::Special then
        @res << convert_special(item) if in_tt? # TODO can this happen?
      else
        raise "Unknown flow element: #{item.inspect}"
      end
    end

res
  end

##
  # Returns an Array of items that were wrapped in plus, tt or code.

def end_accepting
    @res.compact
  end

##
  # Prepares the visitor for gathering tt sections

def start_accepting
    @res = []

@list_type = []
  end

end