Class: Prism::ClassVariableWriteNode

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

Overview

Represents writing to a class variable.

@@foo = 1
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name, name_loc, value, operator_loc) ⇒ ClassVariableWriteNode

Initialize a new ClassVariableWriteNode node.



4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
 
# File 'lib/prism/node.rb', line 4793

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

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the class variable, which is a ‘@@` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

@@abc = 123     # name `@@abc`

@@_test = :test # name `@@_test`



4849
4850
4851
 
# File 'lib/prism/node.rb', line 4849

def name
  @name
end

#value ⇒ Object (readonly)

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

@@foo = :bar
        ^^^^

@@_xyz = 123
         ^^^



4874
4875
4876
 
# File 'lib/prism/node.rb', line 4874

def value
  @value
end

Class Method Details

.type ⇒ Object

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



4908
4909
4910
 
# File 'lib/prism/node.rb', line 4908

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



4914
4915
4916
4917
4918
4919
4920
 
# File 'lib/prism/node.rb', line 4914

def ===(other)
  other.is_a?(ClassVariableWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



4805
4806
4807
 
# File 'lib/prism/node.rb', line 4805

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



4810
4811
4812
 
# File 'lib/prism/node.rb', line 4810

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



4827
4828
4829
 
# File 'lib/prism/node.rb', line 4827

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



4822
4823
4824
 
# File 'lib/prism/node.rb', line 4822

def compact_child_nodes
  [value]
end

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

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> ClassVariableWriteNode



4832
4833
4834
 
# File 'lib/prism/node.rb', line 4832

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  ClassVariableWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

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



4840
4841
4842
 
# File 'lib/prism/node.rb', line 4840

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

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

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

Yields:



4815
4816
4817
4818
4819
 
# File 'lib/prism/node.rb', line 4815

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

#inspect ⇒ Object

def inspect -> String



4898
4899
4900
 
# File 'lib/prism/node.rb', line 4898

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the variable name.

@@foo = :bar
^^^^^



4855
4856
4857
4858
4859
 
# File 'lib/prism/node.rb', line 4855

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

#operator ⇒ Object

def operator: () -> String



4893
4894
4895
 
# File 'lib/prism/node.rb', line 4893

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

@@foo = :bar
      ^



4880
4881
4882
4883
4884
 
# File 'lib/prism/node.rb', line 4880

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

#save_name_loc(repository) ⇒ Object

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



4863
4864
4865
 
# File 'lib/prism/node.rb', line 4863

def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

#save_operator_loc(repository) ⇒ Object

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



4888
4889
4890
 
# File 'lib/prism/node.rb', line 4888

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



4903
4904
4905
 
# File 'lib/prism/node.rb', line 4903

def type
  :class_variable_write_node
end