Class: Prism::CallNode

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

Overview

Represents a method call, in all of the various forms that can take.

foo
^^^

foo()
^^^^^

+foo
^^^^

foo + bar
^^^^^^^^^

foo.bar
^^^^^^^

foo&.bar
^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block) ⇒ CallNode

Initialize a new CallNode node.



2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/prism/node.rb', line 2242

def initialize(source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @name = name
  @message_loc = message_loc
  @opening_loc = opening_loc
  @arguments = arguments
  @closing_loc = closing_loc
  @block = block
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



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

def arguments
  @arguments
end

#block ⇒ Object (readonly)

attr_reader block: BlockNode | BlockArgumentNode | nil



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

def block
  @block
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



2340
2341
2342
 
# File 'lib/prism/node.rb', line 2340

def name
  @name
end

#receiver ⇒ Object (readonly)

The object that the method is being called on. This can be either ‘nil` or any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo.bar
^^^

+foo
 ^^^

foo + bar
^^^



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

def receiver
  @receiver
end

Class Method Details

.type ⇒ Object

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



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

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



2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/prism/node.rb', line 2424

def ===(other)
  other.is_a?(CallNode) &&
    (flags === other.flags) &&
    (receiver === other.receiver) &&
    (call_operator_loc.nil? == other.call_operator_loc.nil?) &&
    (name === other.name) &&
    (message_loc.nil? == other.message_loc.nil?) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (arguments === other.arguments) &&
    (closing_loc.nil? == other.closing_loc.nil?) &&
    (block === other.block)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2258
2259
2260
 
# File 'lib/prism/node.rb', line 2258

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


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

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

#call_operator ⇒ Object

def call_operator: () -> String?



2388
2389
2390
 
# File 'lib/prism/node.rb', line 2388

def call_operator
  call_operator_loc&.slice
end

#call_operator_loc ⇒ Object

attr_reader call_operator_loc: Location?



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
 
# File 'lib/prism/node.rb', line 2327

def call_operator_loc
  location = @call_operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @call_operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#child_nodes ⇒ Object Also known as: deconstruct

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



2263
2264
2265
 
# File 'lib/prism/node.rb', line 2263

def child_nodes
  [receiver, arguments, block]
end

#closing ⇒ Object

def closing: () -> String?



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

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



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

def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#comment_targets ⇒ Object

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



2277
2278
2279
 
# File 'lib/prism/node.rb', line 2277

def comment_targets
  [*receiver, *call_operator_loc, *message_loc, *opening_loc, *arguments, *closing_loc, *block] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2268
2269
2270
2271
2272
2273
2274
 
# File 'lib/prism/node.rb', line 2268

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << receiver if receiver
  compact << arguments if arguments
  compact << block if block
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, name: self.name, message_loc: self.message_loc, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?receiver: Prism::node?, ?call_operator_loc: Location?, ?name: Symbol, ?message_loc: Location?, ?opening_loc: Location?, ?arguments: ArgumentsNode?, ?closing_loc: Location?, ?block: BlockNode | BlockArgumentNode | nil) -> CallNode



2282
2283
2284
 
# File 'lib/prism/node.rb', line 2282

def copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, name: self.name, message_loc: self.message_loc, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block)
  CallNode.new(source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, receiver: Prism::node?, call_operator_loc: Location?, name: Symbol, message_loc: Location?, opening_loc: Location?, arguments: ArgumentsNode?, closing_loc: Location?, block: BlockNode | BlockArgumentNode | nil }



2290
2291
2292
 
# File 'lib/prism/node.rb', line 2290

def deconstruct_keys(keys)
  { node_id: node_id, location: location, receiver: receiver, call_operator_loc: call_operator_loc, name: name, message_loc: message_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block }
end

#full_message_loc ⇒ Object

When a call node has the attribute_write flag set, it means that the call is using the attribute write syntax. This is either a method call to []= or a method call to a method that ends with =. Either way, the = sign is present in the source.

Prism returns the message_loc without the = sign attached, because there can be any amount of space between the message and the = sign. However, sometimes you want the location of the full message including the inner space and the = sign. This method provides that.



331
332
333
 
# File 'lib/prism/node_ext.rb', line 331

def full_message_loc
  attribute_write? ? message_loc&.adjoin("=") : message_loc
end

#ignore_visibility? ⇒ Boolean

def ignore_visibility?: () -> bool

Returns:

  • (Boolean) 


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

def ignore_visibility?
  flags.anybits?(CallNodeFlags::IGNORE_VISIBILITY)
end

#inspect ⇒ Object

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#message ⇒ Object

def message: () -> String?



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

def message
  message_loc&.slice
end

#message_loc ⇒ Object

attr_reader message_loc: Location?



2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/prism/node.rb', line 2343

def message_loc
  location = @message_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @message_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#opening ⇒ Object

def opening: () -> String?



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

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



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

def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2295
2296
2297
 
# File 'lib/prism/node.rb', line 2295

def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end

#type ⇒ Object

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



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

def type
  :call_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


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

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