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(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location) ⇒ MultiWriteNode

def initialize: (lefts: Array, rest: Node?, rights: Array, lparen_loc: Location?, rparen_loc: Location?, operator_loc: Location, value: Node, location: Location) -> void



12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
 
# File 'lib/prism/node.rb', line 12262

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

Instance Attribute Details

#lefts ⇒ Object (readonly)

attr_reader lefts: Array



12241
12242
12243
 
# File 'lib/prism/node.rb', line 12241

def lefts
  @lefts
end

#lparen_loc ⇒ Object (readonly)

attr_reader lparen_loc: Location?



12250
12251
12252
 
# File 'lib/prism/node.rb', line 12250

def lparen_loc
  @lparen_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



12256
12257
12258
 
# File 'lib/prism/node.rb', line 12256

def operator_loc
  @operator_loc
end

#rest ⇒ Object (readonly)

attr_reader rest: Node?



12244
12245
12246
 
# File 'lib/prism/node.rb', line 12244

def rest
  @rest
end

#rights ⇒ Object (readonly)

attr_reader rights: Array



12247
12248
12249
 
# File 'lib/prism/node.rb', line 12247

def rights
  @rights
end

#rparen_loc ⇒ Object (readonly)

attr_reader rparen_loc: Location?



12253
12254
12255
 
# File 'lib/prism/node.rb', line 12253

def rparen_loc
  @rparen_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



12259
12260
12261
 
# File 'lib/prism/node.rb', line 12259

def value
  @value
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



12378
12379
12380
 
# File 'lib/prism/node.rb', line 12378

def self.type
  :multi_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12274
12275
12276
 
# File 'lib/prism/node.rb', line 12274

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

#child_nodes ⇒ Object Also known as: deconstruct

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



12279
12280
12281
 
# File 'lib/prism/node.rb', line 12279

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

#comment_targets ⇒ Object

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



12294
12295
12296
 
# File 'lib/prism/node.rb', line 12294

def comment_targets
  [*lefts, *rest, *rights, *lparen_loc, *rparen_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12284
12285
12286
12287
12288
12289
12290
12291
 
# File 'lib/prism/node.rb', line 12284

def compact_child_nodes
  compact = []
  compact.concat(lefts)
  compact << rest if rest
  compact.concat(rights)
  compact << value
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> MultiWriteNode



12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
 
# File 'lib/prism/node.rb', line 12299

def copy(**params)
  MultiWriteNode.new(
    params.fetch(:lefts) { lefts },
    params.fetch(:rest) { rest },
    params.fetch(:rights) { rights },
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



12316
12317
12318
 
# File 'lib/prism/node.rb', line 12316

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
 
# File 'lib/prism/node.rb', line 12336

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── lefts: #{inspector.list("#{inspector.prefix}│   ", lefts)}"
  if (rest = self.rest).nil?
    inspector << "├── rest: ∅\n"
  else
    inspector << "├── rest:\n"
    inspector << rest.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── rights: #{inspector.list("#{inspector.prefix}│   ", rights)}"
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#lparen ⇒ Object

def lparen: () -> String?



12321
12322
12323
 
# File 'lib/prism/node.rb', line 12321

def lparen
  lparen_loc&.slice
end

#operator ⇒ Object

def operator: () -> String



12331
12332
12333
 
# File 'lib/prism/node.rb', line 12331

def operator
  operator_loc.slice
end

#rparen ⇒ Object

def rparen: () -> String?



12326
12327
12328
 
# File 'lib/prism/node.rb', line 12326

def rparen
  rparen_loc&.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



12368
12369
12370
 
# File 'lib/prism/node.rb', line 12368

def type
  :multi_write_node
end