Class: Prism::MultiTargetNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, PrismNode
Instance Chain: self, PrismNode
Inherits:	PrismNode `::Object` PrismNode Prism::MultiTargetNode
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]]
    ^^^^

Class Method Summary

.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc) ⇒ MultiTargetNode constructor

Initialize a new MultiTargetNode node.
.type

Return a symbol representation of this node type.

Instance Attribute Summary

#lefts readonly

Represents the targets expressions before a splat node.
#rest readonly

Represents a splat node in the target expression.
#rights readonly

Represents the targets expressions after a splat node.

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#child_nodes (also: #deconstruct)

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

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

def compact_child_nodes: () -> Array.
#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)

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], ?lparen_loc: Location?, ?rparen_loc: Location?) -> MultiTargetNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

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], lparen_loc: Location?, rparen_loc: Location? }
#inspect

def inspect -> String.
#lparen

def lparen: () -> String?
#lparen_loc

The location of the opening parenthesis.
#rparen

def rparen: () -> String?
#rparen_loc

The location of the closing parenthesis.
#type

Return a symbol representation of this node type.

Constructor Details

.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc) ⇒ `MultiTargetNode`

Initialize a new MultiTargetNode node.

[ GitHub ]

# File 'lib/prism/node.rb', line 11461


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

Class Method Details

.type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11593


def self.type
  :multi_target_node
end

Instance Attribute Details

#lefts (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
    ^^^^

[ GitHub ]

# File 'lib/prism/node.rb', line 11519


attr_reader :lefts

#rest (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, the field will containt an ImplicitRestNode

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11534


attr_reader :rest

#rights (readonly)

Represents the targets expressions after a splat node.

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11539


attr_reader :rights

Instance Method Details

#===(other)

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

[ GitHub ]

# File 'lib/prism/node.rb', line 11599


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)

def accept: (Visitor visitor) -> void

[ GitHub ]

# File 'lib/prism/node.rb', line 11474


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

#child_nodes Also known as: #deconstruct

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11479


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

#comment_targets

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11493


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

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 11484


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)

[ GitHub ]

# File 'lib/prism/node.rb', line 11498


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

Alias for #child_nodes.

[ GitHub ]

# File 'lib/prism/node.rb', line 11503


alias deconstruct child_nodes

#deconstruct_keys(keys)

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], lparen_loc: Location?, rparen_loc: Location? }

[ GitHub ]

# File 'lib/prism/node.rb', line 11506


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

def inspect -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 11583


def inspect
  InspectVisitor.compose(self)
end

#lparen

def lparen: () -> String?

[ GitHub ]

# File 'lib/prism/node.rb', line 11573


def lparen
  lparen_loc&.slice
end

#lparen_loc

The location of the opening parenthesis.

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11544


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

def rparen: () -> String?

[ GitHub ]

# File 'lib/prism/node.rb', line 11578


def rparen
  rparen_loc&.slice
end

#rparen_loc

The location of the closing parenthesis.

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11560


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

#type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 11588


def type
  :multi_target_node
end

Class: Prism::MultiTargetNode

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc) ⇒ MultiTargetNode

Class Method Details

.type

Instance Attribute Details

#lefts (readonly)

#rest (readonly)

#rights (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

#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)

#deconstruct

#deconstruct_keys(keys)

#inspect

#lparen

#lparen_loc

#rparen

#rparen_loc

#type

.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc) ⇒ `MultiTargetNode`