123456789_123456789_123456789_123456789_123456789_

Class: Prism::LocalVariableWriteNode

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

Overview

Represents writing to a local variable.

foo = 1
^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #depth readonly

    The number of semantic scopes we have to traverse to find the declaration of this variable.

  • #name readonly

    The name of the local variable, which is anidentifier.

  • #value readonly

    The value to write to the local variable.

Instance Method Summary

Constructor Details

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

Initialize a new LocalVariableWriteNode node.

[ GitHub ] 

  


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



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :local_variable_write_node
end


  







Instance Attribute Details



  

    #depth   (readonly)
  



  

    
The number of semantic scopes we have to traverse to find the declaration of this variable.


foo = 1         # depth 0

tap { foo = 1 } # depth 1


The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the language. For more information, seethe ::Prism documentation.

  



  [ GitHub ]


  

  


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



attr_reader :depth


  








  

    #name   (readonly)
  



  

    
The name of the local variable, which is anidentifier.


foo = :bar # name {:foo}

abc = 123  # name `:abc`

  



  [ GitHub ]


  

  


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



attr_reader :name


  








  

    #value   (readonly)
  



  

    
The value to write to the local variable. It can be anynon-void expression.


foo = :bar
      ^^^^

abc = 1234
      ^^^^


Note that since the name of a local variable is known before the value is parsed, it is valid for a local variable to appear within the value of its own write.


foo = foo

  



  [ GitHub ]


  

  


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



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 10832



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


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  [value]
end


  








  

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



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #name_loc  
  



  

    
The location of the variable name.


foo = :bar
^^^

  



  [ GitHub ]


  

  


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



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 10811



def operator
  operator_loc.slice
end


  








  

    #operator_loc  
  



  

    
The location of the = operator.


x = :y
  ^

  



  [ GitHub ]


  

  


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



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 10821



def type
  :local_variable_write_node
end