Class: Prism::InstanceVariableWriteNode

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

Overview

Represents writing to an instance 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) ⇒ InstanceVariableWriteNode

Initialize a new InstanceVariableWriteNode node.



9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
 
# File 'lib/prism/node.rb', line 9144

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 instance variable, which is a ‘@` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

@x = :y       # name `:@x`

@_foo = "bar" # name `@_foo`



9193
9194
9195
 
# File 'lib/prism/node.rb', line 9193

def name
  @name
end

#value ⇒ Object (readonly)

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

@foo = :bar
       ^^^^

@_x = 1234
      ^^^^



9212
9213
9214
 
# File 'lib/prism/node.rb', line 9212

def value
  @value
end

Class Method Details

.type ⇒ Object

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



9240
9241
9242
 
# File 'lib/prism/node.rb', line 9240

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



9246
9247
9248
9249
9250
9251
9252
 
# File 'lib/prism/node.rb', line 9246

def ===(other)
  other.is_a?(InstanceVariableWriteNode) &&
    (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



9156
9157
9158
 
# File 'lib/prism/node.rb', line 9156

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

#child_nodes ⇒ Object Also known as: deconstruct

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



9161
9162
9163
 
# File 'lib/prism/node.rb', line 9161

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



9171
9172
9173
 
# File 'lib/prism/node.rb', line 9171

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9166
9167
9168
 
# File 'lib/prism/node.rb', line 9166

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) -> InstanceVariableWriteNode



9176
9177
9178
 
# File 'lib/prism/node.rb', line 9176

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)
  InstanceVariableWriteNode.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 }



9184
9185
9186
 
# File 'lib/prism/node.rb', line 9184

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



9230
9231
9232
 
# File 'lib/prism/node.rb', line 9230

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the variable name.

@_x = 1
^^^



9199
9200
9201
9202
9203
 
# File 'lib/prism/node.rb', line 9199

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



9225
9226
9227
 
# File 'lib/prism/node.rb', line 9225

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

@x = y
   ^



9218
9219
9220
9221
9222
 
# File 'lib/prism/node.rb', line 9218

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



9235
9236
9237
 
# File 'lib/prism/node.rb', line 9235

def type
  :instance_variable_write_node
end