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.



13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
 
# File 'lib/prism/node.rb', line 13188

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



13249
13250
13251
 
# File 'lib/prism/node.rb', line 13249

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
    ^



13265
13266
13267
 
# File 'lib/prism/node.rb', line 13265

def rest
  @rest
end

#rights ⇒ Object (readonly)

Represents the targets expressions after a splat node.

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



13271
13272
13273
 
# File 'lib/prism/node.rb', line 13271

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



13337
13338
13339
 
# File 'lib/prism/node.rb', line 13337

def value
  @value
end

Class Method Details

.type ⇒ Object

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



13365
13366
13367
 
# File 'lib/prism/node.rb', line 13365

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.



13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
 
# File 'lib/prism/node.rb', line 13371

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



13203
13204
13205
 
# File 'lib/prism/node.rb', line 13203

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13208
13209
13210
 
# File 'lib/prism/node.rb', line 13208

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

#comment_targets ⇒ Object

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



13223
13224
13225
 
# File 'lib/prism/node.rb', line 13223

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



13213
13214
13215
13216
13217
13218
13219
13220
 
# File 'lib/prism/node.rb', line 13213

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



13228
13229
13230
 
# File 'lib/prism/node.rb', line 13228

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 }



13236
13237
13238
 
# File 'lib/prism/node.rb', line 13236

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



13355
13356
13357
 
# File 'lib/prism/node.rb', line 13355

def inspect
  InspectVisitor.compose(self)
end

#lparen ⇒ Object

def lparen: () -> String?



13340
13341
13342
 
# File 'lib/prism/node.rb', line 13340

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

The location of the opening parenthesis.

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



13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
 
# File 'lib/prism/node.rb', line 13277

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



13350
13351
13352
 
# File 'lib/prism/node.rb', line 13350

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the operator.

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



13321
13322
13323
13324
13325
 
# File 'lib/prism/node.rb', line 13321

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?



13345
13346
13347
 
# File 'lib/prism/node.rb', line 13345

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

The location of the closing parenthesis.

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



13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
 
# File 'lib/prism/node.rb', line 13299

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

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



13291
13292
13293
 
# File 'lib/prism/node.rb', line 13291

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

#save_operator_loc(repository) ⇒ Object

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



13329
13330
13331
 
# File 'lib/prism/node.rb', line 13329

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#save_rparen_loc(repository) ⇒ Object

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



13313
13314
13315
 
# File 'lib/prism/node.rb', line 13313

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

#type ⇒ Object

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



13360
13361
13362
 
# File 'lib/prism/node.rb', line 13360

def type
  :multi_write_node
end