Class: Prism::ArrayNode

Inherits:
PrismNode
  • Object
show all
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]
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, elements, opening_loc, closing_loc) ⇒ ArrayNode

Initialize a new ArrayNode node.



711
712
713
714
715
716
717
718
719
 
# File 'lib/prism/node.rb', line 711

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

Instance Attribute Details

#elements ⇒ Object (readonly)

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.



760
761
762
 
# File 'lib/prism/node.rb', line 760

def elements
  @elements
end

Class Method Details

.type ⇒ Object

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



819
820
821
 
# File 'lib/prism/node.rb', line 819

def self.type
  :array_node
end

Instance Method Details

#===(other) ⇒ Object

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



825
826
827
828
829
830
831
832
 
# File 'lib/prism/node.rb', line 825

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) ⇒ Object

def accept: (Visitor visitor) -> void



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

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

#child_nodes ⇒ Object Also known as: deconstruct

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



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

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String?



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

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

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



786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/prism/node.rb', line 786

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 ⇒ Object

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



737
738
739
 
# File 'lib/prism/node.rb', line 737

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



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

def compact_child_nodes
  [*elements]
end

#contains_splat? ⇒ Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean) 


755
756
757
 
# File 'lib/prism/node.rb', line 755

def contains_splat?
  flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
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) ⇒ Object

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



742
743
744
 
# File 'lib/prism/node.rb', line 742

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_keys(keys) ⇒ Object

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



750
751
752
 
# File 'lib/prism/node.rb', line 750

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

#inspect ⇒ Object

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



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

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

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



768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/prism/node.rb', line 768

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 ⇒ Object

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



814
815
816
 
# File 'lib/prism/node.rb', line 814

def type
  :array_node
end