123456789_123456789_123456789_123456789_123456789_

Class: Prism::ClassVariableWriteNode

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 writing to a class variable.

@@foo = 1
^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #name readonly

    The name of the class variable, which is a @@ followed by anidentifier.

  • #value readonly

    The value to write to the class variable.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name, name_loc, value, operator_loc) ⇒ ClassVariableWriteNode

Initialize a new ClassVariableWriteNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, name, name_loc, value, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :class_variable_write_node
end


  







Instance Attribute Details



  

    #name   (readonly)
  



  

    
The name of the class variable, which is a @@ followed by anidentifier.


@@abc = 123     # name {@@abc}

@@_test = :test # name `@@_test`

  



  [ GitHub ]


  

  


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



attr_reader :name


  








  

    #value   (readonly)
  



  

    
The value to write to the class variable. This can be anynon-void expression.


@@foo = :bar
        ^^^^

@@_xyz = 123
         ^^^

  



  [ GitHub ]


  

  


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



attr_reader :value


  







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 3824



def ===(other)
  other.is_a?(ClassVariableWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  [value]
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism.node, ?operator_loc: Location) -> ClassVariableWriteNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  ClassVariableWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, value: Prism.node, operator_loc: Location }

  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #name_loc  
  



  

    
The location of the variable name.


@@foo = :bar
^^^^^

  



  [ GitHub ]


  

  


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



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


  








  

    #operator  
  



  

    
def operator: () -> String

  



  [ GitHub ]


  

  


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



def operator
  operator_loc.slice
end


  








  

    #operator_loc  
  



  

    
The location of the = operator.


@@foo = :bar
      ^

  



  [ GitHub ]


  

  


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



def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_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 3813



def type
  :class_variable_write_node
end