Class: Prism::GlobalVariableOperatorWriteNode

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

Overview

Represents assigning to a global variable using an operator that isn’t ‘=`.

$target += value
^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, operator_loc, value, operator, location) ⇒ GlobalVariableOperatorWriteNode

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



6100
6101
6102
6103
6104
6105
6106
6107
 
# File 'lib/prism/node.rb', line 6100

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



6085
6086
6087
 
# File 'lib/prism/node.rb', line 6085

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



6088
6089
6090
 
# File 'lib/prism/node.rb', line 6088

def name_loc
  @name_loc
end

#operator ⇒ Object (readonly)

attr_reader operator: Symbol



6097
6098
6099
 
# File 'lib/prism/node.rb', line 6097

def operator
  @operator
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



6091
6092
6093
 
# File 'lib/prism/node.rb', line 6091

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



6094
6095
6096
 
# File 'lib/prism/node.rb', line 6094

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



6110
6111
6112
 
# File 'lib/prism/node.rb', line 6110

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6115
6116
6117
 
# File 'lib/prism/node.rb', line 6115

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



6125
6126
6127
 
# File 'lib/prism/node.rb', line 6125

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6120
6121
6122
 
# File 'lib/prism/node.rb', line 6120

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> GlobalVariableOperatorWriteNode



6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
 
# File 'lib/prism/node.rb', line 6130

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

#deconstruct_keys(keys) ⇒ Object

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



6145
6146
6147
 
# File 'lib/prism/node.rb', line 6145

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
 
# File 'lib/prism/node.rb', line 6149

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 << "└── operator: #{operator.inspect}\n"
  inspector.to_str
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



6174
6175
6176
 
# File 'lib/prism/node.rb', line 6174

def type
  :global_variable_operator_write_node
end