class Prism::GlobalVariableWriteNode

Represents writing to a global variable.

$foo = 1
^^^^^^^^

Public Class Methods

new (source, node_id, location, flags, name, name_loc, value, operator_loc)

Source

# File lib/prism/node.rb, line 10942
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.

Public Instance Methods

name → Symbol

Source

# File lib/prism/node.rb, line 11029
def name
  @name
end

The name of the global variable, which is a $ followed by an identifier. Alternatively, it can be one of the special global variables designated by a symbol.

$foo = :bar  # name `:$foo`

$_Test = 123 # name `:$_Test`

value → Node

Source

# File lib/prism/node.rb, line 11064
def value
  @value
end

The value to write to the global variable. It can be any non-void expression.

$foo = :bar
       ^^^^

$-xyz = 123
        ^^^

Locations

Public Instance Methods

name_loc → Location

Source

# File lib/prism/node.rb, line 11041
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
^^^^

operator_loc → Location

Source

# File lib/prism/node.rb, line 11076
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
     ^

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

Source

# File lib/prism/node.rb, line 11011
def self.type
  :global_variable_write_node
end

See Node.type.

Public Instance Methods

accept (visitor)

Source

# File lib/prism/node.rb, line 10965
def accept(visitor)
  visitor.visit_global_variable_write_node(self)
end

See Node.accept.

child_nodes ()

Source

# File lib/prism/node.rb, line 10970
def child_nodes
  [value]
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

Source

# File lib/prism/node.rb, line 10987
def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

See Node.comment_targets.

compact_child_nodes ()

Source

# File lib/prism/node.rb, line 10982
def compact_child_nodes
  [value]
end

See Node.compact_child_nodes.

copy(**fields) → GlobalVariableWriteNode

Source

# File lib/prism/node.rb, line 10995
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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

Alias for: child_nodes

each_child_node () { |value| ... }

Source

# File lib/prism/node.rb, line 10975
def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

See Node.each_child_node.

type ()

Source

# File lib/prism/node.rb, line 11006
def type
  :global_variable_write_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_name_loc (repository)

Source

# File lib/prism/node.rb, line 11050
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.

save_operator_loc (repository)

Source

# File lib/prism/node.rb, line 11085
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.

Slicing

Public Instance Methods

operator → String

Source

# File lib/prism/node.rb, line 11095
def operator
  operator_loc.slice
end

Slice the location of operator_loc from the source.