Class: Prism::CallTargetNode

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

Overview

Represents assigning to a method call.

foo.bar, = 1
^^^^^^^

begin
rescue => foo.bar
          ^^^^^^^
end

for foo.bar in baz do end
    ^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, receiver, call_operator_loc, name, message_loc, location) ⇒ CallTargetNode

def initialize: (flags: Integer, receiver: Node, call_operator_loc: Location, name: Symbol, message_loc: Location, location: Location) -> void



2704
2705
2706
2707
2708
2709
2710
2711
 
# File 'lib/prism/node.rb', line 2704

def initialize(flags, receiver, call_operator_loc, name, message_loc, location)
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @name = name
  @message_loc = message_loc
  @location = location
end

Instance Attribute Details

#call_operator_loc ⇒ Object (readonly)

attr_reader call_operator_loc: Location



2695
2696
2697
 
# File 'lib/prism/node.rb', line 2695

def call_operator_loc
  @call_operator_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



2689
2690
2691
 
# File 'lib/prism/node.rb', line 2689

def flags
  @flags
end

#message_loc ⇒ Object (readonly)

attr_reader message_loc: Location



2701
2702
2703
 
# File 'lib/prism/node.rb', line 2701

def message_loc
  @message_loc
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



2698
2699
2700
 
# File 'lib/prism/node.rb', line 2698

def name
  @name
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Node



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

def receiver
  @receiver
end

Class Method Details

.type ⇒ Object

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



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

def self.type
  :call_target_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



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

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


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

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

#call_operator ⇒ Object

def call_operator: () -> String



2769
2770
2771
 
# File 'lib/prism/node.rb', line 2769

def call_operator
  call_operator_loc.slice
end

#child_nodes ⇒ Object Also known as: deconstruct

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



2719
2720
2721
 
# File 'lib/prism/node.rb', line 2719

def child_nodes
  [receiver]
end

#comment_targets ⇒ Object

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



2729
2730
2731
 
# File 'lib/prism/node.rb', line 2729

def comment_targets
  [receiver, call_operator_loc, message_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2724
2725
2726
 
# File 'lib/prism/node.rb', line 2724

def compact_child_nodes
  [receiver]
end

#copy(**params) ⇒ Object

def copy: (**params) -> CallTargetNode



2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
 
# File 'lib/prism/node.rb', line 2734

def copy(**params)
  CallTargetNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:call_operator_loc) { call_operator_loc },
    params.fetch(:name) { name },
    params.fetch(:message_loc) { message_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



2749
2750
2751
 
# File 'lib/prism/node.rb', line 2749

def deconstruct_keys(keys)
  { flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, name: name, message_loc: message_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



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

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── receiver:\n"
  inspector << inspector.child_node(receiver, "│   ")
  inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
  inspector << "├── name: #{name.inspect}\n"
  inspector << "└── message_loc: #{inspector.location(message_loc)}\n"
  inspector.to_str
end

#message ⇒ Object

def message: () -> String



2774
2775
2776
 
# File 'lib/prism/node.rb', line 2774

def message
  message_loc.slice
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


2754
2755
2756
 
# File 'lib/prism/node.rb', line 2754

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



2805
2806
2807
 
# File 'lib/prism/node.rb', line 2805

def type
  :call_target_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


2759
2760
2761
 
# File 'lib/prism/node.rb', line 2759

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