Class: Prism::ConstantReadNode

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

Overview

Represents referencing a constant.

Foo
^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name) ⇒ ConstantReadNode

Initialize a new ConstantReadNode node.



5638
5639
5640
5641
5642
5643
5644
 
# File 'lib/prism/node.rb', line 5638

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

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the [constant](github.com/ruby/prism/blob/main/docs/parsing_rules.md#constants).

X              # name `:X`

SOME_CONSTANT  # name `:SOME_CONSTANT`



5684
5685
5686
 
# File 'lib/prism/node.rb', line 5684

def name
  @name
end

Class Method Details

.type ⇒ Object

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



5697
5698
5699
 
# File 'lib/prism/node.rb', line 5697

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



5703
5704
5705
5706
 
# File 'lib/prism/node.rb', line 5703

def ===(other)
  other.is_a?(ConstantReadNode) &&
    (name === other.name)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



5647
5648
5649
 
# File 'lib/prism/node.rb', line 5647

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



5652
5653
5654
 
# File 'lib/prism/node.rb', line 5652

def child_nodes
  []
end

#comment_targets ⇒ Object

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



5662
5663
5664
 
# File 'lib/prism/node.rb', line 5662

def comment_targets
  [] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5657
5658
5659
 
# File 'lib/prism/node.rb', line 5657

def compact_child_nodes
  []
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol) -> ConstantReadNode



5667
5668
5669
 
# File 'lib/prism/node.rb', line 5667

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name)
  ConstantReadNode.new(source, node_id, location, flags, name)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol }



5675
5676
5677
 
# File 'lib/prism/node.rb', line 5675

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

#full_name ⇒ Object

Returns the full name of this constant. For example: “Foo”



142
143
144
 
# File 'lib/prism/node_ext.rb', line 142

def full_name
  name.to_s
end

#full_name_parts ⇒ Object

Returns the list of parts for the full name of this constant. For example: [:Foo]



137
138
139
 
# File 'lib/prism/node_ext.rb', line 137

def full_name_parts
  [name]
end

#inspect ⇒ Object

def inspect -> String



5687
5688
5689
 
# File 'lib/prism/node.rb', line 5687

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



5692
5693
5694
 
# File 'lib/prism/node.rb', line 5692

def type
  :constant_read_node
end