class Prism::GlobalVariableReadNode

Represents referencing a global variable.

$foo
^^^^

Attributes

name[R]

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`

Public Class Methods

new(source, node_id, location, flags, name) click to toggle source

Initialize a new GlobalVariableReadNode node.

# File prism/node.rb, line 6964
def initialize(source, node_id, location, flags, name)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
end

type() click to toggle source

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

# File prism/node.rb, line 7023
def self.type
  :global_variable_read_node
end

Public Instance Methods

===(other) click to toggle source

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

# File prism/node.rb, line 7029
def ===(other)
  other.is_a?(GlobalVariableReadNode) &&
    (name === other.name)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 6973
def accept(visitor)
  visitor.visit_global_variable_read_node(self)
end

child_nodes() click to toggle source

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

# File prism/node.rb, line 6978
def child_nodes
  []
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 6988
def comment_targets
  [] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 6983
def compact_child_nodes
  []
end

copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name) click to toggle source

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

# File prism/node.rb, line 6993
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()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File prism/node.rb, line 7001
def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name }
end

inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 7013
def inspect
  InspectVisitor.compose(self)
end

type() click to toggle source

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

# File prism/node.rb, line 7018
def type
  :global_variable_read_node
end