Class: Prism::MultiWriteNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a write to a multi-target expression.

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

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, operator_loc, value) ⇒ MultiWriteNode

Initialize a new MultiWriteNode node.



11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
 
# File 'lib/prism/node.rb', line 11869

def initialize(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @lefts = lefts
  @rest = rest
  @rights = rights
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @operator_loc = operator_loc
  @value = value
end

Instance Attribute Details

#lefts ⇒ Object (readonly)

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



11930
11931
11932
 
# File 'lib/prism/node.rb', line 11930

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

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



11946
11947
11948
 
# File 'lib/prism/node.rb', line 11946

def rest
  @rest
end

#rights ⇒ Object (readonly)

Represents the targets expressions after a splat node.

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



11952
11953
11954
 
# File 'lib/prism/node.rb', line 11952

def rights
  @rights
end

#value ⇒ Object (readonly)

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



12000
12001
12002
 
# File 'lib/prism/node.rb', line 12000

def value
  @value
end

Class Method Details

.type ⇒ Object

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



12028
12029
12030
 
# File 'lib/prism/node.rb', line 12028

def self.type
  :multi_write_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.



12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
 
# File 'lib/prism/node.rb', line 12034

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



11884
11885
11886
 
# File 'lib/prism/node.rb', line 11884

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11889
11890
11891
 
# File 'lib/prism/node.rb', line 11889

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

#comment_targets ⇒ Object

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



11904
11905
11906
 
# File 'lib/prism/node.rb', line 11904

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11894
11895
11896
11897
11898
11899
11900
11901
 
# File 'lib/prism/node.rb', line 11894

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact.concat(lefts)
  compact << rest if rest
  compact.concat(rights)
  compact << value
  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, operator_loc: self.operator_loc, value: self.value) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?lefts: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | BackReferenceReadNode | NumberedReferenceReadNode], ?rest: ImplicitRestNode | SplatNode | nil, ?rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | BackReferenceReadNode | NumberedReferenceReadNode], ?lparen_loc: Location?, ?rparen_loc: Location?, ?operator_loc: Location, ?value: Prism::node) -> MultiWriteNode



11909
11910
11911
 
# File 'lib/prism/node.rb', line 11909

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, operator_loc: self.operator_loc, value: self.value)
  MultiWriteNode.new(source, node_id, location, flags, lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value)
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 | BackReferenceReadNode | NumberedReferenceReadNode], rest: ImplicitRestNode | SplatNode | nil, rights: Array[LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | BackReferenceReadNode | NumberedReferenceReadNode], lparen_loc: Location?, rparen_loc: Location?, operator_loc: Location, value: Prism::node }



11917
11918
11919
 
# File 'lib/prism/node.rb', line 11917

def deconstruct_keys(keys)
  { node_id: node_id, location: location, lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, operator_loc: operator_loc, value: value }
end

#inspect ⇒ Object

def inspect -> String



12018
12019
12020
 
# File 'lib/prism/node.rb', line 12018

def inspect
  InspectVisitor.compose(self)
end

#lparen ⇒ Object

def lparen: () -> String?



12003
12004
12005
 
# File 'lib/prism/node.rb', line 12003

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

The location of the opening parenthesis.

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



11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
 
# File 'lib/prism/node.rb', line 11958

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

#operator ⇒ Object

def operator: () -> String



12013
12014
12015
 
# File 'lib/prism/node.rb', line 12013

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the operator.

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



11990
11991
11992
11993
11994
 
# File 'lib/prism/node.rb', line 11990

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#rparen ⇒ Object

def rparen: () -> String?



12008
12009
12010
 
# File 'lib/prism/node.rb', line 12008

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

The location of the closing parenthesis.

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



11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
 
# File 'lib/prism/node.rb', line 11974

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`.



12023
12024
12025
 
# File 'lib/prism/node.rb', line 12023

def type
  :multi_write_node
end