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, equal_loc, block) ⇒ CallNode

Initialize a new CallNode node.



2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/prism/node.rb', line 2608

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

Represents the arguments to the method call. These can be any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo(bar)
    ^^^



2771
2772
2773
 
# File 'lib/prism/node.rb', line 2771

def arguments
  @arguments
end

#block ⇒ Object (readonly)

Represents the block that is being passed to the method.

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



2824
2825
2826
 
# File 'lib/prism/node.rb', line 2824

def block
  @block
end

#name ⇒ Object (readonly)

Represents the name of the method being called.

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



2722
2723
2724
 
# File 'lib/prism/node.rb', line 2722

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
^^^



2691
2692
2693
 
# File 'lib/prism/node.rb', line 2691

def receiver
  @receiver
end

Class Method Details

.type ⇒ Object

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



2862
2863
2864
 
# File 'lib/prism/node.rb', line 2862

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.



2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
 
# File 'lib/prism/node.rb', line 2868

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2625
2626
2627
 
# File 'lib/prism/node.rb', line 2625

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


2672
2673
2674
 
# File 'lib/prism/node.rb', line 2672

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

#call_operator ⇒ Object

def call_operator: () -> String?



2827
2828
2829
 
# File 'lib/prism/node.rb', line 2827

def call_operator
  call_operator_loc&.slice
end

#call_operator_loc ⇒ Object

Represents the location of the call operator.

foo.bar
   ^

foo&.bar
   ^^



2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
 
# File 'lib/prism/node.rb', line 2700

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



2630
2631
2632
 
# File 'lib/prism/node.rb', line 2630

def child_nodes
  [receiver, arguments, block]
end

#closing ⇒ Object

def closing: () -> String?



2842
2843
2844
 
# File 'lib/prism/node.rb', line 2842

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

Represents the location of the right parenthesis.

foo(bar)
       ^



2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/prism/node.rb', line 2777

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]



2644
2645
2646
 
# File 'lib/prism/node.rb', line 2644

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2635
2636
2637
2638
2639
2640
2641
 
# File 'lib/prism/node.rb', line 2635

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



2649
2650
2651
 
# File 'lib/prism/node.rb', line 2649

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

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



2657
2658
2659
 
# File 'lib/prism/node.rb', line 2657

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

#equal ⇒ Object

def equal: () -> String?



2847
2848
2849
 
# File 'lib/prism/node.rb', line 2847

def equal
  equal_loc&.slice
end

#equal_loc ⇒ Object

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

foo.bar = value
        ^

foo[bar] = value
         ^



2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
 
# File 'lib/prism/node.rb', line 2802

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

#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.



334
335
336
 
# File 'lib/prism/node_ext.rb', line 334

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

#ignore_visibility? ⇒ Boolean

def ignore_visibility?: () -> bool

Returns:

  • (Boolean) 


2677
2678
2679
 
# File 'lib/prism/node.rb', line 2677

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

#inspect ⇒ Object

def inspect -> String



2852
2853
2854
 
# File 'lib/prism/node.rb', line 2852

def inspect
  InspectVisitor.compose(self)
end

#message ⇒ Object

def message: () -> String?



2832
2833
2834
 
# File 'lib/prism/node.rb', line 2832

def message
  message_loc&.slice
end

#message_loc ⇒ Object

Represents the location of the message.

foo.bar
    ^^^



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
 
# File 'lib/prism/node.rb', line 2728

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?



2837
2838
2839
 
# File 'lib/prism/node.rb', line 2837

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

Represents the location of the left parenthesis.

foo(bar)
   ^



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
 
# File 'lib/prism/node.rb', line 2749

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) 


2662
2663
2664
 
# File 'lib/prism/node.rb', line 2662

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

#save_call_operator_loc(repository) ⇒ Object

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



2714
2715
2716
 
# File 'lib/prism/node.rb', line 2714

def save_call_operator_loc(repository)
  repository.enter(node_id, :call_operator_loc) unless @call_operator_loc.nil?
end

#save_closing_loc(repository) ⇒ Object

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



2791
2792
2793
 
# File 'lib/prism/node.rb', line 2791

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

#save_equal_loc(repository) ⇒ Object

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



2816
2817
2818
 
# File 'lib/prism/node.rb', line 2816

def save_equal_loc(repository)
  repository.enter(node_id, :equal_loc) unless @equal_loc.nil?
end

#save_message_loc(repository) ⇒ Object

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



2742
2743
2744
 
# File 'lib/prism/node.rb', line 2742

def save_message_loc(repository)
  repository.enter(node_id, :message_loc) unless @message_loc.nil?
end

#save_opening_loc(repository) ⇒ Object

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



2763
2764
2765
 
# File 'lib/prism/node.rb', line 2763

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

#type ⇒ Object

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



2857
2858
2859
 
# File 'lib/prism/node.rb', line 2857

def type
  :call_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2667
2668
2669
 
# File 'lib/prism/node.rb', line 2667

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