class Prism::LocalVariableWriteNode

Represents writing to a local variable.

foo = 1
^^^^^^^

The line event for a statement is emitted where its first instruction is compiled, so nodes whose first instruction comes from a sub-expression delegate their newline flag to that sub-expression: assignments to their value, calls to their receiver, and array, hash, and interpolated string literals to their first element. Static literals are the exception: they are compiled to a single instruction on the first line of the literal, so they do not delegate.

Public Class Methods

new (source, node_id, location, flags, name, depth, name_loc, value, operator_loc)

(Source source, Integer node_id, Location location, Integer flags, Symbol name, Integer depth, Location name_loc, Prism::node value, Location operator_loc) → void

Source

# File lib/prism/node.rb, line 22037
def initialize(source, node_id, location, flags, name, depth, name_loc, value, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @depth = depth
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end

Initialize a new LocalVariableWriteNode node.

Public Instance Methods

depth → Integer

() → Integer

Source

# File lib/prism/node.rb, line 22175
def depth
  @depth
end

The number of semantic scopes we have to traverse to find the declaration of this variable.

foo = 1         # depth 0

tap { foo = 1 } # depth 1

The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the language. For more information, see the Prism documentation.

name → Symbol

() → Symbol

Source

# File lib/prism/node.rb, line 22159
def name
  @name
end

The name of the local variable, which is an identifier.

foo = :bar # name `:foo`

abc = 123  # name `:abc`

value → Node

() → Prism::node

Source

# File lib/prism/node.rb, line 22220
def value
  @value
end

The value to write to the local variable. It can be any non-void expression.

foo = :bar
      ^^^^

abc = 1234
      ^^^^

Note that since the name of a local variable is known before the value is parsed, it is valid for a local variable to appear within the value of its own write.

foo = foo

Locations

Public Instance Methods

name_loc → Location

() → Location

Source

# File lib/prism/node.rb, line 22189
def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The Location of the variable name.

foo = :bar
^^^

operator_loc → Location

() → Location

Source

# File lib/prism/node.rb, line 22234
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The Location of the = operator.

x = :y
  ^

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

() → :local_variable_write_node

Source

# File lib/prism/node.rb, line 22138
def self.type
  :local_variable_write_node
end

See Node.type.

Public Instance Methods

accept (visitor)

(_Visitor visitor) → untyped

Source

# File lib/prism/node.rb, line 22063
def accept(visitor)
  visitor.visit_local_variable_write_node(self)
end

See Node.accept.

child_nodes ()

() → Array[node?]

Source

# File lib/prism/node.rb, line 22070
def child_nodes
  [value]
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

() → Array[node | Location]

Source

# File lib/prism/node.rb, line 22094
def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

See Node.comment_targets.

compact_child_nodes ()

() → Array[node]

Source

# File lib/prism/node.rb, line 22087
def compact_child_nodes
  [value]
end

See Node.compact_child_nodes.

copy(**fields) → LocalVariableWriteNode

(?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?depth: Integer, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) → LocalVariableWriteNode

Source

# File lib/prism/node.rb, line 22104
def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  LocalVariableWriteNode.new(source, node_id, location, flags, name, depth, name_loc, value, operator_loc)
end

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

() → Array[node?]

Alias for: child_nodes

each_child_node () { |value| ... }

() → Enumerator[node, void]
() { (node) → void } → void

Source

# File lib/prism/node.rb, line 22078
def each_child_node(&blk)
  return to_enum(:each_child_node) unless block_given?

  yield value
end

See Node.each_child_node.

type ()

() → :local_variable_write_node

Source

# File lib/prism/node.rb, line 22131
def type
  :local_variable_write_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_name_loc (repository)

(_Repository repository) → Relocation::Entry

Source

# File lib/prism/node.rb, line 22200
def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

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

save_operator_loc (repository)

(_Repository repository) → Relocation::Entry

Source

# File lib/prism/node.rb, line 22245
def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

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

Slicing

Public Instance Methods

operator → String

() → String

Source

# File lib/prism/node.rb, line 22257
def operator
  operator_loc.slice
end

Slice the location of operator_loc from the source.