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.



11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
 
# File 'lib/prism/node.rb', line 11010

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`



11066
11067
11068
 
# File 'lib/prism/node.rb', line 11066

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



11091
11092
11093
 
# File 'lib/prism/node.rb', line 11091

def value
  @value
end

Class Method Details

.type ⇒ Object

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



11125
11126
11127
 
# File 'lib/prism/node.rb', line 11125

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.



11131
11132
11133
11134
11135
11136
11137
 
# File 'lib/prism/node.rb', line 11131

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



11022
11023
11024
 
# File 'lib/prism/node.rb', line 11022

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



11027
11028
11029
 
# File 'lib/prism/node.rb', line 11027

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



11044
11045
11046
 
# File 'lib/prism/node.rb', line 11044

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11039
11040
11041
 
# File 'lib/prism/node.rb', line 11039

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



11049
11050
11051
 
# File 'lib/prism/node.rb', line 11049

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 }



11057
11058
11059
 
# File 'lib/prism/node.rb', line 11057

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:



11032
11033
11034
11035
11036
 
# File 'lib/prism/node.rb', line 11032

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

#inspect ⇒ Object

def inspect -> String



11115
11116
11117
 
# File 'lib/prism/node.rb', line 11115

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the variable name.

@_x = 1
^^^



11072
11073
11074
11075
11076
 
# File 'lib/prism/node.rb', line 11072

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



11110
11111
11112
 
# File 'lib/prism/node.rb', line 11110

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

@x = y
   ^



11097
11098
11099
11100
11101
 
# File 'lib/prism/node.rb', line 11097

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.



11080
11081
11082
 
# File 'lib/prism/node.rb', line 11080

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.



11105
11106
11107
 
# File 'lib/prism/node.rb', line 11105

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



11120
11121
11122
 
# File 'lib/prism/node.rb', line 11120

def type
  :instance_variable_write_node
end