Class: Prism::ClassVariableReadNode

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

Overview

Represents referencing a class variable.

@@foo
^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ ClassVariableReadNode

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



3695
3696
3697
3698
 
# File 'lib/prism/node.rb', line 3695

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



3692
3693
3694
 
# File 'lib/prism/node.rb', line 3692

def name
  @name
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



3767
3768
3769
 
# File 'lib/prism/node.rb', line 3767

def self.type
  :class_variable_read_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



3701
3702
3703
 
# File 'lib/prism/node.rb', line 3701

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

#child_nodes ⇒ Object Also known as: deconstruct

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



3706
3707
3708
 
# File 'lib/prism/node.rb', line 3706

def child_nodes
  []
end

#comment_targets ⇒ Object

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



3716
3717
3718
 
# File 'lib/prism/node.rb', line 3716

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



3711
3712
3713
 
# File 'lib/prism/node.rb', line 3711

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> ClassVariableReadNode



3721
3722
3723
3724
3725
3726
 
# File 'lib/prism/node.rb', line 3721

def copy(**params)
  ClassVariableReadNode.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]



3732
3733
3734
 
# File 'lib/prism/node.rb', line 3732

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



3737
3738
3739
3740
3741
 
# File 'lib/prism/node.rb', line 3737

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



3757
3758
3759
 
# File 'lib/prism/node.rb', line 3757

def type
  :class_variable_read_node
end