class Prism::CallNode - Documentation for Ruby 4.0
Description: class Prism::CallNode: Represents a method call, in all of the various forms that can take. foo ^^^ foo() ^^^^^ +foo ^^^^ foo + bar ^^^^^^^^^
Keywords: ruby,class,Prism::CallNode

🔍

No recent searches

# class Prism::CallNode

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

    foo
    ^^^

    foo()
    ^^^^^

    +foo
    ^^^^

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

    foo.bar
    ^^^^^^^

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

### Attributes

arguments [R]

Represents the arguments to the method call. These can be any non-void expressions.

    foo(bar)
        ^^^

block [R]

Represents the block that is being passed to the method.

    foo { |a| a }
        ^^^^^^^^^

name [R]

Represents the name of the method being called.

    foo.bar # name `:foo`
    ^^^

receiver [R]

The object that the method is being called on. This can be either `nil` or any non-void expression.

    foo.bar
    ^^^

    +foo
     ^^^

    foo + bar
    ^^^

### Public Class Methods

new (source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, equal_loc, block)
Source

    # File lib/prism/node.rb, line 2752
    def initialize(source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, equal_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
      @equal_loc = equal_loc
      @block = block
    end

Initialize a new `CallNode` node.

type ()
Source

    # File lib/prism/node.rb, line 3015
    def self.type
      :call_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 3021
    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?) &&
        (equal_loc.nil? == other.equal_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.

accept (visitor)
Source

    # File lib/prism/node.rb, line 2769
    def accept(visitor)
      visitor.visit_call_node(self)
    end

def accept: (`Visitor` visitor) -> void

attribute_write? ()
Source

    # File lib/prism/node.rb, line 2825
    def attribute_write?
      flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
    end

def attribute_write?: () -> bool

call_operator ()
Source

    # File lib/prism/node.rb, line 2980
    def call_operator
      call_operator_loc&.slice
    end

def `call_operator`: () -> `String`?

call_operator_loc ()
Source

    # File lib/prism/node.rb, line 2853
    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

Represents the location of the call operator.

    foo.bar
       ^

    foo&.bar
       ^^

child_nodes ()
Source

    # File lib/prism/node.rb, line 2774
    def child_nodes
      [receiver, arguments, block]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

    # File lib/prism/node.rb, line 2995
    def closing
      closing_loc&.slice
    end

def closing: () -> `String`?

closing_loc ()
Source

    # File lib/prism/node.rb, line 2930
    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

Represents the location of the right parenthesis.

    foo(bar)
           ^

comment_targets ()
Source

    # File lib/prism/node.rb, line 2797
    def comment_targets
      [*receiver, *call_operator_loc, *message_loc, *opening_loc, *arguments, *closing_loc, *equal_loc, *block] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 2788
    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

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, equal_loc: self.equal_loc, block: self.block)
Source

    # File lib/prism/node.rb, line 2802
    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, equal_loc: self.equal_loc, block: self.block)
      CallNode.new(source, node_id, location, flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, equal_loc, block)
    end

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`?, ?equal_loc: `Location`?, ?block: `BlockNode` | `BlockArgumentNode` | nil) -> `CallNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 2810
    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, equal_loc: equal_loc, block: block }
    end

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`?, `equal_loc`: `Location`?, block: `BlockNode` | `BlockArgumentNode` | nil }

each_child_node () { |receiver| ... }
Source

    # File lib/prism/node.rb, line 2779
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield receiver if receiver
      yield arguments if arguments
      yield block if block
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

equal ()
Source

    # File lib/prism/node.rb, line 3000
    def equal
      equal_loc&.slice
    end

def equal: () -> `String`?

equal_loc ()
Source

    # File lib/prism/node.rb, line 2955
    def equal_loc
      location = @equal_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @equal_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

Represents the location of the equal sign, in the case that this is an attribute write.

    foo.bar = value
            ^

    foo[bar] = value
             ^

full_message_loc ()
Source

    # File lib/prism/node_ext.rb, line 334
    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.

ignore_visibility? ()
Source

    # File lib/prism/node.rb, line 2830
    def ignore_visibility?
      flags.anybits?(CallNodeFlags::IGNORE_VISIBILITY)
    end

def ignore_visibility?: () -> bool

inspect ()
Source

    # File lib/prism/node.rb, line 3005
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

message ()
Source

    # File lib/prism/node.rb, line 2985
    def message
      message_loc&.slice
    end

def message: () -> `String`?

message_loc ()
Source

    # File lib/prism/node.rb, line 2881
    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

Represents the location of the message.

    foo.bar
        ^^^

opening ()
Source

    # File lib/prism/node.rb, line 2990
    def opening
      opening_loc&.slice
    end

def opening: () -> `String`?

opening_loc ()
Source

    # File lib/prism/node.rb, line 2902
    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

Represents the location of the left parenthesis. foo(bar) ^

save_call_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 2867
    def save_call_operator_loc(repository)
      repository.enter(node_id, :call_operator_loc) unless @call_operator_loc.nil?
    end

Save the `call_operator_loc` location using the given saved source so that it can be retrieved later.

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 2944
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

save_equal_loc (repository)
Source

    # File lib/prism/node.rb, line 2969
    def save_equal_loc(repository)
      repository.enter(node_id, :equal_loc) unless @equal_loc.nil?
    end

Save the `equal_loc` location using the given saved source so that it can be retrieved later.

save_message_loc (repository)
Source

    # File lib/prism/node.rb, line 2895
    def save_message_loc(repository)
      repository.enter(node_id, :message_loc) unless @message_loc.nil?
    end

Save the `message_loc` location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 2916
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

type ()
Source

    # File lib/prism/node.rb, line 3010
    def type
      :call_node
    end

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

variable_call? ()
Source

    # File lib/prism/node.rb, line 2820
    def variable_call?
      flags.anybits?(CallNodeFlags::VARIABLE_CALL)
    end

def variable_call?: () -> bool