123456789_123456789_123456789_123456789_123456789_

Class: Prism::ConstantReadNode

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,
lib/prism/node_ext.rb

Overview

Represents referencing a constant.

Foo
^^^

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name) ⇒ ConstantReadNode

Initialize a new ConstantReadNode node.

[ GitHub ]

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

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

Class Method Details

.type

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

[ GitHub ]

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

def self.type
  :constant_read_node
end

Instance Attribute Details

#name (readonly)

The name of theconstant.

X              # name {:X}

SOME_CONSTANT  # name `:SOME_CONSTANT`
[ GitHub ]

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

attr_reader :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 4799

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

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

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

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

#child_nodes Also known as: #deconstruct

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

[ GitHub ]

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

def child_nodes
  []
end

#comment_targets

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

[ GitHub ]

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

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

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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

def compact_child_nodes
  []
end

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

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

[ GitHub ]

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

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

Alias for #child_nodes.

[ GitHub ]

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

alias deconstruct child_nodes

#deconstruct_keys(keys)

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

[ GitHub ]

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

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

#full_name

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

[ GitHub ]

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

def full_name
  name.to_s
end

#full_name_parts

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

[ GitHub ]

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

def full_name_parts
  [name]
end

#inspect

def inspect -> String

[ GitHub ]

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

def inspect
  InspectVisitor.compose(self)
end

#type

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

[ GitHub ]

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

def type
  :constant_read_node
end