class Prism::IndexOperatorWriteNode - prism: Ruby Standard Library Documentation

# class Prism::IndexOperatorWriteNode

Represents the use of an assignment operator on a call to ‘[]`.

    foo.bar[baz] += value
    ^^^^^^^^^^^^^^^^^^^^^

### Attributes

arguments[R]

attr_reader arguments: `ArgumentsNode`?

binary_operator[R]

attr_reader `binary_operator`: Symbol

block[R]

attr_reader block: `BlockArgumentNode`?

receiver[R]

attr_reader receiver: Prism::node?

value[R]

attr_reader value: Prism::node

### Public Class Methods

new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value) click to toggle source

Initialize a new `IndexOperatorWriteNode` node.

    # File prism/node.rb, line 9214
    def initialize(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @receiver = receiver
      @call_operator_loc = call_operator_loc
      @opening_loc = opening_loc
      @arguments = arguments
      @closing_loc = closing_loc
      @block = block
      @binary_operator = binary_operator
      @binary_operator_loc = binary_operator_loc
      @value = value
    end

type() click to toggle source

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

    # File prism/node.rb, line 9387
    def self.type
      :index_operator_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 9393
    def ===(other)
      other.is_a?(IndexOperatorWriteNode) &&
        (flags === other.flags) &&
        (receiver === other.receiver) &&
        (call_operator_loc.nil? == other.call_operator_loc.nil?) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (arguments === other.arguments) &&
        (closing_loc.nil? == other.closing_loc.nil?) &&
        (block === other.block) &&
        (binary_operator === other.binary_operator) &&
        (binary_operator_loc.nil? == other.binary_operator_loc.nil?) &&
        (value === other.value)
    end

accept(visitor) click to toggle source

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

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

attribute_write?() click to toggle source

def attribute_write?: () -> bool

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

binary_operator_loc() click to toggle source

attr_reader `binary_operator_loc`: `Location`

    # File prism/node.rb, line 9346
    def binary_operator_loc
      location = @binary_operator_loc
      return location if location.is_a?(Location)
      @binary_operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

call_operator() click to toggle source

def `call_operator`: () -> String?

    # File prism/node.rb, line 9362
    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 9292
    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 9236
    def child_nodes
      [receiver, arguments, block, value]
    end

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String

    # File prism/node.rb, line 9372
    def closing
      closing_loc.slice
    end

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`

    # File prism/node.rb, line 9327
    def closing_loc
      location = @closing_loc
      return location if location.is_a?(Location)
      @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

comment_targets() click to toggle source

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

    # File prism/node.rb, line 9251
    def comment_targets
      [*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, binary_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 9241
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << receiver if receiver
      compact << arguments if arguments
      compact << block if block
      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, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block, binary_operator: self.binary_operator, binary_operator_loc: self.binary_operator_loc, value: self.value) click to toggle source

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?receiver: Prism::node?, ?call_operator_loc: `Location`?, ?opening_loc: `Location`, ?arguments: `ArgumentsNode`?, ?closing_loc: `Location`, ?block: `BlockArgumentNode`?, ?binary_operator: Symbol, ?binary_operator_loc: `Location`, ?value: Prism::node) -> `IndexOperatorWriteNode`

    # File prism/node.rb, line 9256
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, receiver: self.receiver, call_operator_loc: self.call_operator_loc, opening_loc: self.opening_loc, arguments: self.arguments, closing_loc: self.closing_loc, block: self.block, binary_operator: self.binary_operator, binary_operator_loc: self.binary_operator_loc, value: self.value)
      IndexOperatorWriteNode.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value)
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def `deconstruct_keys`: (Array keys) -> { node_id: Integer, location: `Location`, receiver: Prism::node?, `call_operator_loc`: `Location`?, `opening_loc`: `Location`, arguments: `ArgumentsNode`?, `closing_loc`: `Location`, block: `BlockArgumentNode`?, `binary_operator`: Symbol, `binary_operator_loc`: `Location`, value: Prism::node }

    # File prism/node.rb, line 9264
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, binary_operator: binary_operator, binary_operator_loc: binary_operator_loc, value: value }
    end

ignore_visibility?() click to toggle source

def ignore_visibility?: () -> bool

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

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String

    # File prism/node.rb, line 9367
    def opening
      opening_loc.slice
    end

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`

    # File prism/node.rb, line 9311
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

operator() click to toggle source

Returns the binary operator used to modify the receiver. This method is deprecated in favor of `binary_operator`.

    # File prism/node_ext.rb, line 419
    def operator
      deprecated("binary_operator")
      binary_operator
    end

operator_loc() click to toggle source

Returns the location of the binary operator used to modify the receiver. This method is deprecated in favor of `binary_operator_loc`.

    # File prism/node_ext.rb, line 426
    def operator_loc
      deprecated("binary_operator_loc")
      binary_operator_loc
    end

save_binary_operator_loc(repository) click to toggle source

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

    # File prism/node.rb, line 9354
    def save_binary_operator_loc(repository)
      repository.enter(node_id, :binary_operator_loc)
    end

save_call_operator_loc(repository) click to toggle source

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

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

save_closing_loc(repository) click to toggle source

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

    # File prism/node.rb, line 9335
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    end

save_opening_loc(repository) click to toggle source

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

    # File prism/node.rb, line 9319
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 9382
    def type
      :index_operator_write_node
    end

variable_call?() click to toggle source

def variable_call?: () -> bool

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