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.



6964
6965
6966
6967
6968
6969
6970
 
# File 'lib/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

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`



7010
7011
7012
 
# File 'lib/prism/node.rb', line 7010

def name
  @name
end

Class Method Details

.type ⇒ Object

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



7023
7024
7025
 
# File 'lib/prism/node.rb', line 7023

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.



7029
7030
7031
7032
 
# File 'lib/prism/node.rb', line 7029

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



6973
6974
6975
 
# File 'lib/prism/node.rb', line 6973

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6978
6979
6980
 
# File 'lib/prism/node.rb', line 6978

def child_nodes
  []
end

#comment_targets ⇒ Object

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



6988
6989
6990
 
# File 'lib/prism/node.rb', line 6988

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6983
6984
6985
 
# File 'lib/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) ⇒ Object

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



6993
6994
6995
 
# File 'lib/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_keys(keys) ⇒ Object

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



7001
7002
7003
 
# File 'lib/prism/node.rb', line 7001

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

#inspect ⇒ Object

def inspect -> String



7013
7014
7015
 
# File 'lib/prism/node.rb', line 7013

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



7018
7019
7020
 
# File 'lib/prism/node.rb', line 7018

def type
  :global_variable_read_node
end