123456789_123456789_123456789_123456789_123456789_

Class: Prism::LocalVariableReadNode

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 reading a local variable. Note that this requires that a local variable of the same name has already been written to in the same scope, otherwise it is parsed as a method call.

foo
^^^

Class Method Summary

Instance Attribute Summary

  • #depth readonly

    The number of visible scopes that should be searched to find the origin of this local variable.

  • #name readonly

    The name of the local variable, which is anidentifier.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name, depth) ⇒ LocalVariableReadNode

Initialize a new LocalVariableReadNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, name, depth)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @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 10624



def self.type
  :local_variable_read_node
end


  







Instance Attribute Details



  

    #depth   (readonly)
  



  

    
The number of visible scopes that should be searched to find the origin of this local variable.


foo = 1; foo # depth 0

bar = 2; tap { bar } # 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 10612



attr_reader :depth


  








  

    #name   (readonly)
  



  

    
The name of the local variable, which is anidentifier.


x      # name {:x}

_Test  # name {:_Test}


Note that this can also be an underscore followed by a number for the default block parameters.


_1     # name `:_1`

  



  [ GitHub ]


  

  


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



attr_reader :name


  







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 10630



def ===(other)
  other.is_a?(LocalVariableReadNode) &&
    (name === other.name) &&
    (depth === other.depth)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  []
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  []
end


  








  

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



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?depth: Integer) -> LocalVariableReadNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth)
  LocalVariableReadNode.new(source, node_id, location, flags, name, depth)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, depth: Integer }

  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :local_variable_read_node
end