Class: Prism::CallOrWriteNode

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

Overview

Represents the use of the ‘||=` operator on a call.

foo.bar ||= value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(receiver, call_operator_loc, message_loc, opening_loc, arguments, closing_loc, flags, read_name, write_name, operator_loc, value, location) ⇒ CallOrWriteNode

def initialize: (receiver: Node?, call_operator_loc: Location?, message_loc: Location?, opening_loc: Location?, arguments: ArgumentsNode?, closing_loc: Location?, flags: Integer, read_name: String, write_name: String, operator_loc: Location, value: Node, location: Location) -> void



2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File 'lib/prism/node.rb', line 2332

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



2311
2312
2313
 
# File 'lib/prism/node.rb', line 2311

def arguments
  @arguments
end

#call_operator_loc ⇒ Object (readonly)

attr_reader call_operator_loc: Location?



2302
2303
2304
 
# File 'lib/prism/node.rb', line 2302

def call_operator_loc
  @call_operator_loc
end

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location?



2314
2315
2316
 
# File 'lib/prism/node.rb', line 2314

def closing_loc
  @closing_loc
end

#message_loc ⇒ Object (readonly)

attr_reader message_loc: Location?



2305
2306
2307
 
# File 'lib/prism/node.rb', line 2305

def message_loc
  @message_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



2308
2309
2310
 
# File 'lib/prism/node.rb', line 2308

def opening_loc
  @opening_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



2326
2327
2328
 
# File 'lib/prism/node.rb', line 2326

def operator_loc
  @operator_loc
end

#read_name ⇒ Object (readonly)

attr_reader read_name: String



2320
2321
2322
 
# File 'lib/prism/node.rb', line 2320

def read_name
  @read_name
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Node?



2299
2300
2301
 
# File 'lib/prism/node.rb', line 2299

def receiver
  @receiver
end

#value ⇒ Object (readonly)

attr_reader value: Node



2329
2330
2331
 
# File 'lib/prism/node.rb', line 2329

def value
  @value
end

#write_name ⇒ Object (readonly)

attr_reader write_name: String



2323
2324
2325
 
# File 'lib/prism/node.rb', line 2323

def write_name
  @write_name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



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

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

#call_operator ⇒ Object

def call_operator: () -> String?



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

def call_operator
  call_operator_loc&.slice
end

#child_nodes ⇒ Object Also known as: deconstruct

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



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

def child_nodes
  [receiver, arguments, value]
end

#closing ⇒ Object

def closing: () -> String?



2413
2414
2415
 
# File 'lib/prism/node.rb', line 2413

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

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



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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2358
2359
2360
2361
2362
2363
2364
 
# File 'lib/prism/node.rb', line 2358

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

#copy(**params) ⇒ Object

def copy: (**params) -> CallOrWriteNode



2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/prism/node.rb', line 2372

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



2393
2394
2395
 
# File 'lib/prism/node.rb', line 2393

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
 
# File 'lib/prism/node.rb', line 2432

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  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 << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  if (arguments = self.arguments).nil?
    inspector << "├── arguments: ∅\n"
  else
    inspector << "├── arguments:\n"
    inspector << arguments.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── read_name: #{read_name.inspect}\n"
  inspector << "├── write_name: #{write_name.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?



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

def message
  message_loc&.slice
end

#opening ⇒ Object

def opening: () -> String?



2408
2409
2410
 
# File 'lib/prism/node.rb', line 2408

def opening
  opening_loc&.slice
end

#operator ⇒ Object

def operator: () -> String



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

def operator
  operator_loc.slice
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2418
2419
2420
 
# File 'lib/prism/node.rb', line 2418

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



2474
2475
2476
 
# File 'lib/prism/node.rb', line 2474

def type
  :call_or_write_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2423
2424
2425
 
# File 'lib/prism/node.rb', line 2423

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