Class: Prism::ArrayPatternNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents an array pattern in pattern matching.

foo in 1, 2
^^^^^^^^^^^

foo in [1, 2]
^^^^^^^^^^^^^

foo in *bar
^^^^^^^^^^^

foo in Bar[]
^^^^^^^^^^^^

foo in Bar[1, 2, 3]
^^^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc) ⇒ ArrayPatternNode

Initialize a new ArrayPatternNode node.



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/prism/node.rb', line 1021

def initialize(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @constant = constant
  @requireds = requireds
  @rest = rest
  @posts = posts
  @opening_loc = opening_loc
  @closing_loc = closing_loc
end

Instance Attribute Details

#constant ⇒ Object (readonly)

attr_reader constant: ConstantReadNode | ConstantPathNode | nil



1073
1074
1075
 
# File 'lib/prism/node.rb', line 1073

def constant
  @constant
end

#posts ⇒ Object (readonly)

Represents the elements after the rest element of the array pattern.

foo in *bar, baz
             ^^^



1091
1092
1093
 
# File 'lib/prism/node.rb', line 1091

def posts
  @posts
end

#requireds ⇒ Object (readonly)

Represents the required elements of the array pattern.

foo in [1, 2]
        ^  ^



1079
1080
1081
 
# File 'lib/prism/node.rb', line 1079

def requireds
  @requireds
end

#rest ⇒ Object (readonly)

Represents the rest element of the array pattern.

foo in *bar
       ^^^^



1085
1086
1087
 
# File 'lib/prism/node.rb', line 1085

def rest
  @rest
end

Class Method Details

.type ⇒ Object

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



1158
1159
1160
 
# File 'lib/prism/node.rb', line 1158

def self.type
  :array_pattern_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.



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/prism/node.rb', line 1164

def ===(other)
  other.is_a?(ArrayPatternNode) &&
    (constant === other.constant) &&
    (requireds.length == other.requireds.length) &&
    requireds.zip(other.requireds).all? { |left, right| left === right } &&
    (rest === other.rest) &&
    (posts.length == other.posts.length) &&
    posts.zip(other.posts).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



1035
1036
1037
 
# File 'lib/prism/node.rb', line 1035

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1040
1041
1042
 
# File 'lib/prism/node.rb', line 1040

def child_nodes
  [constant, *requireds, rest, *posts]
end

#closing ⇒ Object

def closing: () -> String?



1143
1144
1145
 
# File 'lib/prism/node.rb', line 1143

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

Represents the closing location of the array pattern.

foo in [1, 2]
            ^



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/prism/node.rb', line 1119

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]



1055
1056
1057
 
# File 'lib/prism/node.rb', line 1055

def comment_targets
  [*constant, *requireds, *rest, *posts, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/prism/node.rb', line 1045

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << constant if constant
  compact.concat(requireds)
  compact << rest if rest
  compact.concat(posts)
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?constant: ConstantReadNode | ConstantPathNode | nil, ?requireds: Array, ?rest: Prism::node?, ?posts: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayPatternNode



1060
1061
1062
 
# File 'lib/prism/node.rb', line 1060

def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  ArrayPatternNode.new(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, constant: ConstantReadNode | ConstantPathNode | nil, requireds: Array, rest: Prism::node?, posts: Array, opening_loc: Location?, closing_loc: Location? }



1068
1069
1070
 
# File 'lib/prism/node.rb', line 1068

def deconstruct_keys(keys)
  { node_id: node_id, location: location, constant: constant, requireds: requireds, rest: rest, posts: posts, opening_loc: opening_loc, closing_loc: closing_loc }
end

#inspect ⇒ Object

def inspect -> String



1148
1149
1150
 
# File 'lib/prism/node.rb', line 1148

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



1138
1139
1140
 
# File 'lib/prism/node.rb', line 1138

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

Represents the opening location of the array pattern.

foo in [1, 2]
       ^



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/prism/node.rb', line 1097

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.



1133
1134
1135
 
# File 'lib/prism/node.rb', line 1133

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.



1111
1112
1113
 
# File 'lib/prism/node.rb', line 1111

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`.



1153
1154
1155
 
# File 'lib/prism/node.rb', line 1153

def type
  :array_pattern_node
end