Class: Prism::GlobalVariableAndWriteNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.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(name, name_loc, operator_loc, value, location) ⇒ GlobalVariableAndWriteNode

def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void



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

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



6854
6855
6856
 
# File 'lib/prism/node.rb', line 6854

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



6857
6858
6859
 
# File 'lib/prism/node.rb', line 6857

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



6860
6861
6862
 
# File 'lib/prism/node.rb', line 6860

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



6863
6864
6865
 
# File 'lib/prism/node.rb', line 6863

def value
  @value
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



6953
6954
6955
 
# File 'lib/prism/node.rb', line 6953

def self.type
  :global_variable_and_write_node
end

Instance Method Details

#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_and_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]
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(**params) ⇒ Object

def copy: (**params) -> GlobalVariableAndWriteNode



6895
6896
6897
6898
6899
6900
6901
6902
6903
 
# File 'lib/prism/node.rb', line 6895

def copy(**params)
  GlobalVariableAndWriteNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



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

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



6919
6920
6921
6922
6923
6924
6925
6926
6927
 
# File 'lib/prism/node.rb', line 6919

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



6914
6915
6916
 
# File 'lib/prism/node.rb', line 6914

def operator
  operator_loc.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



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

def type
  :global_variable_and_write_node
end