Class: Prism::ClassVariableWriteNode
- Inherits:
-
PrismNode
- Object
- PrismNode
- Prism::ClassVariableWriteNode
- Defined in:
- lib/prism/node.rb,
ext/prism/api_node.c
Overview
Represents writing to a class variable.
@@foo = 1
^^^^^^^^^
Instance Attribute Summary collapse
-
#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).
-
#value ⇒ Object
readonly
The value to write to the class variable.
Class Method Summary collapse
-
.type ⇒ Object
Return a symbol representation of this node type.
Instance Method Summary collapse
-
#===(other) ⇒ Object
Implements case-equality for the node.
-
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array.
-
#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.
-
#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 }.
-
#initialize(source, node_id, location, flags, name, name_loc, value, operator_loc) ⇒ ClassVariableWriteNode
constructor
Initialize a new ClassVariableWriteNode node.
-
#inspect ⇒ Object
def inspect -> String.
-
#name_loc ⇒ Object
The location of the variable name.
-
#operator ⇒ Object
def operator: () -> String.
-
#operator_loc ⇒ Object
The location of the ‘=` operator.
-
#type ⇒ Object
Return a symbol representation of this node type.
Constructor Details
#initialize(source, node_id, location, flags, name, name_loc, value, operator_loc) ⇒ ClassVariableWriteNode
Initialize a new ClassVariableWriteNode node.
3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 |
# File 'lib/prism/node.rb', line 3801 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`
3850 3851 3852 |
# File 'lib/prism/node.rb', line 3850 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
^^^
3869 3870 3871 |
# File 'lib/prism/node.rb', line 3869 def value @value end |
Class Method Details
.type ⇒ Object
Return a symbol representation of this node type. See ‘Node::type`.
3897 3898 3899 |
# File 'lib/prism/node.rb', line 3897 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.
3903 3904 3905 3906 3907 3908 3909 |
# File 'lib/prism/node.rb', line 3903 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
3813 3814 3815 |
# File 'lib/prism/node.rb', line 3813 def accept(visitor) visitor.visit_class_variable_write_node(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array[nil | Node]
3818 3819 3820 |
# File 'lib/prism/node.rb', line 3818 def child_nodes [value] end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
3828 3829 3830 |
# File 'lib/prism/node.rb', line 3828 def comment_targets [name_loc, value, operator_loc] #: Array[Prism::node | Location] end |
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array
3823 3824 3825 |
# File 'lib/prism/node.rb', line 3823 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
3833 3834 3835 |
# File 'lib/prism/node.rb', line 3833 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 }
3841 3842 3843 |
# File 'lib/prism/node.rb', line 3841 def deconstruct_keys(keys) { node_id: node_id, location: location, name: name, name_loc: name_loc, value: value, operator_loc: operator_loc } end |
#inspect ⇒ Object
def inspect -> String
3887 3888 3889 |
# File 'lib/prism/node.rb', line 3887 def inspect InspectVisitor.compose(self) end |
#name_loc ⇒ Object
The location of the variable name.
@@foo = :bar
^^^^^
3856 3857 3858 3859 3860 |
# File 'lib/prism/node.rb', line 3856 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
3882 3883 3884 |
# File 'lib/prism/node.rb', line 3882 def operator operator_loc.slice end |
#operator_loc ⇒ Object
The location of the ‘=` operator.
@@foo = :bar
^
3875 3876 3877 3878 3879 |
# File 'lib/prism/node.rb', line 3875 def operator_loc location = @operator_loc return location if location.is_a?(Location) @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end |
#type ⇒ Object
Return a symbol representation of this node type. See ‘Node#type`.
3892 3893 3894 |
# File 'lib/prism/node.rb', line 3892 def type :class_variable_write_node end |