Represents writing to a global variable.
$foo = 1 ^^^^^^^^
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 = :bar # name `:$foo` $_Test = 123 # name `:$_Test`
The value to write to the global variable. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).
$foo = :bar ^^^^ $-xyz = 123 ^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8043
def initialize(source, node_id, location, flags, name, name_loc, value, operator_loc)
@source = source
@node_id = node_id
@location = location
@flags = flags
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
end
Initialize a new GlobalVariableWriteNode
node.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8151
def self.type
:global_variable_write_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8157
def ===(other)
other.is_a?(GlobalVariableWriteNode) &&
(name === other.name) &&
(name_loc.nil? == other.name_loc.nil?) &&
(value === other.value) &&
(operator_loc.nil? == other.operator_loc.nil?)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8055
def accept(visitor)
visitor.visit_global_variable_write_node(self)
end
def accept: (Visitor
visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8060
def child_nodes
[value]
end
def child_nodes
: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8070
def comment_targets
[name_loc, value, operator_loc] #: Array[Prism::node | Location]
end
def comment_targets
: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8065
def compact_child_nodes
[value]
end
def compact_child_nodes
: () -> Array
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8075
def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
GlobalVariableWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8083
def deconstruct_keys(keys)
{ node_id: node_id, location: location, name: name, name_loc: name_loc, value: value, operator_loc: operator_loc }
end
def deconstruct_keys
: (Array keys) -> { node_id: Integer
, location: Location
, name: Symbol
, name_loc
: Location
, value: Prism::node, operator_loc
: Location
}
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8141
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8098
def name_loc
location = @name_loc
return location if location.is_a?(Location)
@name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the global variable’s name.
$foo = :bar ^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8136
def operator
operator_loc.slice
end
def operator: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8123
def operator_loc
location = @operator_loc
return location if location.is_a?(Location)
@operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the ‘=` operator.
$foo = :bar ^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8106
def save_name_loc(repository)
repository.enter(node_id, :name_loc)
end
Save the name_loc
location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8131
def save_operator_loc(repository)
repository.enter(node_id, :operator_loc)
end
Save the operator_loc
location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 8146
def type
:global_variable_write_node
end
Return a symbol representation of this node type. See ‘Node#type`.