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.



867
868
869
870
871
872
873
874
875
 
# 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

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.



916
917
918
 
# File 'lib/prism/node.rb', line 916

def elements
  @elements
end

Class Method Details

.type ⇒ Object

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



987
988
989
 
# File 'lib/prism/node.rb', line 987

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.



993
994
995
996
997
998
999
1000
 
# 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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



878
879
880
 
# File 'lib/prism/node.rb', line 878

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

#child_nodes ⇒ Object Also known as: deconstruct

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



883
884
885
 
# File 'lib/prism/node.rb', line 883

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String?



972
973
974
 
# File 'lib/prism/node.rb', line 972

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



948
949
950
951
952
953
954
955
956
957
958
 
# 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

#comment_targets ⇒ Object

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



893
894
895
 
# File 'lib/prism/node.rb', line 893

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



888
889
890
 
# File 'lib/prism/node.rb', line 888

def compact_child_nodes
  [*elements]
end

#contains_splat? ⇒ Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean) 


911
912
913
 
# File 'lib/prism/node.rb', line 911

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



898
899
900
 
# 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

#deconstruct_keys(keys) ⇒ Object

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



906
907
908
 
# 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

#inspect ⇒ Object

def inspect -> String



977
978
979
 
# File 'lib/prism/node.rb', line 977

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



967
968
969
 
# File 'lib/prism/node.rb', line 967

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



924
925
926
927
928
929
930
931
932
933
934
 
# 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

#save_closing_loc(repository) ⇒ Object

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



962
963
964
 
# File 'lib/prism/node.rb', line 962

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

#save_opening_loc(repository) ⇒ Object

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



938
939
940
 
# File 'lib/prism/node.rb', line 938

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

#type ⇒ Object

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



982
983
984
 
# File 'lib/prism/node.rb', line 982

def type
  :array_node
end