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
   ^^^^^^

This can be a part of ‘MultiWriteNode` as above, or the target of a `for` loop

for a, b in [[1, 2], [3, 4]]
    ^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new MultiTargetNode node.



13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
 
# File 'lib/prism/node.rb', line 13017

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

Instance Attribute Details

#lefts ⇒ Object (readonly)

Represents the targets expressions before a splat node.

a, (b, c, *) = 1, 2, 3, 4, 5
    ^^^^

The splat node can be absent, in that case all target expressions are in the left field.

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



13075
13076
13077
 
# File 'lib/prism/node.rb', line 13075

def lefts
  @lefts
end

#rest ⇒ Object (readonly)

Represents a splat node in the target expression.

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

The variable can be empty, this results in a ‘SplatNode` with a `nil` expression field.

a, (b, *) = 1, 2, 3, 4
       ^

If the ‘*` is omitted, this field will contain an `ImplicitRestNode`

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



13091
13092
13093
 
# File 'lib/prism/node.rb', line 13091

def rest
  @rest
end

#rights ⇒ Object (readonly)

Represents the targets expressions after a splat node.

a, (*, b, c) = 1, 2, 3, 4, 5
       ^^^^



13097
13098
13099
 
# File 'lib/prism/node.rb', line 13097

def rights
  @rights
end

Class Method Details

.type ⇒ Object

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



13164
13165
13166
 
# File 'lib/prism/node.rb', line 13164

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



13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
 
# File 'lib/prism/node.rb', line 13170

def ===(other)
  other.is_a?(MultiTargetNode) &&
    (lefts.length == other.lefts.length) &&
    lefts.zip(other.lefts).all? { |left, right| left === right } &&
    (rest === other.rest) &&
    (rights.length == other.rights.length) &&
    rights.zip(other.rights).all? { |left, right| left === right } &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (rparen_loc.nil? == other.rparen_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



13030
13031
13032
 
# File 'lib/prism/node.rb', line 13030

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13035
13036
13037
 
# File 'lib/prism/node.rb', line 13035

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

#comment_targets ⇒ Object

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



13049
13050
13051
 
# File 'lib/prism/node.rb', line 13049

def comment_targets
  [*lefts, *rest, *rights, *lparen_loc, *rparen_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13040
13041
13042
13043
13044
13045
13046
 
# File 'lib/prism/node.rb', line 13040

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact.concat(lefts)
  compact << rest if rest
  compact.concat(rights)
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, lefts: self.lefts, rest: self.rest, rights: self.rights, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?lefts: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | RequiredParameterNode | BackReferenceReadNode | NumberedReferenceReadNode], ?rest: ImplicitRestNode | SplatNode | nil, ?rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | RequiredParameterNode | BackReferenceReadNode | NumberedReferenceReadNode], ?lparen_loc: Location?, ?rparen_loc: Location?) -> MultiTargetNode



13054
13055
13056
 
# File 'lib/prism/node.rb', line 13054

def copy(node_id: self.node_id, location: self.location, flags: self.flags, lefts: self.lefts, rest: self.rest, rights: self.rights, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc)
  MultiTargetNode.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, lefts: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | RequiredParameterNode | BackReferenceReadNode | NumberedReferenceReadNode], rest: ImplicitRestNode | SplatNode | nil, rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | RequiredParameterNode | BackReferenceReadNode | NumberedReferenceReadNode], lparen_loc: Location?, rparen_loc: Location? }



13062
13063
13064
 
# File 'lib/prism/node.rb', line 13062

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

#inspect ⇒ Object

def inspect -> String



13154
13155
13156
 
# File 'lib/prism/node.rb', line 13154

def inspect
  InspectVisitor.compose(self)
end

#lparen ⇒ Object

def lparen: () -> String?



13144
13145
13146
 
# File 'lib/prism/node.rb', line 13144

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

The location of the opening parenthesis.

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



13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
 
# File 'lib/prism/node.rb', line 13103

def lparen_loc
  location = @lparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#rparen ⇒ Object

def rparen: () -> String?



13149
13150
13151
 
# File 'lib/prism/node.rb', line 13149

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

The location of the closing parenthesis.

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



13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
 
# File 'lib/prism/node.rb', line 13125

def rparen_loc
  location = @rparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#save_lparen_loc(repository) ⇒ Object

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



13117
13118
13119
 
# File 'lib/prism/node.rb', line 13117

def save_lparen_loc(repository)
  repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
end

#save_rparen_loc(repository) ⇒ Object

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



13139
13140
13141
 
# File 'lib/prism/node.rb', line 13139

def save_rparen_loc(repository)
  repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
end

#type ⇒ Object

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



13159
13160
13161
 
# File 'lib/prism/node.rb', line 13159

def type
  :multi_target_node
end