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.



10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
 
# File 'lib/prism/node.rb', line 10259

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`



10308
10309
10310
 
# File 'lib/prism/node.rb', line 10308

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



10333
10334
10335
 
# File 'lib/prism/node.rb', line 10333

def value
  @value
end

Class Method Details

.type ⇒ Object

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



10367
10368
10369
 
# File 'lib/prism/node.rb', line 10367

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.



10373
10374
10375
10376
10377
10378
10379
 
# File 'lib/prism/node.rb', line 10373

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



10271
10272
10273
 
# File 'lib/prism/node.rb', line 10271

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10276
10277
10278
 
# File 'lib/prism/node.rb', line 10276

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



10286
10287
10288
 
# File 'lib/prism/node.rb', line 10286

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10281
10282
10283
 
# File 'lib/prism/node.rb', line 10281

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



10291
10292
10293
 
# File 'lib/prism/node.rb', line 10291

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 }



10299
10300
10301
 
# File 'lib/prism/node.rb', line 10299

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



10357
10358
10359
 
# File 'lib/prism/node.rb', line 10357

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the variable name.

@_x = 1
^^^



10314
10315
10316
10317
10318
 
# File 'lib/prism/node.rb', line 10314

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



10352
10353
10354
 
# File 'lib/prism/node.rb', line 10352

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

@x = y
   ^



10339
10340
10341
10342
10343
 
# File 'lib/prism/node.rb', line 10339

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.



10322
10323
10324
 
# File 'lib/prism/node.rb', line 10322

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.



10347
10348
10349
 
# File 'lib/prism/node.rb', line 10347

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



10362
10363
10364
 
# File 'lib/prism/node.rb', line 10362

def type
  :instance_variable_write_node
end