class Prism::ArrayNode

Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.

[1, 2, 3]
^^^^^^^^^

Attributes

elements [R]

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.

Public Class Methods

new (source, node_id, location, flags, elements, opening_loc, closing_loc)

Source

# File lib/prism/node.rb, line 867
def initialize(source, node_id, location, flags, elements, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @elements = elements
  @opening_loc = opening_loc
  @closing_loc = closing_loc
end

Initialize a new ArrayNode node.

type ()

Source

# File lib/prism/node.rb, line 987
def self.type
  :array_node
end

Return a symbol representation of this node type. See ‘Node::type`.

Public Instance Methods

=== (other)

Source

# File lib/prism/node.rb, line 993
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.

accept (visitor)

Source

# File lib/prism/node.rb, line 878
def accept(visitor)
  visitor.visit_array_node(self)
end

def accept: (Visitor visitor) -> void

child_nodes ()

Source

# File lib/prism/node.rb, line 883
def child_nodes
  [*elements]
end

def child_nodes: () -> Array[nil | Node]

Also aliased as: deconstruct

closing ()

Source

# File lib/prism/node.rb, line 972
def closing
  closing_loc&.slice
end

def closing: () -> String?

closing_loc ()

Source

# File lib/prism/node.rb, line 948
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

comment_targets ()

Source

# File lib/prism/node.rb, line 893
def comment_targets
  [*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end

def comment_targets: () -> Array[Node | Location]

compact_child_nodes ()

Source

# File lib/prism/node.rb, line 888
def compact_child_nodes
  [*elements]
end

def compact_child_nodes: () -> Array

contains_splat? ()

Source

# File lib/prism/node.rb, line 911
def contains_splat?
  flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
end

def contains_splat?: () -> bool

copy (node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc)

Source

# File lib/prism/node.rb, line 898
def copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  ArrayNode.new(source, node_id, location, flags, elements, opening_loc, closing_loc)
end

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?elements: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayNode

deconstruct ()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes

deconstruct_keys (keys)

Source

# File lib/prism/node.rb, line 906
def deconstruct_keys(keys)
  { node_id: node_id, location: location, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc }
end

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, elements: Array, opening_loc: Location?, closing_loc: Location? }

inspect ()

Source

# File lib/prism/node.rb, line 977
def inspect
  InspectVisitor.compose(self)
end

def inspect -> String

opening ()

Source

# File lib/prism/node.rb, line 967
def opening
  opening_loc&.slice
end

def opening: () -> String?

opening_loc ()

Source

# File lib/prism/node.rb, line 924
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

save_closing_loc (repository)

Source

# File lib/prism/node.rb, line 962
def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

Save the closing_loc location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)

Source

# File lib/prism/node.rb, line 938
def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

Save the opening_loc location using the given saved source so that it can be retrieved later.

type ()

Source

# File lib/prism/node.rb, line 982
def type
  :array_node
end

Return a symbol representation of this node type. See ‘Node#type`.