class Prism::ForNode
Represents the use of the ‘for` keyword.
for i in a end ^^^^^^^^^^^^^^
Attributes
attr_reader collection: Prism::node
attr_reader index: Prism::node
attr_reader statements: StatementsNode
?
Public Class Methods
def initialize: (Prism::node index, Prism::node collection, StatementsNode
? statements, Location
for_keyword_loc
, Location
in_keyword_loc
, Location
? do_keyword_loc
, Location
end_keyword_loc
, Location
location) -> void
# File lib/prism/node.rb, line 7004 def initialize(source, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location) @source = source @newline = false @location = location @index = index @collection = collection @statements = statements @for_keyword_loc = for_keyword_loc @in_keyword_loc = in_keyword_loc @do_keyword_loc = do_keyword_loc @end_keyword_loc = end_keyword_loc end
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 7162 def self.type :for_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 7018 def accept(visitor) visitor.visit_for_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 7023 def child_nodes [index, collection, statements] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 7037 def comment_targets [index, collection, *statements, for_keyword_loc, in_keyword_loc, *do_keyword_loc, end_keyword_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 7028 def compact_child_nodes compact = [] #: Array[Prism::node] compact << index compact << collection compact << statements if statements compact end
def copy: (?index: Prism::node, ?collection: Prism::node, ?statements: StatementsNode
?, ?for_keyword_loc: Location
, ?in_keyword_loc: Location
, ?do_keyword_loc: Location
?, ?end_keyword_loc: Location
, ?location: Location
) -> ForNode
# File lib/prism/node.rb, line 7042 def copy(index: self.index, collection: self.collection, statements: self.statements, for_keyword_loc: self.for_keyword_loc, in_keyword_loc: self.in_keyword_loc, do_keyword_loc: self.do_keyword_loc, end_keyword_loc: self.end_keyword_loc, location: self.location) ForNode.new(source, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location) end
def deconstruct_keys
: (Array keys) -> { index: Prism::node, collection: Prism::node, statements: StatementsNode
?, for_keyword_loc
: Location
, in_keyword_loc
: Location
, do_keyword_loc
: Location
?, end_keyword_loc
: Location
, location: Location
}
# File lib/prism/node.rb, line 7050 def deconstruct_keys(keys) { index: index, collection: collection, statements: statements, for_keyword_loc: for_keyword_loc, in_keyword_loc: in_keyword_loc, do_keyword_loc: do_keyword_loc, end_keyword_loc: end_keyword_loc, location: location } end
def do_keyword
: () -> String
?
# File lib/prism/node.rb, line 7109 def do_keyword do_keyword_loc&.slice end
attr_reader do_keyword_loc
: Location
?
# File lib/prism/node.rb, line 7078 def do_keyword_loc location = @do_keyword_loc case location when nil nil when Location location else @do_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end
def end_keyword
: () -> String
# File lib/prism/node.rb, line 7114 def end_keyword end_keyword_loc.slice end
attr_reader end_keyword_loc
: Location
# File lib/prism/node.rb, line 7091 def end_keyword_loc location = @end_keyword_loc return location if location.is_a?(Location) @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def for_keyword
: () -> String
# File lib/prism/node.rb, line 7099 def for_keyword for_keyword_loc.slice end
attr_reader for_keyword_loc
: Location
# File lib/prism/node.rb, line 7064 def for_keyword_loc location = @for_keyword_loc return location if location.is_a?(Location) @for_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def in_keyword
: () -> String
# File lib/prism/node.rb, line 7104 def in_keyword in_keyword_loc.slice end
attr_reader in_keyword_loc
: Location
# File lib/prism/node.rb, line 7071 def in_keyword_loc location = @in_keyword_loc return location if location.is_a?(Location) @in_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 7119 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── index:\n" inspector << inspector.child_node(index, "│ ") inspector << "├── collection:\n" inspector << inspector.child_node(collection, "│ ") if (statements = self.statements).nil? inspector << "├── statements: ∅\n" else inspector << "├── statements:\n" inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end inspector << "├── for_keyword_loc: #{inspector.location(for_keyword_loc)}\n" inspector << "├── in_keyword_loc: #{inspector.location(in_keyword_loc)}\n" inspector << "├── do_keyword_loc: #{inspector.location(do_keyword_loc)}\n" inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n" inspector.to_str end
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 7152 def type :for_node end