Class: Prism::ConstantPathWriteNode

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

Overview

Represents writing to a constant path.

::Foo = 1
^^^^^^^^^

Foo::Bar = 1
^^^^^^^^^^^^

::Foo::Bar = 1
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, target, operator_loc, value) ⇒ ConstantPathWriteNode

Initialize a new ConstantPathWriteNode node.



5498
5499
5500
5501
5502
5503
5504
5505
5506
 
# File 'lib/prism/node.rb', line 5498

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

Instance Attribute Details

#target ⇒ Object (readonly)

A node representing the constant path being written to.

Foo::Bar = 1
^^^^^^^^

::Foo = :abc
^^^^^



5548
5549
5550
 
# File 'lib/prism/node.rb', line 5548

def target
  @target
end

#value ⇒ Object (readonly)

The value to write to the constant path. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

FOO::BAR = :abc
           ^^^^



5570
5571
5572
 
# File 'lib/prism/node.rb', line 5570

def value
  @value
end

Class Method Details

.type ⇒ Object

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



5588
5589
5590
 
# File 'lib/prism/node.rb', line 5588

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



5594
5595
5596
5597
5598
5599
 
# File 'lib/prism/node.rb', line 5594

def ===(other)
  other.is_a?(ConstantPathWriteNode) &&
    (target === other.target) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



5509
5510
5511
 
# File 'lib/prism/node.rb', line 5509

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

#child_nodes ⇒ Object Also known as: deconstruct

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



5514
5515
5516
 
# File 'lib/prism/node.rb', line 5514

def child_nodes
  [target, value]
end

#comment_targets ⇒ Object

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



5524
5525
5526
 
# File 'lib/prism/node.rb', line 5524

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5519
5520
5521
 
# File 'lib/prism/node.rb', line 5519

def compact_child_nodes
  [target, value]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, target: self.target, operator_loc: self.operator_loc, value: self.value) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?target: ConstantPathNode, ?operator_loc: Location, ?value: Prism::node) -> ConstantPathWriteNode



5529
5530
5531
 
# File 'lib/prism/node.rb', line 5529

def copy(node_id: self.node_id, location: self.location, flags: self.flags, target: self.target, operator_loc: self.operator_loc, value: self.value)
  ConstantPathWriteNode.new(source, node_id, location, flags, target, operator_loc, value)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, target: ConstantPathNode, operator_loc: Location, value: Prism::node }



5537
5538
5539
 
# File 'lib/prism/node.rb', line 5537

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

#inspect ⇒ Object

def inspect -> String



5578
5579
5580
 
# File 'lib/prism/node.rb', line 5578

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String



5573
5574
5575
 
# File 'lib/prism/node.rb', line 5573

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

::ABC = 123
      ^



5554
5555
5556
5557
5558
 
# File 'lib/prism/node.rb', line 5554

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

#save_operator_loc(repository) ⇒ Object

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



5562
5563
5564
 
# File 'lib/prism/node.rb', line 5562

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type ⇒ Object

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



5583
5584
5585
 
# File 'lib/prism/node.rb', line 5583

def type
  :constant_path_write_node
end