123456789_123456789_123456789_123456789_123456789_

Class: Prism::AliasGlobalVariableNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
  • ::Object
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
^^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #new_name readonly

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

  • #old_name readonly

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

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, new_name, old_name, keyword_loc) ⇒ AliasGlobalVariableNode

Initialize a new AliasGlobalVariableNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 229



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 308



def self.type
  :alias_global_variable_node
end


  







Instance Attribute Details



  

    #new_name   (readonly)
  



  

    
Represents the new name of the global variable that can be used after aliasing. This can be either a global variable, a back reference, or a numbered reference.


alias $foo $bar
      ^^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 276



attr_reader :new_name


  








  

    #old_name   (readonly)
  



  

    
Represents the old name of the global variable that could be used before aliasing. This can be either a global variable, a back reference, or a numbered reference.


alias $foo $bar
           ^^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 281



attr_reader :old_name


  







Instance Method Details



  

    #===(other)  
  



  

    
Implements case-equality for the node. This is effectively == but without
comparing the value of locations. Locations are checked only for presence.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 314



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 240



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 245



def child_nodes
  [new_name, old_name]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 255



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 250



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)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?new_name: Prism.node, ?old_name: Prism.node, ?keyword_loc: Location) -> AliasGlobalVariableNode

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 260



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  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 265



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, new_name: Prism.node, old_name: Prism.node, keyword_loc: Location }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 268



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 298



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 293



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
The location of the alias keyword.


alias $foo $bar
^^^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 286



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


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 303



def type
  :alias_global_variable_node
end