Class: Prism::CallOperatorWriteNode

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

Overview

Represents the use of an assignment operator on a call.

foo.bar += baz
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value, location) ⇒ CallOperatorWriteNode

def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator: Symbol, operator_loc: Location, value: Node, location: Location) -> void



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'lib/prism/node.rb', line 2371

def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value, location)
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @message_loc = message_loc
  @read_name = read_name
  @write_name = write_name
  @operator = operator
  @operator_loc = operator_loc
  @value = value
  @location = location
end

Instance Attribute Details

#call_operator_loc ⇒ Object (readonly)

attr_reader call_operator_loc: Location?



2350
2351
2352
 
# File 'lib/prism/node.rb', line 2350

def call_operator_loc
  @call_operator_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



2344
2345
2346
 
# File 'lib/prism/node.rb', line 2344

def flags
  @flags
end

#message_loc ⇒ Object (readonly)

attr_reader message_loc: Location?



2353
2354
2355
 
# File 'lib/prism/node.rb', line 2353

def message_loc
  @message_loc
end

#operator ⇒ Object (readonly)

attr_reader operator: Symbol



2362
2363
2364
 
# File 'lib/prism/node.rb', line 2362

def operator
  @operator
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



2365
2366
2367
 
# File 'lib/prism/node.rb', line 2365

def operator_loc
  @operator_loc
end

#read_name ⇒ Object (readonly)

attr_reader read_name: Symbol



2356
2357
2358
 
# File 'lib/prism/node.rb', line 2356

def read_name
  @read_name
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Node?



2347
2348
2349
 
# File 'lib/prism/node.rb', line 2347

def receiver
  @receiver
end

#value ⇒ Object (readonly)

attr_reader value: Node



2368
2369
2370
 
# File 'lib/prism/node.rb', line 2368

def value
  @value
end

#write_name ⇒ Object (readonly)

attr_reader write_name: Symbol



2359
2360
2361
 
# File 'lib/prism/node.rb', line 2359

def write_name
  @write_name
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



2502
2503
2504
 
# File 'lib/prism/node.rb', line 2502

def self.type
  :call_operator_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



2385
2386
2387
 
# File 'lib/prism/node.rb', line 2385

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


2442
2443
2444
 
# File 'lib/prism/node.rb', line 2442

def attribute_write?
  flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end

#call_operator ⇒ Object

def call_operator: () -> String?



2447
2448
2449
 
# File 'lib/prism/node.rb', line 2447

def call_operator
  call_operator_loc&.slice
end

#child_nodes ⇒ Object Also known as: deconstruct

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



2390
2391
2392
 
# File 'lib/prism/node.rb', line 2390

def child_nodes
  [receiver, value]
end

#comment_targets ⇒ Object

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



2403
2404
2405
 
# File 'lib/prism/node.rb', line 2403

def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2395
2396
2397
2398
2399
2400
 
# File 'lib/prism/node.rb', line 2395

def compact_child_nodes
  compact = []
  compact << receiver if receiver
  compact << value
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> CallOperatorWriteNode



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/prism/node.rb', line 2408

def copy(**params)
  CallOperatorWriteNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:call_operator_loc) { call_operator_loc },
    params.fetch(:message_loc) { message_loc },
    params.fetch(:read_name) { read_name },
    params.fetch(:write_name) { write_name },
    params.fetch(:operator) { operator },
    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]



2427
2428
2429
 
# File 'lib/prism/node.rb', line 2427

def deconstruct_keys(keys)
  { flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator: operator, operator_loc: operator_loc, value: value, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
 
# File 'lib/prism/node.rb', line 2457

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  if (receiver = self.receiver).nil?
    inspector << "├── receiver: ∅\n"
  else
    inspector << "├── receiver:\n"
    inspector << receiver.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
  inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
  inspector << "├── read_name: #{read_name.inspect}\n"
  inspector << "├── write_name: #{write_name.inspect}\n"
  inspector << "├── operator: #{operator.inspect}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#message ⇒ Object

def message: () -> String?



2452
2453
2454
 
# File 'lib/prism/node.rb', line 2452

def message
  message_loc&.slice
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2432
2433
2434
 
# File 'lib/prism/node.rb', line 2432

def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
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



2492
2493
2494
 
# File 'lib/prism/node.rb', line 2492

def type
  :call_operator_write_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2437
2438
2439
 
# File 'lib/prism/node.rb', line 2437

def variable_call?
  flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end