Class: Prism::InterpolatedXStringNode
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Node
|
|
Instance Chain:
self,
HeredocQuery ,
Node
|
|
Inherits: |
Prism::Node
|
Defined in: | lib/prism/node.rb, lib/prism/node_ext.rb, lib/prism/parse_result/newlines.rb |
Overview
Represents an xstring literal that contains interpolation.
`foo #{} baz`
^^^^^^^^^^^^^^^^
Class Method Summary
- .new(opening_loc, parts, closing_loc, location) ⇒ InterpolatedXStringNode 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
-
#closing_loc
readonly
attr_reader closing_loc:
Location
. -
#opening_loc
readonly
attr_reader opening_loc:
Location
. -
#parts
readonly
attr_reader parts: Array.
HeredocQuery
- Included
#heredoc? | Returns true if this node was represented as a heredoc in the source code. |
Node
- Inherited
Instance Method Summary
-
#accept(visitor)
def accept: (visitor:
Visitor
) -> void. -
#child_nodes
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#closing
def closing: () -> String.
-
#comment_targets
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes
def compact_child_nodes: () -> Array.
-
#copy(**params)
def copy: (**params) ->
InterpolatedXStringNode
. -
#deconstruct
Alias for #child_nodes.
- #deconstruct_keys(keys)
-
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String.
-
#opening
def opening: () -> 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.
- #newline!(lines) Internal use only
- #set_newline_flag(newline_marked) 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(opening_loc, parts, closing_loc, location) ⇒ InterpolatedXStringNode
# File 'lib/prism/node.rb', line 10301
def initialize(opening_loc, parts, closing_loc, location) @opening_loc = opening_loc @parts = parts @closing_loc = closing_loc @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 10394
def self.type :interpolated_x_string_node end
Instance Attribute Details
#closing_loc (readonly)
attr_reader closing_loc: Location
# File 'lib/prism/node.rb', line 10298
attr_reader :closing_loc
#opening_loc (readonly)
attr_reader opening_loc: Location
# File 'lib/prism/node.rb', line 10292
attr_reader :opening_loc
#parts (readonly)
attr_reader parts: Array
# File 'lib/prism/node.rb', line 10295
attr_reader :parts
Instance Method Details
#accept(visitor)
def accept: (visitor: Visitor
) -> void
# File 'lib/prism/node.rb', line 10309
def accept(visitor) visitor.visit_interpolated_x_string_node(self) end
#child_nodes Also known as: #deconstruct
def child_nodes: () -> Array[nil | Node]
# File 'lib/prism/node.rb', line 10319
def child_nodes [*parts] end
#closing
def closing: () -> String
# File 'lib/prism/node.rb', line 10357
def closing closing_loc.slice end
#comment_targets
def comment_targets: () -> Array[Node | Location]
# File 'lib/prism/node.rb', line 10329
def comment_targets [opening_loc, *parts, closing_loc] end
#compact_child_nodes
def compact_child_nodes: () -> Array
# File 'lib/prism/node.rb', line 10324
def compact_child_nodes [*parts] end
#copy(**params)
def copy: (**params) -> InterpolatedXStringNode
# File 'lib/prism/node.rb', line 10334
def copy(**params) InterpolatedXStringNode.new( params.fetch(:opening_loc) { opening_loc }, params.fetch(:parts) { parts }, params.fetch(:closing_loc) { closing_loc }, params.fetch(:location) { location }, ) end
#deconstruct
Alias for #child_nodes.
# File 'lib/prism/node.rb', line 10344
alias deconstruct child_nodes
#deconstruct_keys(keys)
# File 'lib/prism/node.rb', line 10347
def deconstruct_keys(keys) { opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location } end
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String
# File 'lib/prism/node.rb', line 10362
def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n" inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}" inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n" inspector.to_str end
#newline!(lines)
# File 'lib/prism/parse_result/newlines.rb', line 148
def newline!(lines) # :nodoc: first = parts.first first.newline!(lines) if first end
#opening
def opening: () -> String
# File 'lib/prism/node.rb', line 10352
def opening opening_loc.slice end
#set_newline_flag(newline_marked)
# File 'lib/prism/node.rb', line 10313
def set_newline_flag(newline_marked) # :nodoc: first = parts.first first.set_newline_flag(newline_marked) if first 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 10384
def type :interpolated_x_string_node end