class Prism::MultiWriteNode
Represents a write to a multi-target expression.
a, b, c = 1, 2, 3 ^^^^^^^^^^^^^^^^^
Attributes
Represents the targets expressions before a splat node.
a, b, * = 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 ^^^^^^^
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, the field will containt an `ImplicitRestNode`
a, b, = 1, 2, 3, 4 ^
Represents the targets expressions after a splat node.
a, *, b, c = 1, 2, 3, 4, 5 ^^^^
The value to write to the targets. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).
a, b, c = 1, 2, 3 ^^^^^^^
Public Class Methods
def initialize: (Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode] lefts, ImplicitRestNode
| SplatNode
| nil rest, Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode] rights, Location
? lparen_loc
, Location
? rparen_loc
, Location
operator_loc
, Prism::node value, Location
location) -> void
# File lib/prism/node.rb, line 13561 def initialize(source, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location) @source = source @location = location @lefts = lefts @rest = rest @rights = rights @lparen_loc = lparen_loc @rparen_loc = rparen_loc @operator_loc = operator_loc @value = value end
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
# File lib/prism/node.rb, line 13736 def self.type :multi_write_node end
Public Instance Methods
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File lib/prism/node.rb, line 13742 def ===(other) other.is_a?(MultiWriteNode) && (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?) && (operator_loc.nil? == other.operator_loc.nil?) && (value === other.value) end
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 13574 def accept(visitor) visitor.visit_multi_write_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 13579 def child_nodes [*lefts, rest, *rights, value] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 13594 def comment_targets [*lefts, *rest, *rights, *lparen_loc, *rparen_loc, operator_loc, value] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 13584 def compact_child_nodes compact = [] #: Array[Prism::node] compact.concat(lefts) compact << rest if rest compact.concat(rights) compact << value compact end
def copy: (?lefts: Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode], ?rest: ImplicitRestNode
| SplatNode
| nil, ?rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode], ?lparen_loc: Location
?, ?rparen_loc: Location
?, ?operator_loc: Location
, ?value: Prism::node, ?location: Location
) -> MultiWriteNode
# File lib/prism/node.rb, line 13599 def copy(lefts: self.lefts, rest: self.rest, rights: self.rights, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, operator_loc: self.operator_loc, value: self.value, location: self.location) MultiWriteNode.new(source, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location) end
def deconstruct_keys
: (Array keys) -> { lefts: Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode], rest: ImplicitRestNode
| SplatNode
| nil, rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode
| ClassVariableTargetNode
| GlobalVariableTargetNode
| ConstantTargetNode
| ConstantPathTargetNode
| CallTargetNode
| IndexTargetNode
| MultiTargetNode], lparen_loc
: Location
?, rparen_loc
: Location
?, operator_loc
: Location
, value: Prism::node, location: Location
}
# File lib/prism/node.rb, line 13607 def deconstruct_keys(keys) { lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, operator_loc: operator_loc, value: value, location: location } end
def inspect -> String
# File lib/prism/node.rb, line 13708 def inspect InspectVisitor.compose(self) end
def lparen: () -> String
?
# File lib/prism/node.rb, line 13693 def lparen lparen_loc&.slice end
The location of the opening parenthesis.
(a, b, c) = 1, 2, 3 ^
# File lib/prism/node.rb, line 13648 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
def operator: () -> String
# File lib/prism/node.rb, line 13703 def operator operator_loc.slice end
The location of the operator.
a, b, c = 1, 2, 3 ^
# File lib/prism/node.rb, line 13680 def operator_loc location = @operator_loc return location if location.is_a?(Location) @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def rparen: () -> String
?
# File lib/prism/node.rb, line 13698 def rparen rparen_loc&.slice end
The location of the closing parenthesis.
(a, b, c) = 1, 2, 3 ^
# File lib/prism/node.rb, line 13664 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
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
# File lib/prism/node.rb, line 13726 def type :multi_write_node end