Class: Prism::LocalVariableReadNode

Inherits:
PrismNode
  • Object
show all
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
^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, depth, location) ⇒ LocalVariableReadNode

def initialize: (name: Symbol, depth: Integer, location: Location) -> void



9128
9129
9130
9131
9132
 
# File 'lib/prism/node.rb', line 9128

def initialize(name, depth, location)
  @name = name
  @depth = depth
  @location = location
end

Instance Attribute Details

#depth ⇒ Object (readonly)

attr_reader depth: Integer



9125
9126
9127
 
# File 'lib/prism/node.rb', line 9125

def depth
  @depth
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



9122
9123
9124
 
# File 'lib/prism/node.rb', line 9122

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9135
9136
9137
 
# File 'lib/prism/node.rb', line 9135

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

#child_nodes ⇒ Object Also known as: deconstruct

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



9140
9141
9142
 
# File 'lib/prism/node.rb', line 9140

def child_nodes
  []
end

#comment_targets ⇒ Object

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



9150
9151
9152
 
# File 'lib/prism/node.rb', line 9150

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9145
9146
9147
 
# File 'lib/prism/node.rb', line 9145

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> LocalVariableReadNode



9155
9156
9157
9158
9159
9160
9161
 
# File 'lib/prism/node.rb', line 9155

def copy(**params)
  LocalVariableReadNode.new(
    params.fetch(:name) { name },
    params.fetch(:depth) { depth },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



9167
9168
9169
 
# File 'lib/prism/node.rb', line 9167

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



9171
9172
9173
9174
9175
9176
 
# File 'lib/prism/node.rb', line 9171

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "└── depth: #{depth.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



9192
9193
9194
 
# File 'lib/prism/node.rb', line 9192

def type
  :local_variable_read_node
end