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.



5878
5879
5880
5881
5882
5883
5884
5885
5886
 
# File 'lib/prism/node.rb', line 5878

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
^^^^^



5936
5937
5938
 
# File 'lib/prism/node.rb', line 5936

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
           ^^^^



5958
5959
5960
 
# File 'lib/prism/node.rb', line 5958

def value
  @value
end

Class Method Details

.type ⇒ Object

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



5976
5977
5978
 
# File 'lib/prism/node.rb', line 5976

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.



5982
5983
5984
5985
5986
5987
 
# File 'lib/prism/node.rb', line 5982

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



5889
5890
5891
 
# File 'lib/prism/node.rb', line 5889

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



5894
5895
5896
 
# File 'lib/prism/node.rb', line 5894

def child_nodes
  [target, value]
end

#comment_targets ⇒ Object

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



5912
5913
5914
 
# File 'lib/prism/node.rb', line 5912

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5907
5908
5909
 
# File 'lib/prism/node.rb', line 5907

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



5917
5918
5919
 
# File 'lib/prism/node.rb', line 5917

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 }



5925
5926
5927
 
# File 'lib/prism/node.rb', line 5925

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

#each_child_node {|target| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



5899
5900
5901
5902
5903
5904
 
# File 'lib/prism/node.rb', line 5899

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield target
  yield value
end

#inspect ⇒ Object

def inspect -> String



5966
5967
5968
 
# File 'lib/prism/node.rb', line 5966

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String



5961
5962
5963
 
# File 'lib/prism/node.rb', line 5961

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

::ABC = 123
      ^



5942
5943
5944
5945
5946
 
# File 'lib/prism/node.rb', line 5942

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.



5950
5951
5952
 
# File 'lib/prism/node.rb', line 5950

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`.



5971
5972
5973
 
# File 'lib/prism/node.rb', line 5971

def type
  :constant_path_write_node
end