Class: Prism::GlobalVariableReadNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::GlobalVariableReadNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents referencing a global variable.

$foo
^^^^

Instance Attribute Summary

• #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).

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

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

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  def compact_child_nodes: () -> Array.

• #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.

• #deconstruct_keys(keys) ⇒ Object

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

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

  Initialize a new GlobalVariableReadNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

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

Initialize a new GlobalVariableReadNode node.

# File 'lib/prism/node.rb', line 6927

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`

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

def name
  @name
end

Class Method Details

.type ⇒ Object

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

# File 'lib/prism/node.rb', line 6986

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.

# File 'lib/prism/node.rb', line 6992

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void

# File 'lib/prism/node.rb', line 6936

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

#child_nodes ⇒ Object Also known as: deconstruct

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

# File 'lib/prism/node.rb', line 6941

def child_nodes
  []
end

#comment_targets ⇒ Object

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

# File 'lib/prism/node.rb', line 6951

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

# File 'lib/prism/node.rb', line 6946

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

# File 'lib/prism/node.rb', line 6956

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 }

# File 'lib/prism/node.rb', line 6964

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

#inspect ⇒ Object

def inspect -> String

# File 'lib/prism/node.rb', line 6976

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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

# File 'lib/prism/node.rb', line 6981

def type
  :global_variable_read_node
end