Class: Prism::InstanceVariableReadNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents referencing an instance variable.

@foo
^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ InstanceVariableReadNode

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



7456
7457
7458
7459
 
# File 'lib/prism/node.rb', line 7456

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



7453
7454
7455
 
# File 'lib/prism/node.rb', line 7453

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7462
7463
7464
 
# File 'lib/prism/node.rb', line 7462

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7467
7468
7469
 
# File 'lib/prism/node.rb', line 7467

def child_nodes
  []
end

#comment_targets ⇒ Object

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



7477
7478
7479
 
# File 'lib/prism/node.rb', line 7477

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7472
7473
7474
 
# File 'lib/prism/node.rb', line 7472

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> InstanceVariableReadNode



7482
7483
7484
7485
7486
7487
 
# File 'lib/prism/node.rb', line 7482

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

#deconstruct_keys(keys) ⇒ Object

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



7493
7494
7495
 
# File 'lib/prism/node.rb', line 7493

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



7497
7498
7499
7500
7501
 
# File 'lib/prism/node.rb', line 7497

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.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



7517
7518
7519
 
# File 'lib/prism/node.rb', line 7517

def type
  :instance_variable_read_node
end