Represents the use of the ‘for` keyword.
for i in a end ^^^^^^^^^^^^^^
attr_reader index: Prism::node
attr_reader collection: Prism::node
attr_reader statements: StatementsNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7096
def initialize(source, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location)
@source = source
@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
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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7237
def self.type
:for_node
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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7243
def ===(other)
other.is_a?(ForNode) &&
(index === other.index) &&
(collection === other.collection) &&
(statements === other.statements) &&
(for_keyword_loc.nil? == other.for_keyword_loc.nil?) &&
(in_keyword_loc.nil? == other.in_keyword_loc.nil?) &&
(do_keyword_loc.nil? == other.do_keyword_loc.nil?) &&
(end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7109
def accept(visitor)
visitor.visit_for_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7114
def child_nodes
[index, collection, statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7128
def comment_targets
[index, collection, *statements, for_keyword_loc, in_keyword_loc, *do_keyword_loc, end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7119
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << index
compact << collection
compact << statements if statements
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7133
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
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7141
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 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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7199
def do_keyword
do_keyword_loc&.slice
end
def do_keyword: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7169
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
attr_reader do_keyword_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7204
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7182
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
attr_reader end_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7189
def for_keyword
for_keyword_loc.slice
end
def for_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7155
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
attr_reader for_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7194
def in_keyword
in_keyword_loc.slice
end
def in_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7162
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
attr_reader in_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7209
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 7227
def type
:for_node
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