123456789_123456789_123456789_123456789_123456789_

Class: Prism::LocalVariableOrWriteNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
  • ::Object
Defined in: lib/prism/node.rb,
ext/prism/api_node.c,
lib/prism/desugar_compiler.rb

Overview

Represents the use of the {||=} operator for assignment to a local variable.

target ||= value
^^^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #depth readonly

    attr_reader depth: Integer.

  • #name readonly

    attr_reader name: Symbol.

  • #value readonly

    attr_reader value: Prism.node

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name_loc, operator_loc, value, name, depth) ⇒ LocalVariableOrWriteNode

Initialize a new LocalVariableOrWriteNode node.

[ GitHub ]

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

def initialize(source, node_id, location, flags, name_loc, operator_loc, value, name, depth)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
  @name = name
  @depth = depth
end

Class Method Details

.type

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

[ GitHub ]

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

def self.type
  :local_variable_or_write_node
end

Instance Attribute Details

#depth (readonly)

attr_reader depth: Integer

[ GitHub ]

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

attr_reader :depth

#name (readonly)

attr_reader name: Symbol

[ GitHub ]

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

attr_reader :name

#value (readonly)

attr_reader value: Prism.node

[ GitHub ]

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

attr_reader :value

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 10537

def ===(other)
  other.is_a?(LocalVariableOrWriteNode) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value) &&
    (name === other.name) &&
    (depth === other.depth)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

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

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

#child_nodes Also known as: #deconstruct

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

[ GitHub ]

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

def child_nodes
  [value]
end

#comment_targets

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

[ GitHub ]

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

def comment_targets
  [name_loc, operator_loc, value] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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

def compact_child_nodes
  [value]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name_loc: self.name_loc, operator_loc: self.operator_loc, value: self.value, name: self.name, depth: self.depth)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name_loc: Location, ?operator_loc: Location, ?value: Prism.node, ?name: Symbol, ?depth: Integer) -> LocalVariableOrWriteNode

[ GitHub ]

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

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name_loc: self.name_loc, operator_loc: self.operator_loc, value: self.value, name: self.name, depth: self.depth)
  LocalVariableOrWriteNode.new(source, node_id, location, flags, name_loc, operator_loc, value, name, depth)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

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

alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name_loc: Location, operator_loc: Location, value: Prism.node, name: Symbol, depth: Integer }

[ GitHub ]

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

def deconstruct_keys(keys)
  { node_id: node_id, location: location, name_loc: name_loc, operator_loc: operator_loc, value: value, name: name, depth: depth }
end

#desugar

This method is for internal use only.
[ GitHub ]

  
# File 'lib/prism/desugar_compiler.rb', line 243

def desugar # :nodoc:
  DesugarOrWriteNode.new(self, source, :local_variable_read_node, :local_variable_write_node, name: name, depth: depth).compile
end

#inspect

def inspect -> String

[ GitHub ]

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

def inspect
  InspectVisitor.compose(self)
end

#name_loc

attr_reader name_loc: Location

[ GitHub ]

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

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

#operator

def operator: () -> String

[ GitHub ]

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

def operator
  operator_loc.slice
end

#operator_loc

attr_reader operator_loc: Location

[ GitHub ]

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

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

#type

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

[ GitHub ]

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

def type
  :local_variable_or_write_node
end