Class: Prism::GlobalVariableTargetNode

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

Overview

Represents writing to a global variable in a context that doesn’t have an explicit value.

$foo, $bar = baz
^^^^  ^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ GlobalVariableTargetNode

def initialize: (name: Symbol, location: Location) -> void



6362
6363
6364
6365
 
# File 'lib/prism/node.rb', line 6362

def initialize(name, location)
  @name = name
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



6359
6360
6361
 
# File 'lib/prism/node.rb', line 6359

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



6368
6369
6370
 
# File 'lib/prism/node.rb', line 6368

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6373
6374
6375
 
# File 'lib/prism/node.rb', line 6373

def child_nodes
  []
end

#comment_targets ⇒ Object

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



6383
6384
6385
 
# File 'lib/prism/node.rb', line 6383

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6378
6379
6380
 
# File 'lib/prism/node.rb', line 6378

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> GlobalVariableTargetNode



6388
6389
6390
6391
6392
6393
 
# File 'lib/prism/node.rb', line 6388

def copy(**params)
  GlobalVariableTargetNode.new(
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



6399
6400
6401
 
# File 'lib/prism/node.rb', line 6399

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



6403
6404
6405
6406
6407
 
# File 'lib/prism/node.rb', line 6403

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.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



6423
6424
6425
 
# File 'lib/prism/node.rb', line 6423

def type
  :global_variable_target_node
end