Class: Prism::GlobalVariableOrWriteNode

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

Overview

Represents the use of the ‘||=` operator for assignment to a global variable.

$target ||= value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new GlobalVariableOrWriteNode node.



6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
 
# File 'lib/prism/node.rb', line 6863

def initialize(source, node_id, location, flags, name, name_loc, operator_loc, value)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



6908
6909
6910
 
# File 'lib/prism/node.rb', line 6908

def name
  @name
end

#value ⇒ Object (readonly)

attr_reader value: Prism::node



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

def value
  @value
end

Class Method Details

.type ⇒ Object

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



6943
6944
6945
 
# File 'lib/prism/node.rb', line 6943

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



6949
6950
6951
6952
6953
6954
6955
 
# File 'lib/prism/node.rb', line 6949

def ===(other)
  other.is_a?(GlobalVariableOrWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



6875
6876
6877
 
# File 'lib/prism/node.rb', line 6875

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6880
6881
6882
 
# File 'lib/prism/node.rb', line 6880

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



6890
6891
6892
 
# File 'lib/prism/node.rb', line 6890

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6885
6886
6887
 
# File 'lib/prism/node.rb', line 6885

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, operator_loc: self.operator_loc, value: self.value) ⇒ Object

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



6895
6896
6897
 
# File 'lib/prism/node.rb', line 6895

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc, value: self.value)
  GlobalVariableOrWriteNode.new(source, node_id, location, flags, name, name_loc, operator_loc, value)
end

#deconstruct_keys(keys) ⇒ Object

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



6903
6904
6905
 
# File 'lib/prism/node.rb', line 6903

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

#desugar ⇒ Object

:nodoc:



206
207
208
 
# File 'lib/prism/desugar_compiler.rb', line 206

def desugar # :nodoc:
  DesugarOrWriteDefinedNode.new(self, source, :global_variable_read_node, :global_variable_write_node, name: name).compile
end

#inspect ⇒ Object

def inspect -> String



6933
6934
6935
 
# File 'lib/prism/node.rb', line 6933

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

attr_reader name_loc: Location



6911
6912
6913
6914
6915
 
# File 'lib/prism/node.rb', line 6911

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



6928
6929
6930
 
# File 'lib/prism/node.rb', line 6928

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

attr_reader operator_loc: Location



6918
6919
6920
6921
6922
 
# File 'lib/prism/node.rb', line 6918

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

#type ⇒ Object

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



6938
6939
6940
 
# File 'lib/prism/node.rb', line 6938

def type
  :global_variable_or_write_node
end