Represents a method call, in all of the various forms that can take.
foo ^^^ foo() ^^^^^ +foo ^^^^ foo + bar ^^^^^^^^^ foo.bar ^^^^^^^ foo&.bar ^^^^^^^^
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 ^^^
attr_reader arguments: ArgumentsNode?
attr_reader block: Prism::node?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2462
def initialize(source, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block, location)
@source = source
@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
def initialize: (Integer flags, Prism::node? receiver, Location? call_operator_loc, Symbol name, Location? message_loc, Location? opening_loc, ArgumentsNode? arguments, Location? closing_loc, Prism::node? block, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2659
def self.type
:call_node
end
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
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2665
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
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2477
def accept(visitor)
visitor.visit_call_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2601
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
def attribute_write?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2611
def call_operator
call_operator_loc&.slice
end
def call_operator: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2530
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
attr_reader call_operator_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2482
def child_nodes
[receiver, arguments, block]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2626
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2575
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
attr_reader closing_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2496
def comment_targets
[*receiver, *call_operator_loc, *message_loc, *opening_loc, *arguments, *closing_loc, *block] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2487
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << receiver if receiver
compact << arguments if arguments
compact << block if block
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2501
def copy(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, location: self.location)
CallNode.new(source, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2509
def deconstruct_keys(keys)
{ 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, location: location }
end
def deconstruct_keys: (Array keys) -> { flags: Integer, receiver: Prism::node?, call_operator_loc: Location?, name: Symbol, message_loc: Location?, opening_loc: Location?, arguments: ArgumentsNode?, closing_loc: Location?, block: Prism::node?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node_ext.rb, line 299
def full_message_loc
attribute_write? ? message_loc&.adjoin("=") : message_loc
end
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.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2606
def ignore_visibility?
flags.anybits?(CallNodeFlags::IGNORE_VISIBILITY)
end
def ignore_visibility?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2631
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2616
def message
message_loc&.slice
end
def message: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2546
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
attr_reader message_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2621
def opening
opening_loc&.slice
end
def opening: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2559
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
attr_reader opening_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2591
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
def safe_navigation?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2649
def type
:call_node
end
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
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2596
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
def variable_call?: () -> bool