Class: Prism::GlobalVariableReadNode

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

Overview

Represents referencing a global variable.

$foo
^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new GlobalVariableReadNode node.



8464
8465
8466
8467
8468
8469
8470
 
# File 'lib/prism/node.rb', line 8464

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 global variable, which is a ‘$` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifier). Alternatively, it can be one of the special global variables designated by a symbol.

$foo   # name `:$foo`

$_Test # name `:$_Test`



8516
8517
8518
 
# File 'lib/prism/node.rb', line 8516

def name
  @name
end

Class Method Details

.type ⇒ Object

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



8529
8530
8531
 
# File 'lib/prism/node.rb', line 8529

def self.type
  :global_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.



8535
8536
8537
8538
 
# File 'lib/prism/node.rb', line 8535

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



8473
8474
8475
 
# File 'lib/prism/node.rb', line 8473

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



8478
8479
8480
 
# File 'lib/prism/node.rb', line 8478

def child_nodes
  []
end

#comment_targets ⇒ Object

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



8494
8495
8496
 
# File 'lib/prism/node.rb', line 8494

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



8489
8490
8491
 
# File 'lib/prism/node.rb', line 8489

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) -> GlobalVariableReadNode



8499
8500
8501
 
# File 'lib/prism/node.rb', line 8499

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

#deconstruct_keys(keys) ⇒ Object

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



8507
8508
8509
 
# File 'lib/prism/node.rb', line 8507

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

#each_child_node ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator



8483
8484
8485
8486
 
# File 'lib/prism/node.rb', line 8483

def each_child_node
  return to_enum(:each_child_node) unless block_given?

end

#inspect ⇒ Object

def inspect -> String



8519
8520
8521
 
# File 'lib/prism/node.rb', line 8519

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



8524
8525
8526
 
# File 'lib/prism/node.rb', line 8524

def type
  :global_variable_read_node
end