123456789_123456789_123456789_123456789_123456789_

Class: Prism::LocalVariableWriteNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Node
Instance Chain:
self, Node
Inherits: Prism::Node
Defined in: lib/prism/node.rb,
prism/api_node.c

Overview

Represents writing to a local variable.

foo = 1
^^^^^^^

Class Method Summary

Node - Inherited

.fields

Returns a list of the fields that exist for this node class.
.type

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain.

Instance Attribute Summary

Node - Inherited

#newline?

Returns true if the node has the newline flag set.
#node_id

A unique identifier for this node.
#static_literal?

Returns true if the node has the static literal flag set.
#flags

An bitset of flags for this node.
#source

A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

Node - Inherited

#accept

Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search

Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column

Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset

Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column

Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset

Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes

Returns an array of child nodes, including nils in the place of optional nodes that were not present.
#comment_targets

Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments

Delegates to the comments of the associated location object.
#compact_child_nodes

Returns an array of child nodes, excluding any nils in the place of optional nodes that were not present.
#deconstruct

Alias for Node#child_nodes.
#each_child_node

With a block given, yields each child node.
#end_character_column

Delegates to the end_character_column of the associated location object.
#end_character_offset

Delegates to the end_character_offset of the associated location object.
#end_column

Delegates to the end_column of the associated location object.
#end_line

Delegates to the end_line of the associated location object.
#end_offset

The end offset of the node in the source.
#inspect

Returns a string representation of the node.
#leading_comments

Delegates to the leading_comments of the associated location object.
#location

A Location instance that represents the location of this node in the source.
#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save

Save this node using a saved source so that it can be retrieved later.
#save_location

Save the location using a saved source so that it can be retrieved later.
#script_lines

Alias for Node#source_lines.
#slice

Slice the location of the node from the source.
#slice_lines

Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines

Returns all of the lines of the source code associated with this node.
#start_character_column

Delegates to the start_character_column of the associated location object.
#start_character_offset

Delegates to the start_character_offset of the associated location object.
#start_column

Delegates to the start_column of the associated location object.
#start_line

Delegates to the start_line of the associated location object.
#start_offset

The start offset of the node in the source.
#to_dot

Convert this node into a graphviz dot graph string.
#trailing_comments

Delegates to the trailing_comments of the associated location object.
#tunnel

Returns a list of nodes that are descendants of this node that contain the given line and column.
#type

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

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

Initialize a new LocalVariableWriteNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 13056



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


  







Class Method Details



  

    .type  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13185



def self.type
  :local_variable_write_node
end


  







Instance Attribute Details



  

    #depth   (readonly)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13122



attr_reader :depth


  








  

    #name   (readonly)
  



  

    

The name of the local variable, which is an href="https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers">github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers identifier.



foo = :bar # name {:foo}

abc = 123  # name `:abc`


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13113



attr_reader :name


  








  

    #value   (readonly)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13151



attr_reader :value


  







Instance Method Details



  

    #===(other)  
  



  

    

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13191



def ===(other)
  other.is_a?(LocalVariableWriteNode) &&
    (name === other.name) &&
    (depth === other.depth) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    

def accept: (Visitor visitor) -> void


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13069



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

def child_nodes: () -> Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13074



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13091



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


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13086



def compact_child_nodes
  [value]
end


  








  

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



  

    

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?depth: Integer, ?name_loc: Location, ?value: Prism.node, ?operator_loc: Location) -> LocalVariableWriteNode


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13096



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


  








  

    #deconstruct  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13101



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, depth: Integer, name_loc: Location, value: Prism.node, operator_loc: Location }


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13104



def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, depth: depth, name_loc: name_loc, value: value, operator_loc: operator_loc }
end


  








  

    #each_child_node {|value| ... } 
  



  

    

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator


  





  
Yields:





  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13079



def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end


  








  

    #inspect  
  



  

    

def inspect -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13175



def inspect
  InspectVisitor.compose(self)
end


  








  

    #name_loc  
  



  

    

The location of the variable name.



foo = :bar
^^^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13128



def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #operator  
  



  

    

def operator: () -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13170



def operator
  operator_loc.slice
end


  








  

    #operator_loc  
  



  

    

The location of the = operator.



x = :y
  ^


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13157



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)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13136



def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end


  








  

    #save_operator_loc(repository)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13165



def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end


  








  

    #type  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13180



def type
  :local_variable_write_node
end