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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, depth, location) ⇒ LocalVariableReadNode

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



11118
11119
11120
11121
11122
 
# File 'lib/prism/node.rb', line 11118

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

Instance Attribute Details

#depth ⇒ Object (readonly)

attr_reader depth: Integer



11115
11116
11117
 
# File 'lib/prism/node.rb', line 11115

def depth
  @depth
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



11112
11113
11114
 
# File 'lib/prism/node.rb', line 11112

def name
  @name
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



11193
11194
11195
 
# File 'lib/prism/node.rb', line 11193

def self.type
  :local_variable_read_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



11125
11126
11127
 
# File 'lib/prism/node.rb', line 11125

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11130
11131
11132
 
# File 'lib/prism/node.rb', line 11130

def child_nodes
  []
end

#comment_targets ⇒ Object

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



11140
11141
11142
 
# File 'lib/prism/node.rb', line 11140

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11135
11136
11137
 
# File 'lib/prism/node.rb', line 11135

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> LocalVariableReadNode



11145
11146
11147
11148
11149
11150
11151
 
# File 'lib/prism/node.rb', line 11145

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]



11157
11158
11159
 
# File 'lib/prism/node.rb', line 11157

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



11162
11163
11164
11165
11166
11167
 
# File 'lib/prism/node.rb', line 11162

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



11183
11184
11185
 
# File 'lib/prism/node.rb', line 11183

def type
  :local_variable_read_node
end