Class: Prism::LocalVariableOrWriteNode
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, lib/prism/desugar_compiler.rb |
Overview
Represents the use of the ||=
operator for assignment to a local variable.
target ||= value
^^^^^^^^^^^^^^^^
Class Method Summary
- .new(name_loc, operator_loc, value, name, depth, location) ⇒ LocalVariableOrWriteNode constructor
-
.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
-
#depth
readonly
attr_reader depth: Integer.
-
#name
readonly
attr_reader name: Symbol.
-
#name_loc
readonly
attr_reader name_loc:
Location
. -
#operator_loc
readonly
attr_reader operator_loc:
Location
. -
#value
readonly
attr_reader value:
Node
.
Node
- Inherited
Instance Method Summary
-
#accept(visitor)
def accept: (visitor:
Visitor
) -> void. -
#child_nodes
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes
def compact_child_nodes: () -> Array.
-
#copy(**params)
def copy: (**params) ->
LocalVariableOrWriteNode
. -
#deconstruct
Alias for #child_nodes.
- #deconstruct_keys(keys)
-
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String.
-
#operator
def operator: () -> String.
-
#type
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
- #desugar Internal use only
Node
- Inherited
#pretty_print | Similar to inspect, but respects the current level of indentation given by the pretty print object. |
#slice | Slice the location of the node from the source. |
#to_dot | Convert this node into a graphviz dot graph string. |
#deprecated, #newline!, #set_newline_flag |
Constructor Details
.new(name_loc, operator_loc, value, name, depth, location) ⇒ LocalVariableOrWriteNode
# File 'lib/prism/node.rb', line 11009
def initialize(name_loc, operator_loc, value, name, depth, location) @name_loc = name_loc @operator_loc = operator_loc @value = value @name = name @depth = depth @location = location end
Class Method Details
.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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File 'lib/prism/node.rb', line 11099
def self.type :local_variable_or_write_node end
Instance Attribute Details
#depth (readonly)
attr_reader depth: Integer
# File 'lib/prism/node.rb', line 11006
attr_reader :depth
#name (readonly)
attr_reader name: Symbol
# File 'lib/prism/node.rb', line 11003
attr_reader :name
#name_loc (readonly)
attr_reader name_loc: Location
# File 'lib/prism/node.rb', line 10994
attr_reader :name_loc
#operator_loc (readonly)
attr_reader operator_loc: Location
# File 'lib/prism/node.rb', line 10997
attr_reader :operator_loc
#value (readonly)
attr_reader value: Node
# File 'lib/prism/node.rb', line 11000
attr_reader :value
Instance Method Details
#accept(visitor)
def accept: (visitor: Visitor
) -> void
# File 'lib/prism/node.rb', line 11019
def accept(visitor) visitor.visit_local_variable_or_write_node(self) end
#child_nodes Also known as: #deconstruct
def child_nodes: () -> Array[nil | Node]
# File 'lib/prism/node.rb', line 11024
def child_nodes [value] end
#comment_targets
def comment_targets: () -> Array[Node | Location]
# File 'lib/prism/node.rb', line 11034
def comment_targets [name_loc, operator_loc, value] end
#compact_child_nodes
def compact_child_nodes: () -> Array
# File 'lib/prism/node.rb', line 11029
def compact_child_nodes [value] end
#copy(**params)
def copy: (**params) -> LocalVariableOrWriteNode
# File 'lib/prism/node.rb', line 11039
def copy(**params) LocalVariableOrWriteNode.new( params.fetch(:name_loc) { name_loc }, params.fetch(:operator_loc) { operator_loc }, params.fetch(:value) { value }, params.fetch(:name) { name }, params.fetch(:depth) { depth }, params.fetch(:location) { location }, ) end
#deconstruct
Alias for #child_nodes.
# File 'lib/prism/node.rb', line 11051
alias deconstruct child_nodes
#deconstruct_keys(keys)
# File 'lib/prism/node.rb', line 11054
def deconstruct_keys(keys) { name_loc: name_loc, operator_loc: operator_loc, value: value, name: name, depth: depth, location: location } end
#desugar
# File 'lib/prism/desugar_compiler.rb', line 205
def desugar # :nodoc: DesugarOrWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile end
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String
# File 'lib/prism/node.rb', line 11064
def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── name_loc: #{inspector.location(name_loc)}\n" inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n" inspector << "├── value:\n" inspector << inspector.child_node(value, "│ ") inspector << "├── name: #{name.inspect}\n" inspector << "└── depth: #{depth.inspect}\n" inspector.to_str end
#operator
def operator: () -> String
# File 'lib/prism/node.rb', line 11059
def operator operator_loc.slice end
#type
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling [cls1, cls2].include?(node.class)
or putting the node into a case statement and doing case node; when cls1; when cls2; end
. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call #type
, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol
# File 'lib/prism/node.rb', line 11089
def type :local_variable_or_write_node end