Class: Prism::MultiTargetNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::MultiTargetNode
Defined in:	lib/prism/node.rb, 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.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	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.

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.

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

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.
#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 | NumberedReferenceReadNode], ?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 | NumberedReferenceReadNode], lparen_loc: Location?, rparen_loc: Location? }
#each_child_node {|rest| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator.
#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.
#save_lparen_loc(repository)

Save the lparen_loc location using the given saved source so that it can be retrieved later.
#save_rparen_loc(repository)

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

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

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 13965


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 14121


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 14032


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, this field will contain an ImplicitRestNode

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

[ GitHub ]

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


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 14054


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 14127


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 13978


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

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


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

#comment_targets

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

[ GitHub ]

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


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 13997


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 14011


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 14016


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

[ GitHub ]

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


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

#each_child_node {|rest| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:

(rest)

[ GitHub ]

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


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  lefts.each { |node| yield node }
  yield rest if rest
  rights.each { |node| yield node }
end

#inspect

def inspect -> String

[ GitHub ]

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


def inspect
  InspectVisitor.compose(self)
end

#lparen

def lparen: () -> String?

[ GitHub ]

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


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 14060


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 14106


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 14082


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)

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

[ GitHub ]

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


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

#save_rparen_loc(repository)

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

[ GitHub ]

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


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

#type

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

[ GitHub ]

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


def type
  :multi_target_node
end

Class: Prism::MultiTargetNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

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)

#each_child_node {|rest| ... }

#inspect

#lparen

#lparen_loc

#rparen

#rparen_loc

#save_lparen_loc(repository)

#save_rparen_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

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