PHP 8.2.31
Preview: to_tt_only.rb Size: 2.24 KB
/proc/thread-self/root/opt/alt/ruby21/lib64/ruby/2.1.0/rdoc/markup/to_tt_only.rb

##
# 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 nil, markup

    add_tag :TT, nil, nil
  end

  ##
  # Adds tts from +block_quote+ to the output

  def accept_block_quote block_quote
    tt_sections block_quote.text
  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
      Array(list_item.label).map do |label|
        tt_sections label
      end.flatten
    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

Directory Contents

Dirs: 0 × Files: 36

Name Size Perms Modified Actions
1.16 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
7.91 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
394 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
470 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
361 B lrw-r--r-- 2010-12-20 03:22:49
Edit Download
222 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
3.12 KB lrw-r--r-- 2012-12-05 22:20:15
Edit Download
5.29 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
16.84 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
416 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.45 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
799 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
876 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
88 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.79 KB lrw-r--r-- 2012-11-29 02:58:31
Edit Download
1.68 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
463 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
14.14 KB lrw-r--r-- 2013-11-19 00:47:33
Edit Download
8.17 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
970 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
285 B lrw-r--r-- 2010-12-20 03:22:49
Edit Download
627 B lrw-r--r-- 2012-11-27 04:28:14
Edit Download
2.49 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
2.02 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.67 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
8.50 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
4.30 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
5.42 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.55 KB lrw-r--r-- 2013-07-19 02:26:08
Edit Download
1.77 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
3.59 KB lrw-r--r-- 2013-09-18 23:33:36
Edit Download
6.12 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.65 KB lrw-r--r-- 2012-12-05 22:20:15
Edit Download
1.11 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
2.24 KB lrw-r--r-- 2012-11-27 04:28:14
Edit Download
1.25 KB lrw-r--r-- 2013-07-19 02:26:08
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).