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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name) ⇒ InstanceVariableReadNode

Initialize a new InstanceVariableReadNode node.



10248
10249
10250
10251
10252
10253
10254
 
# File 'lib/prism/node.rb', line 10248

def initialize(source, node_id, location, flags, name)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
end

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the instance variable, which is a ‘@` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

@x     # name `:@x`

@_test # name `:@_test`



10294
10295
10296
 
# File 'lib/prism/node.rb', line 10294

def name
  @name
end

Class Method Details

.type ⇒ Object

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



10307
10308
10309
 
# File 'lib/prism/node.rb', line 10307

def self.type
  :instance_variable_read_node
end

Instance Method Details

#===(other) ⇒ Object

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.



10313
10314
10315
10316
 
# File 'lib/prism/node.rb', line 10313

def ===(other)
  other.is_a?(InstanceVariableReadNode) &&
    (name === other.name)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



10257
10258
10259
 
# File 'lib/prism/node.rb', line 10257

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



10262
10263
10264
 
# File 'lib/prism/node.rb', line 10262

def child_nodes
  []
end

#comment_targets ⇒ Object

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



10272
10273
10274
 
# File 'lib/prism/node.rb', line 10272

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10267
10268
10269
 
# File 'lib/prism/node.rb', line 10267

def compact_child_nodes
  []
end

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

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



10277
10278
10279
 
# File 'lib/prism/node.rb', line 10277

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

#deconstruct_keys(keys) ⇒ Object

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



10285
10286
10287
 
# File 'lib/prism/node.rb', line 10285

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

#inspect ⇒ Object

def inspect -> String



10297
10298
10299
 
# File 'lib/prism/node.rb', line 10297

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



10302
10303
10304
 
# File 'lib/prism/node.rb', line 10302

def type
  :instance_variable_read_node
end