class Prism::AliasGlobalVariableNode - Documentation for Ruby 4.0
Description: class Prism::AliasGlobalVariableNode: Represents the use of the `alias` keyword to alias a global variable.
Keywords: ruby,class,Prism::AliasGlobalVariableNode

🔍

No recent searches

# class Prism::AliasGlobalVariableNode

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

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

### Attributes

new_name [R]

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

    alias $foo $bar
          ^^^^

old_name [R]

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

    alias $foo $bar
               ^^^^

### Public Class Methods

new (source, node_id, location, flags, new_name, old_name, keyword_loc)
Source

    # File lib/prism/node.rb, line 328
    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

Initialize a new `AliasGlobalVariableNode` node.

type ()
Source

    # File lib/prism/node.rb, line 423
    def self.type
      :alias_global_variable_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 429
    def ===(other)
      other.is_a?(AliasGlobalVariableNode) &&
        (new_name === other.new_name) &&
        (old_name === other.old_name) &&
        (keyword_loc.nil? == other.keyword_loc.nil?)
    end

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

accept (visitor)
Source

    # File lib/prism/node.rb, line 339
    def accept(visitor)
      visitor.visit_alias_global_variable_node(self)
    end

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

    # File lib/prism/node.rb, line 344
    def child_nodes
      [new_name, old_name]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 362
    def comment_targets
      [new_name, old_name, keyword_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 357
    def compact_child_nodes
      [new_name, old_name]
    end

def `compact_child_nodes`: () -> Array

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)
Source

    # File lib/prism/node.rb, line 367
    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

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`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 375
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, new_name: new_name, old_name: old_name, keyword_loc: keyword_loc }
    end

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` }

each_child_node () { |new_name| ... }
Source

    # File lib/prism/node.rb, line 349
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield new_name
      yield old_name
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

    # File lib/prism/node.rb, line 413
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

keyword ()
Source

    # File lib/prism/node.rb, line 408
    def keyword
      keyword_loc.slice
    end

def keyword: () -> `String`

keyword_loc ()
Source

    # File lib/prism/node.rb, line 395
    def keyword_loc
      location = @keyword_loc
      return location if location.is_a?(Location)
      @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

The location of the `alias` keyword.

    alias $foo $bar
    ^^^^^

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 403
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

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

type ()
Source

    # File lib/prism/node.rb, line 418
    def type
      :alias_global_variable_node
    end

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