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.



7893
7894
7895
7896
7897
7898
7899
 
# File 'lib/prism/node.rb', line 7893

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`



7939
7940
7941
 
# File 'lib/prism/node.rb', line 7939

def name
  @name
end

Class Method Details

.type ⇒ Object

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



7952
7953
7954
 
# File 'lib/prism/node.rb', line 7952

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.



7958
7959
7960
7961
 
# File 'lib/prism/node.rb', line 7958

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



7902
7903
7904
 
# File 'lib/prism/node.rb', line 7902

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7907
7908
7909
 
# File 'lib/prism/node.rb', line 7907

def child_nodes
  []
end

#comment_targets ⇒ Object

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



7917
7918
7919
 
# File 'lib/prism/node.rb', line 7917

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7912
7913
7914
 
# File 'lib/prism/node.rb', line 7912

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



7922
7923
7924
 
# File 'lib/prism/node.rb', line 7922

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 }



7930
7931
7932
 
# File 'lib/prism/node.rb', line 7930

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

#inspect ⇒ Object

def inspect -> String



7942
7943
7944
 
# File 'lib/prism/node.rb', line 7942

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



7947
7948
7949
 
# File 'lib/prism/node.rb', line 7947

def type
  :global_variable_read_node
end