Class: Prism::EmbeddedVariableNode
- Inherits:
-
PrismNode
- Object
- PrismNode
- Prism::EmbeddedVariableNode
- Defined in:
- lib/prism/node.rb,
ext/prism/api_node.c
Overview
Represents an interpolated variable.
"foo #@bar"
^^^^^
Instance Attribute Summary collapse
-
#operator_loc ⇒ Object
readonly
attr_reader operator_loc: Location.
-
#variable ⇒ Object
readonly
attr_reader variable: Node.
Class Method Summary collapse
-
.type ⇒ Object
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 Method Summary collapse
-
#accept(visitor) ⇒ Object
def accept: (visitor: Visitor) -> void.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array.
-
#copy(**params) ⇒ Object
def copy: (**params) -> EmbeddedVariableNode.
- #deconstruct_keys(keys) ⇒ Object
-
#initialize(operator_loc, variable, location) ⇒ EmbeddedVariableNode
constructor
def initialize: (operator_loc: Location, variable: Node, location: Location) -> void.
-
#inspect(inspector = NodeInspector.new) ⇒ Object
def inspect(inspector: NodeInspector) -> String.
-
#operator ⇒ Object
def operator: () -> String.
-
#type ⇒ Object
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
Constructor Details
#initialize(operator_loc, variable, location) ⇒ EmbeddedVariableNode
def initialize: (operator_loc: Location, variable: Node, location: Location) -> void
5802 5803 5804 5805 5806 |
# File 'lib/prism/node.rb', line 5802 def initialize(operator_loc, variable, location) @operator_loc = operator_loc @variable = variable @location = location end |
Instance Attribute Details
#operator_loc ⇒ Object (readonly)
attr_reader operator_loc: Location
5796 5797 5798 |
# File 'lib/prism/node.rb', line 5796 def operator_loc @operator_loc end |
#variable ⇒ Object (readonly)
attr_reader variable: Node
5799 5800 5801 |
# File 'lib/prism/node.rb', line 5799 def variable @variable end |
Class Method Details
.type ⇒ Object
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
5883 5884 5885 |
# File 'lib/prism/node.rb', line 5883 def self.type :embedded_variable_node end |
Instance Method Details
#accept(visitor) ⇒ Object
def accept: (visitor: Visitor) -> void
5809 5810 5811 |
# File 'lib/prism/node.rb', line 5809 def accept(visitor) visitor.(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array[nil | Node]
5814 5815 5816 |
# File 'lib/prism/node.rb', line 5814 def child_nodes [variable] end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
5824 5825 5826 |
# File 'lib/prism/node.rb', line 5824 def comment_targets [operator_loc, variable] end |
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array
5819 5820 5821 |
# File 'lib/prism/node.rb', line 5819 def compact_child_nodes [variable] end |
#copy(**params) ⇒ Object
def copy: (**params) -> EmbeddedVariableNode
5829 5830 5831 5832 5833 5834 5835 |
# File 'lib/prism/node.rb', line 5829 def copy(**params) EmbeddedVariableNode.new( params.fetch(:operator_loc) { operator_loc }, params.fetch(:variable) { variable }, params.fetch(:location) { location }, ) end |
#deconstruct_keys(keys) ⇒ Object
5841 5842 5843 |
# File 'lib/prism/node.rb', line 5841 def deconstruct_keys(keys) { operator_loc: operator_loc, variable: variable, location: location } end |
#inspect(inspector = NodeInspector.new) ⇒ Object
def inspect(inspector: NodeInspector) -> String
5851 5852 5853 5854 5855 5856 5857 |
# File 'lib/prism/node.rb', line 5851 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n" inspector << "└── variable:\n" inspector << inspector.child_node(variable, " ") inspector.to_str end |
#operator ⇒ Object
def operator: () -> String
5846 5847 5848 |
# File 'lib/prism/node.rb', line 5846 def operator operator_loc.slice end |
#type ⇒ Object
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
5873 5874 5875 |
# File 'lib/prism/node.rb', line 5873 def type :embedded_variable_node end |