Class: RDoc::Markup::List

Inherits:

Object

• Object
• RDoc::Markup::List

show all

Defined in:

lib/rdoc/markup/list.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) items readonly

  Items in the list.

• - (Object) type

  The list's type.

Instance Method Summary (collapse)

• - (Object) <<(item)

  Appends item to the list.

• - (Object) ==(other)

  :nodoc:.

• - (Object) accept(visitor)

  Runs this list and all its #items through visitor.

• - (Boolean) empty?

  Is the list empty?.

• - (List) initialize(type = nil, *items) constructor

  Creates a new list of type with items.

• - (Object) last

  Returns the last item in the list.

• - (Object) pretty_print(q)

  :nodoc:.

• - (Object) push(*items)

  Appends items to the list.

19
20
21
22
23

# File 'lib/rdoc/markup/list.rb', line 19

def initialize type = nil, *items
  @type = type
  @items = []
  @items.push(*items)
end

14
15
16

# File 'lib/rdoc/markup/list.rb', line 14

def items
  @items
end

9
10
11

# File 'lib/rdoc/markup/list.rb', line 9

def type
  @type
end

28
29
30

# File 'lib/rdoc/markup/list.rb', line 28

def << item
  @items << item
end

32
33
34
35
36

# File 'lib/rdoc/markup/list.rb', line 32

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

41
42
43
44
45
46
47
48
49

# File 'lib/rdoc/markup/list.rb', line 41

def accept visitor
  visitor.accept_list_start self

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

  visitor.accept_list_end self
end

54
55
56

# File 'lib/rdoc/markup/list.rb', line 54

def empty?
  @items.empty?
end

61
62
63

# File 'lib/rdoc/markup/list.rb', line 61

def last
  @items.last
end

65
66
67
68
69
70
71

# File 'lib/rdoc/markup/list.rb', line 65

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

76
77
78

# File 'lib/rdoc/markup/list.rb', line 76

def push *items
  @items.push(*items)
end