class Prism::CallOrWriteNode

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

foo.bar ||= value
^^^^^^^^^^^^^^^^^

Attributes

flags[R]

protected attr_reader flags: Integer

read_name[R]

attr_reader read_name: Symbol

receiver[R]

attr_reader receiver: Prism::node?

value[R]

attr_reader value: Prism::node

write_name[R]

attr_reader write_name: Symbol

Public Class Methods

new(source, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location) click to toggle source

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

# File prism/node.rb, line 2872
def initialize(source, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
  @source = source
  @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

type() click to toggle source

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 prism/node.rb, line 3034
def self.type
  :call_or_write_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File prism/node.rb, line 3040
def ===(other)
  other.is_a?(CallOrWriteNode) &&
    (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) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 2886
def accept(visitor)
  visitor.visit_call_or_write_node(self)
end

attribute_write?() click to toggle source

def attribute_write?: () -> bool

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

call_operator() click to toggle source

def call_operator: () -> String?

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

call_operator_loc() click to toggle source

attr_reader call_operator_loc: Location?

# File prism/node.rb, line 2929
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() click to toggle source

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

# File prism/node.rb, line 2891
def child_nodes
  [receiver, value]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 2904
def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 2896
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << receiver if receiver
  compact << value
  compact
end

copy(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, location: self.location) click to toggle source

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

# File prism/node.rb, line 2909
def copy(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, location: self.location)
  CallOrWriteNode.new(source, flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File prism/node.rb, line 2917
def deconstruct_keys(keys)
  { 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, location: location }
end

ignore_visibility?() click to toggle source

def ignore_visibility?: () -> bool

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

inspect() click to toggle source

def inspect -> String

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

message() click to toggle source

def message: () -> String?

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

message_loc() click to toggle source

attr_reader message_loc: Location?

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

operator() click to toggle source

def operator: () -> String

# File prism/node.rb, line 3001
def operator
  operator_loc.slice
end

operator_loc() click to toggle source

attr_reader operator_loc: Location

# File prism/node.rb, line 2961
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?() click to toggle source

def safe_navigation?: () -> bool

# File prism/node.rb, line 2971
def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end

type() click to toggle source

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 prism/node.rb, line 3024
def type
  :call_or_write_node
end

variable_call?() click to toggle source

def variable_call?: () -> bool

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