Class: Prism::AliasGlobalVariableNode

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

Overview

Represents the use of the ‘alias` keyword to alias a global variable.

alias $foo $bar
^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, new_name, old_name, keyword_loc) ⇒ AliasGlobalVariableNode

Initialize a new AliasGlobalVariableNode node.



321
322
323
324
325
326
327
328
329
 
# File 'lib/prism/node.rb', line 321

def initialize(source, node_id, location, flags, new_name, old_name, keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @new_name = new_name
  @old_name = old_name
  @keyword_loc = keyword_loc
end

Instance Attribute Details

#new_name ⇒ Object (readonly)

Represents the new name of the global variable that can be used after aliasing.

alias $foo $bar
      ^^^^



368
369
370
 
# File 'lib/prism/node.rb', line 368

def new_name
  @new_name
end

#old_name ⇒ Object (readonly)

Represents the old name of the global variable that can be used before aliasing.

alias $foo $bar
           ^^^^



374
375
376
 
# File 'lib/prism/node.rb', line 374

def old_name
  @old_name
end

Class Method Details

.type ⇒ Object

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



408
409
410
 
# File 'lib/prism/node.rb', line 408

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



414
415
416
417
418
419
 
# File 'lib/prism/node.rb', line 414

def ===(other)
  other.is_a?(AliasGlobalVariableNode) &&
    (new_name === other.new_name) &&
    (old_name === other.old_name) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



332
333
334
 
# File 'lib/prism/node.rb', line 332

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



337
338
339
 
# File 'lib/prism/node.rb', line 337

def child_nodes
  [new_name, old_name]
end

#comment_targets ⇒ Object

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



347
348
349
 
# File 'lib/prism/node.rb', line 347

def comment_targets
  [new_name, old_name, keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



342
343
344
 
# File 'lib/prism/node.rb', line 342

def compact_child_nodes
  [new_name, old_name]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, new_name: self.new_name, old_name: self.old_name, keyword_loc: self.keyword_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?new_name: GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode, ?old_name: GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode | SymbolNode | MissingNode, ?keyword_loc: Location) -> AliasGlobalVariableNode



352
353
354
 
# File 'lib/prism/node.rb', line 352

def copy(node_id: self.node_id, location: self.location, flags: self.flags, new_name: self.new_name, old_name: self.old_name, keyword_loc: self.keyword_loc)
  AliasGlobalVariableNode.new(source, node_id, location, flags, new_name, old_name, keyword_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, new_name: GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode, old_name: GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode | SymbolNode | MissingNode, keyword_loc: Location }



360
361
362
 
# File 'lib/prism/node.rb', line 360

def deconstruct_keys(keys)
  { node_id: node_id, location: location, new_name: new_name, old_name: old_name, keyword_loc: keyword_loc }
end

#inspect ⇒ Object

def inspect -> String



398
399
400
 
# File 'lib/prism/node.rb', line 398

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



393
394
395
 
# File 'lib/prism/node.rb', line 393

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

The location of the ‘alias` keyword.

alias $foo $bar
^^^^^



380
381
382
383
384
 
# File 'lib/prism/node.rb', line 380

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

#save_keyword_loc(repository) ⇒ Object

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



388
389
390
 
# File 'lib/prism/node.rb', line 388

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#type ⇒ Object

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



403
404
405
 
# File 'lib/prism/node.rb', line 403

def type
  :alias_global_variable_node
end