Class: Prism::CallAndWriteNode

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

Overview

Represents the use of the ‘&&=` operator on a call.

foo.bar &&= value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value) ⇒ CallAndWriteNode

Initialize a new CallAndWriteNode node.



2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
# File 'lib/prism/node.rb', line 2532

def initialize(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @message_loc = message_loc
  @read_name = read_name
  @write_name = write_name
  @operator_loc = operator_loc
  @value = value
end

Instance Attribute Details

#read_nameObject (readonly)

Represents the name of the method being called.

foo.bar &&= value # read_name `:bar`
    ^^^


2664
2665
2666
# File 'lib/prism/node.rb', line 2664

def read_name
  @read_name
end

#receiverObject (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 &&= value
^^^


2614
2615
2616
# File 'lib/prism/node.rb', line 2614

def receiver
  @receiver
end

#valueObject (readonly)

Represents the value being assigned.

foo.bar &&= value
            ^^^^^


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

def value
  @value
end

#write_nameObject (readonly)

Represents the name of the method being written to.

foo.bar &&= value # write_name `:bar=`
    ^^^


2670
2671
2672
# File 'lib/prism/node.rb', line 2670

def write_name
  @write_name
end

Class Method Details

.typeObject

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



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

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



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

def ===(other)
  other.is_a?(CallAndWriteNode) &&
    (flags === other.flags) &&
    (receiver === other.receiver) &&
    (call_operator_loc.nil? == other.call_operator_loc.nil?) &&
    (message_loc.nil? == other.message_loc.nil?) &&
    (read_name === other.read_name) &&
    (write_name === other.write_name) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2547
2548
2549
# File 'lib/prism/node.rb', line 2547

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

#attribute_write?Boolean

def attribute_write?: () -> bool



2601
2602
2603
# File 'lib/prism/node.rb', line 2601

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

#call_operatorObject

def call_operator: () -> String?



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

def call_operator
  call_operator_loc&.slice
end

#call_operator_locObject

Represents the location of the call operator.

foo.bar &&= value
   ^


2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
# File 'lib/prism/node.rb', line 2620

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_nodesObject Also known as: deconstruct

def child_nodes: () -> Array



2552
2553
2554
# File 'lib/prism/node.rb', line 2552

def child_nodes
  [receiver, value]
end

#comment_targetsObject

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



2573
2574
2575
# File 'lib/prism/node.rb', line 2573

def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value] #: Array[Prism::node | Location]
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array



2565
2566
2567
2568
2569
2570
# File 'lib/prism/node.rb', line 2565

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

#copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?receiver: Prism::node?, ?call_operator_loc: Location?, ?message_loc: Location?, ?read_name: Symbol, ?write_name: Symbol, ?operator_loc: Location, ?value: Prism::node) -> CallAndWriteNode



2578
2579
2580
# File 'lib/prism/node.rb', line 2578

def copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, message_loc: self.message_loc, read_name: self.read_name, write_name: self.write_name, operator_loc: self.operator_loc, value: self.value)
  CallAndWriteNode.new(source, node_id, location, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, receiver: Prism::node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Prism::node }



2586
2587
2588
# File 'lib/prism/node.rb', line 2586

def deconstruct_keys(keys)
  { node_id: node_id, location: location, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator_loc: operator_loc, value: value }
end

#each_child_node {|receiver| ... } ⇒ Object

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

Yields:



2557
2558
2559
2560
2561
2562
# File 'lib/prism/node.rb', line 2557

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield receiver if receiver
  yield value
end

#ignore_visibility?Boolean

def ignore_visibility?: () -> bool



2606
2607
2608
# File 'lib/prism/node.rb', line 2606

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

#inspectObject

def inspect -> String



2710
2711
2712
# File 'lib/prism/node.rb', line 2710

def inspect
  InspectVisitor.compose(self)
end

#messageObject

def message: () -> String?



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

def message
  message_loc&.slice
end

#message_locObject

Represents the location of the message.

foo.bar &&= value
    ^^^


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
# File 'lib/prism/node.rb', line 2642

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

#operatorObject

def operator: () -> String



2705
2706
2707
# File 'lib/prism/node.rb', line 2705

def operator
  operator_loc.slice
end

#operator_locObject

Represents the location of the operator.

foo.bar &&= value
        ^^^


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

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#safe_navigation?Boolean

def safe_navigation?: () -> bool



2591
2592
2593
# File 'lib/prism/node.rb', line 2591

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.



2634
2635
2636
# File 'lib/prism/node.rb', line 2634

def save_call_operator_loc(repository)
  repository.enter(node_id, :call_operator_loc) unless @call_operator_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.



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

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

#save_operator_loc(repository) ⇒ Object

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



2684
2685
2686
# File 'lib/prism/node.rb', line 2684

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#typeObject

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



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

def type
  :call_and_write_node
end

#variable_call?Boolean

def variable_call?: () -> bool



2596
2597
2598
# File 'lib/prism/node.rb', line 2596

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