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.

flags[R]

protected attr_reader flags: Integer

Public Class Methods

new(source, flags, elements, opening_loc, closing_loc, location) click to toggle source

def initialize: (Integer flags, Array elements, Location? opening_loc, Location? closing_loc, Location location) -> void

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

type() click to toggle source

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 lib/prism/node.rb, line 845
def self.type
  :array_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

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

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

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

comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

contains_splat?() click to toggle source

def contains_splat?: () -> bool

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

copy(flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location) click to toggle source

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

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

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

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

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

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

type() click to toggle source

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

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