Class: Prism::IndexOperatorWriteNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::IndexOperatorWriteNode
Defined in:	lib/prism/node.rb, lib/prism/node_ext.rb, prism/api_node.c

Overview

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

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

Class Method Summary

.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value) ⇒ IndexOperatorWriteNode constructor

Initialize a new IndexOperatorWriteNode node.
.type

Return a symbol representation of this node type.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	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.

Instance Attribute Summary

#arguments readonly

attr_reader arguments: ArgumentsNode?
#attribute_write? ⇒ Boolean readonly

def attribute_write?: () -> bool.
#binary_operator readonly

attr_reader binary_operator: Symbol.
#block readonly

attr_reader block: BlockArgumentNode?
#ignore_visibility? ⇒ Boolean readonly

def ignore_visibility?: () -> bool.
#receiver readonly

attr_reader receiver: Prism.node?
#safe_navigation? ⇒ Boolean readonly

def safe_navigation?: () -> bool.
#value readonly

attr_reader value: Prism.node
#variable_call? ⇒ Boolean readonly

def variable_call?: () -> bool.

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#binary_operator_loc

attr_reader binary_operator_loc: Location.
#call_operator

def call_operator: () -> String?
#call_operator_loc

attr_reader call_operator_loc: Location?
#child_nodes (also: #deconstruct)

def child_nodes: () -> Array.
#closing

def closing: () -> String.
#closing_loc

attr_reader closing_loc: Location.
#comment_targets

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

def compact_child_nodes: () -> Array.
#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)

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

Alias for #child_nodes.
#deconstruct_keys(keys)

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 }
#each_child_node {|receiver| ... }

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

def inspect -> String.
#opening

def opening: () -> String.
#opening_loc

attr_reader opening_loc: Location.
#operator

Returns the binary operator used to modify the receiver.
#operator_loc

Returns the location of the binary operator used to modify the receiver.
#save_binary_operator_loc(repository)

Save the binary_operator_loc location using the given saved source so that it can be retrieved later.
#save_call_operator_loc(repository)

Save the call_operator_loc location using the given saved source so that it can be retrieved later.
#save_closing_loc(repository)

Save the closing_loc location using the given saved source so that it can be retrieved later.
#save_opening_loc(repository)

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

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value) ⇒ `IndexOperatorWriteNode`

Initialize a new IndexOperatorWriteNode node.

[ GitHub ]

# File 'lib/prism/node.rb', line 9884


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

Class Method Details

.type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 10067


def self.type
  :index_operator_write_node
end

Instance Attribute Details

#arguments (readonly)

attr_reader arguments: ArgumentsNode?

[ GitHub ]

# File 'lib/prism/node.rb', line 10004


attr_reader :arguments

#attribute_write? ⇒ `Boolean` (readonly)

def attribute_write?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 9959


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

#binary_operator (readonly)

attr_reader binary_operator: Symbol

[ GitHub ]

# File 'lib/prism/node.rb', line 10023


attr_reader :binary_operator

#block (readonly)

attr_reader block: BlockArgumentNode?

[ GitHub ]

# File 'lib/prism/node.rb', line 10020


attr_reader :block

#ignore_visibility? ⇒ `Boolean` (readonly)

def ignore_visibility?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 9964


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

#receiver (readonly)

attr_reader receiver: Prism.node?

[ GitHub ]

# File 'lib/prism/node.rb', line 9969


attr_reader :receiver

#safe_navigation? ⇒ `Boolean` (readonly)

def safe_navigation?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 9949


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

#value (readonly)

attr_reader value: Prism.node

[ GitHub ]

# File 'lib/prism/node.rb', line 10039


attr_reader :value

#variable_call? ⇒ `Boolean` (readonly)

def variable_call?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 9954


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

Instance Method Details

#===(other)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 10073


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)

def accept: (Visitor visitor) -> void

[ GitHub ]

# File 'lib/prism/node.rb', line 9901


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

#binary_operator_loc

attr_reader binary_operator_loc: Location

[ GitHub ]

# File 'lib/prism/node.rb', line 10026


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

def call_operator: () -> String?

[ GitHub ]

# File 'lib/prism/node.rb', line 10042


def call_operator
  call_operator_loc&.slice
end

#call_operator_loc

attr_reader call_operator_loc: Location?

[ GitHub ]

# File 'lib/prism/node.rb', line 9972


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

def child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 9906


def child_nodes
  [receiver, arguments, block, value]
end

#closing

def closing: () -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 10052


def closing
  closing_loc.slice
end

#closing_loc

attr_reader closing_loc: Location

[ GitHub ]

# File 'lib/prism/node.rb', line 10007


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

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

[ GitHub ]

# File 'lib/prism/node.rb', line 9931


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

def compact_child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 9921


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)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 9936


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

Alias for #child_nodes.

[ GitHub ]

# File 'lib/prism/node.rb', line 9941


alias deconstruct child_nodes

#deconstruct_keys(keys)

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 }

[ GitHub ]

# File 'lib/prism/node.rb', line 9944


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

#each_child_node {|receiver| ... }

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

Yields:

(receiver)

[ GitHub ]

# File 'lib/prism/node.rb', line 9911


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield receiver if receiver
  yield arguments if arguments
  yield block if block
  yield value
end

#inspect

def inspect -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 10057


def inspect
  InspectVisitor.compose(self)
end

#opening

def opening: () -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 10047


def opening
  opening_loc.slice
end

#opening_loc

attr_reader opening_loc: Location

[ GitHub ]

# File 'lib/prism/node.rb', line 9991


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

#operator

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

[ GitHub ]

# File 'lib/prism/node_ext.rb', line 422


def operator
  deprecated("binary_operator")
  binary_operator
end

#operator_loc

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

[ GitHub ]

# File 'lib/prism/node_ext.rb', line 429


def operator_loc
  deprecated("binary_operator_loc")
  binary_operator_loc
end

#save_binary_operator_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 10034


def save_binary_operator_loc(repository)
  repository.enter(node_id, :binary_operator_loc)
end

#save_call_operator_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 9986


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

#save_closing_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 10015


def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_opening_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 9999


def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

#type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 10062


def type
  :index_operator_write_node
end

Class: Prism::IndexOperatorWriteNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value) ⇒ IndexOperatorWriteNode

Class Method Details

.type

Instance Attribute Details

#arguments (readonly)

#attribute_write? ⇒ Boolean (readonly)

#binary_operator (readonly)

#block (readonly)

#ignore_visibility? ⇒ Boolean (readonly)

#receiver (readonly)

#safe_navigation? ⇒ Boolean (readonly)

#value (readonly)

#variable_call? ⇒ Boolean (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#binary_operator_loc

#call_operator

#call_operator_loc

#child_nodes Also known as: #deconstruct

#closing

#closing_loc

#comment_targets

#compact_child_nodes

#deconstruct

#deconstruct_keys(keys)

#each_child_node {|receiver| ... }

#inspect

#opening

#opening_loc

#operator

#operator_loc

#save_binary_operator_loc(repository)

#save_call_operator_loc(repository)

#save_closing_loc(repository)

#save_opening_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, binary_operator, binary_operator_loc, value) ⇒ `IndexOperatorWriteNode`

#attribute_write? ⇒ `Boolean` (readonly)

#ignore_visibility? ⇒ `Boolean` (readonly)

#safe_navigation? ⇒ `Boolean` (readonly)

#variable_call? ⇒ `Boolean` (readonly)