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.



11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
 
# File 'lib/prism/node.rb', line 11673

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



11731
11732
11733
 
# File 'lib/prism/node.rb', line 11731

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, the field will containt an `ImplicitRestNode`

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



11747
11748
11749
 
# File 'lib/prism/node.rb', line 11747

def rest
  @rest
end

#rights ⇒ Object (readonly)

Represents the targets expressions after a splat node.

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



11753
11754
11755
 
# File 'lib/prism/node.rb', line 11753

def rights
  @rights
end

Class Method Details

.type ⇒ Object

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



11808
11809
11810
 
# File 'lib/prism/node.rb', line 11808

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.



11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
 
# File 'lib/prism/node.rb', line 11814

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



11686
11687
11688
 
# File 'lib/prism/node.rb', line 11686

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11691
11692
11693
 
# File 'lib/prism/node.rb', line 11691

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

#comment_targets ⇒ Object

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



11705
11706
11707
 
# File 'lib/prism/node.rb', line 11705

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11696
11697
11698
11699
11700
11701
11702
 
# File 'lib/prism/node.rb', line 11696

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



11710
11711
11712
 
# File 'lib/prism/node.rb', line 11710

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



11718
11719
11720
 
# File 'lib/prism/node.rb', line 11718

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



11798
11799
11800
 
# File 'lib/prism/node.rb', line 11798

def inspect
  InspectVisitor.compose(self)
end

#lparen ⇒ Object

def lparen: () -> String?



11788
11789
11790
 
# File 'lib/prism/node.rb', line 11788

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

The location of the opening parenthesis.

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



11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
 
# File 'lib/prism/node.rb', line 11759

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?



11793
11794
11795
 
# File 'lib/prism/node.rb', line 11793

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

The location of the closing parenthesis.

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



11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
 
# File 'lib/prism/node.rb', line 11775

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 ⇒ Object

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



11803
11804
11805
 
# File 'lib/prism/node.rb', line 11803

def type
  :multi_target_node
end