Class: Prism::GlobalVariableWriteNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents writing to a global variable.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name, name_loc, value, operator_loc) ⇒ GlobalVariableWriteNode

Initialize a new GlobalVariableWriteNode node.



8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
 
# File 'lib/prism/node.rb', line 8626

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

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 = :bar  # name `:$foo`

$_Test = 123 # name `:$_Test`



8682
8683
8684
 
# File 'lib/prism/node.rb', line 8682

def name
  @name
end

#value ⇒ Object (readonly)

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
        ^^^



8707
8708
8709
 
# File 'lib/prism/node.rb', line 8707

def value
  @value
end

Class Method Details

.type ⇒ Object

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



8741
8742
8743
 
# File 'lib/prism/node.rb', line 8741

def self.type
  :global_variable_write_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.



8747
8748
8749
8750
8751
8752
8753
 
# File 'lib/prism/node.rb', line 8747

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



8638
8639
8640
 
# File 'lib/prism/node.rb', line 8638

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



8643
8644
8645
 
# File 'lib/prism/node.rb', line 8643

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



8660
8661
8662
 
# File 'lib/prism/node.rb', line 8660

def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



8655
8656
8657
 
# File 'lib/prism/node.rb', line 8655

def compact_child_nodes
  [value]
end

#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) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> GlobalVariableWriteNode



8665
8666
8667
 
# File 'lib/prism/node.rb', line 8665

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

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, value: Prism::node, operator_loc: Location }



8673
8674
8675
 
# File 'lib/prism/node.rb', line 8673

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

#each_child_node {|value| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



8648
8649
8650
8651
8652
 
# File 'lib/prism/node.rb', line 8648

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

#inspect ⇒ Object

def inspect -> String



8731
8732
8733
 
# File 'lib/prism/node.rb', line 8731

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the global variable’s name.

$foo = :bar
^^^^



8688
8689
8690
8691
8692
 
# File 'lib/prism/node.rb', line 8688

def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#operator ⇒ Object

def operator: () -> String



8726
8727
8728
 
# File 'lib/prism/node.rb', line 8726

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

$foo = :bar
     ^



8713
8714
8715
8716
8717
 
# File 'lib/prism/node.rb', line 8713

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_name_loc(repository) ⇒ Object

Save the name_loc location using the given saved source so that it can be retrieved later.



8696
8697
8698
 
# File 'lib/prism/node.rb', line 8696

def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

#save_operator_loc(repository) ⇒ Object

Save the operator_loc location using the given saved source so that it can be retrieved later.



8721
8722
8723
 
# File 'lib/prism/node.rb', line 8721

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type ⇒ Object

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



8736
8737
8738
 
# File 'lib/prism/node.rb', line 8736

def type
  :global_variable_write_node
end