123456789_123456789_123456789_123456789_123456789_

Class: Prism::ArrayNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

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

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

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, elements, opening_loc, closing_loc) ⇒ ArrayNode

Initialize a new ArrayNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 697



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 804



def self.type
  :array_node
end


  







Instance Attribute Details



  

    #contains_splat?  ⇒ Boolean  (readonly)
  



  

    
def contains_splat?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 741



def contains_splat?
  flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
end


  








  

    #elements   (readonly)
  



  

    
Represent the list of zero or morenon-void expressions within the array.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 746



attr_reader :elements


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 810



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 708



def accept(visitor)
  visitor.visit_array_node(self)
end


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 713



def child_nodes
  [*elements]
end


  








  

    #closing  
  



  

    
def closing: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 789



def closing
  closing_loc&.slice
end


  








  

    #closing_loc  
  



  

    
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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 771



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  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 723



def comment_targets
  [*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 718



def compact_child_nodes
  [*elements]
end


  








  

    #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)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 728



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 733



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 736



def deconstruct_keys(keys)
  { node_id: node_id, location: location, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 794



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 784



def opening
  opening_loc&.slice
end


  








  

    #opening_loc  
  



  

    
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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 753



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  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 799



def type
  :array_node
end