Class: Prism::MultiTargetNode

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

Overview

Represents a multi-target expression.

a, (b, c) = 1, 2, 3
   ^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lefts, rest, rights, lparen_loc, rparen_loc, location) ⇒ MultiTargetNode

def initialize: (lefts: Array, rest: Node?, rights: Array, lparen_loc: Location?, rparen_loc: Location?, location: Location) -> void



12127
12128
12129
12130
12131
12132
12133
12134
 
# File 'lib/prism/node.rb', line 12127

def initialize(lefts, rest, rights, lparen_loc, rparen_loc, location)
  @lefts = lefts
  @rest = rest
  @rights = rights
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @location = location
end

Instance Attribute Details

#lefts ⇒ Object (readonly)

attr_reader lefts: Array



12112
12113
12114
 
# File 'lib/prism/node.rb', line 12112

def lefts
  @lefts
end

#lparen_loc ⇒ Object (readonly)

attr_reader lparen_loc: Location?



12121
12122
12123
 
# File 'lib/prism/node.rb', line 12121

def lparen_loc
  @lparen_loc
end

#rest ⇒ Object (readonly)

attr_reader rest: Node?



12115
12116
12117
 
# File 'lib/prism/node.rb', line 12115

def rest
  @rest
end

#rights ⇒ Object (readonly)

attr_reader rights: Array



12118
12119
12120
 
# File 'lib/prism/node.rb', line 12118

def rights
  @rights
end

#rparen_loc ⇒ Object (readonly)

attr_reader rparen_loc: Location?



12124
12125
12126
 
# File 'lib/prism/node.rb', line 12124

def rparen_loc
  @rparen_loc
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



12230
12231
12232
 
# File 'lib/prism/node.rb', line 12230

def self.type
  :multi_target_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12137
12138
12139
 
# File 'lib/prism/node.rb', line 12137

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

#child_nodes ⇒ Object Also known as: deconstruct

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



12142
12143
12144
 
# File 'lib/prism/node.rb', line 12142

def child_nodes
  [*lefts, rest, *rights]
end

#comment_targets ⇒ Object

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



12156
12157
12158
 
# File 'lib/prism/node.rb', line 12156

def comment_targets
  [*lefts, *rest, *rights, *lparen_loc, *rparen_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12147
12148
12149
12150
12151
12152
12153
 
# File 'lib/prism/node.rb', line 12147

def compact_child_nodes
  compact = []
  compact.concat(lefts)
  compact << rest if rest
  compact.concat(rights)
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> MultiTargetNode



12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
 
# File 'lib/prism/node.rb', line 12161

def copy(**params)
  MultiTargetNode.new(
    params.fetch(:lefts) { lefts },
    params.fetch(:rest) { rest },
    params.fetch(:rights) { rights },
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



12176
12177
12178
 
# File 'lib/prism/node.rb', line 12176

def deconstruct_keys(keys)
  { lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
 
# File 'lib/prism/node.rb', line 12191

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── lefts: #{inspector.list("#{inspector.prefix}│   ", lefts)}"
  if (rest = self.rest).nil?
    inspector << "├── rest: ∅\n"
  else
    inspector << "├── rest:\n"
    inspector << rest.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── rights: #{inspector.list("#{inspector.prefix}│   ", rights)}"
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  inspector << "└── rparen_loc: #{inspector.location(rparen_loc)}\n"
  inspector.to_str
end

#lparen ⇒ Object

def lparen: () -> String?



12181
12182
12183
 
# File 'lib/prism/node.rb', line 12181

def lparen
  lparen_loc&.slice
end

#rparen ⇒ Object

def rparen: () -> String?



12186
12187
12188
 
# File 'lib/prism/node.rb', line 12186

def rparen
  rparen_loc&.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



12220
12221
12222
 
# File 'lib/prism/node.rb', line 12220

def type
  :multi_target_node
end