class Prism::MultiTargetNode - prism: Ruby Standard Library Documentation

# class Prism::MultiTargetNode

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

### Attributes

lefts[R]

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

rest[R]

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
         ^

rights[R]

Represents the targets expressions after a splat node.

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

### Public Class Methods

new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc) click to toggle source

Initialize a new `MultiTargetNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 13164
    def self.type
      :multi_target_node
    end

### Public Instance Methods

===(other) click to toggle source

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

    # File 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) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 13030
    def accept(visitor)
      visitor.visit_multi_target_node(self)
    end

child_nodes() click to toggle source

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

    # File prism/node.rb, line 13035
    def child_nodes
      [*lefts, rest, *rights]
    end

Also aliased as: deconstruct
comment_targets() click to toggle source

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

    # File prism/node.rb, line 13049
    def comment_targets
      [*lefts, *rest, *rights, *lparen_loc, *rparen_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File 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) click to toggle source

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`

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

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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`? }

    # File 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() click to toggle source

def inspect -> String

    # File prism/node.rb, line 13154
    def inspect
      InspectVisitor.compose(self)
    end

lparen() click to toggle source

def lparen: () -> String?

    # File prism/node.rb, line 13144
    def lparen
      lparen_loc&.slice
    end

lparen_loc() click to toggle source

The location of the opening parenthesis.

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

    # File 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() click to toggle source

def rparen: () -> String?

    # File prism/node.rb, line 13149
    def rparen
      rparen_loc&.slice
    end

rparen_loc() click to toggle source

The location of the closing parenthesis.

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

    # File 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) click to toggle source

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

    # File 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) click to toggle source

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

    # File prism/node.rb, line 13139
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
    end

type() click to toggle source

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

    # File prism/node.rb, line 13159
    def type
      :multi_target_node
    end