Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.
[1, 2, 3] ^^^^^^^^^
Represent the list of zero or more [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression) within the array.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 740
def initialize(source, flags, elements, opening_loc, closing_loc, location)
@source = source
@location = location
@flags = flags
@elements = elements
@opening_loc = opening_loc
@closing_loc = closing_loc
end
def initialize: (Integer flags, Array elements, Location? opening_loc, Location? closing_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 869
def self.type
:array_node
end
Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 875
def ===(other)
other.is_a?(ArrayNode) &&
(flags === other.flags) &&
(elements.length == other.elements.length) &&
elements.zip(other.elements).all? { |left, right| left === right } &&
(opening_loc.nil? == other.opening_loc.nil?) &&
(closing_loc.nil? == other.closing_loc.nil?)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 750
def accept(visitor)
visitor.visit_array_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 755
def child_nodes
[*elements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 836
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 813
def closing_loc
location = @closing_loc
case location
when nil
nil
when Location
location
else
@closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
Represents the optional source location for the closing token.
[1,2,3] # "]" %w[foo bar baz] # "]" %I(apple orange banana) # ")" foo = 1, 2, 3 # nil
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 765
def comment_targets
[*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 760
def compact_child_nodes
[*elements]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 826
def contains_splat?
flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
end
def contains_splat?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 770
def copy(flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location)
ArrayNode.new(source, flags, elements, opening_loc, closing_loc, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 778
def deconstruct_keys(keys)
{ flags: flags, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { flags: Integer, elements: Array, opening_loc: Location?, closing_loc: Location?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 841
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 831
def opening
opening_loc&.slice
end
def opening: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 795
def opening_loc
location = @opening_loc
case location
when nil
nil
when Location
location
else
@opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
Represents the optional source location for the opening token.
[1,2,3] # "[" %w[foo bar baz] # "%w[" %I(apple orange banana) # "%I(" foo = 1, 2, 3 # nil
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 859
def type
:array_node
end
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol