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.



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/prism/node.rb', line 1085

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)

Represents the optional constant preceding the Array

foo in Bar[]
       ^^^

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

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



1156
1157
1158
 
# File 'lib/prism/node.rb', line 1156

def constant
  @constant
end

#posts ⇒ Object (readonly)

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

foo in *bar, baz
             ^^^



1174
1175
1176
 
# File 'lib/prism/node.rb', line 1174

def posts
  @posts
end

#requireds ⇒ Object (readonly)

Represents the required elements of the array pattern.

foo in [1, 2]
        ^  ^



1162
1163
1164
 
# File 'lib/prism/node.rb', line 1162

def requireds
  @requireds
end

#rest ⇒ Object (readonly)

Represents the rest element of the array pattern.

foo in *bar
       ^^^^



1168
1169
1170
 
# File 'lib/prism/node.rb', line 1168

def rest
  @rest
end

Class Method Details

.type ⇒ Object

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



1241
1242
1243
 
# File 'lib/prism/node.rb', line 1241

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.



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/prism/node.rb', line 1247

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



1099
1100
1101
 
# File 'lib/prism/node.rb', line 1099

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



1104
1105
1106
 
# File 'lib/prism/node.rb', line 1104

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

#closing ⇒ Object

def closing: () -> String?



1226
1227
1228
 
# File 'lib/prism/node.rb', line 1226

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

Represents the closing location of the array pattern.

foo in [1, 2]
            ^



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/prism/node.rb', line 1202

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]



1129
1130
1131
 
# File 'lib/prism/node.rb', line 1129

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



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

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: ConstantPathNode | ConstantReadNode | nil, ?requireds: Array, ?rest: Prism::node?, ?posts: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayPatternNode



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

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: ConstantPathNode | ConstantReadNode | nil, requireds: Array, rest: Prism::node?, posts: Array, opening_loc: Location?, closing_loc: Location? }



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

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

#each_child_node {|constant| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/prism/node.rb', line 1109

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield constant if constant
  requireds.each { |node| yield node }
  yield rest if rest
  posts.each { |node| yield node }
end

#inspect ⇒ Object

def inspect -> String



1231
1232
1233
 
# File 'lib/prism/node.rb', line 1231

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



1221
1222
1223
 
# File 'lib/prism/node.rb', line 1221

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

Represents the opening location of the array pattern.

foo in [1, 2]
       ^



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/prism/node.rb', line 1180

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.



1216
1217
1218
 
# File 'lib/prism/node.rb', line 1216

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.



1194
1195
1196
 
# File 'lib/prism/node.rb', line 1194

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



1236
1237
1238
 
# File 'lib/prism/node.rb', line 1236

def type
  :array_pattern_node
end