404 Not Found

PATH: opt / alt / ruby24 / lib64 / ruby / 2.4.0 / rdoc / markup

# frozen_string_literal: false
##
# A List is a homogeneous set of ListItems.
#
# The supported list types include:
#
# :BULLET::
#   An unordered list
# :LABEL::
#   An unordered definition list, but using an alternate RDoc::Markup syntax
# :LALPHA::
#   An ordered list using increasing lowercase English letters
# :NOTE::
#   An unordered definition list
# :NUMBER::
#   An ordered list using increasing Arabic numerals
# :UALPHA::
#   An ordered list using increasing uppercase English letters
#
# Definition lists behave like HTML definition lists.  Each list item can
# describe multiple terms.  See RDoc::Markup::ListItem for how labels and
# definition are stored as list items.

class RDoc::Markup::List

##
  # The list's type

attr_accessor :type

##
  # Items in the list

attr_reader :items

##
  # Creates a new list of +type+ with +items+.  Valid list types are:
  # +:BULLET+, +:LABEL+, +:LALPHA+, +:NOTE+, +:NUMBER+, +:UALPHA+

def initialize type = nil, *items
    @type = type
    @items = []
    @items.concat items
  end

##
  # Appends +item+ to the list

def << item
    @items << item
  end

def == other # :nodoc:
    self.class == other.class and
      @type == other.type and
      @items == other.items
  end

##
  # Runs this list and all its #items through +visitor+

def accept visitor
    visitor.accept_list_start self

@items.each do |item|
      item.accept visitor
    end

visitor.accept_list_end self
  end

##
  # Is the list empty?

def empty?
    @items.empty?
  end

##
  # Returns the last item in the list

def last
    @items.last
  end

def pretty_print q # :nodoc:
    q.group 2, "[list: #{@type} ", ']' do
      q.seplist @items do |item|
        q.pp item
      end
    end
  end

##
  # Appends +items+ to the list

def push *items
    @items.concat items
  end

end

[-] list.rb [edit]
[-] parser.rb [edit]
[-] text_formatter_test_case.rb [edit]
[-] list_item.rb [edit]
[-] rule.rb [edit]
[-] to_bs.rb [edit]
[-] to_tt_only.rb [edit]
[-] attributes.rb [edit]
[-] paragraph.rb [edit]
[-] raw.rb [edit]
[-] heading.rb [edit]
[-] formatter_test_case.rb [edit]
[-] attribute_manager.rb [edit]
[-] blank_line.rb [edit]
[-] to_test.rb [edit]
[-] attr_changer.rb [edit]
[-] special.rb [edit]
[-] to_table_of_contents.rb [edit]
[-] to_html_crossref.rb [edit]
[-] to_label.rb [edit]
[-] indented_paragraph.rb [edit]
[+] ..
[-] include.rb [edit]
[-] hard_break.rb [edit]
[-] document.rb [edit]
[-] block_quote.rb [edit]
[-] attr_span.rb [edit]
[-] to_html.rb [edit]
[-] to_joined_paragraph.rb [edit]
[-] verbatim.rb [edit]
[-] formatter.rb [edit]
[-] to_html_snippet.rb [edit]
[-] to_ansi.rb [edit]
[-] pre_process.rb [edit]
[-] to_markdown.rb [edit]
[-] to_rdoc.rb [edit]
[-] inline.rb [edit]