Represents the use of the ‘BEGIN` keyword.
BEGIN { foo }
^^^^^^^^^^^^^
attr_reader statements: StatementsNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15059
def initialize(source, statements, keyword_loc, opening_loc, closing_loc, location)
@source = source
@location = location
@statements = statements
@keyword_loc = keyword_loc
@opening_loc = opening_loc
@closing_loc = closing_loc
end
def initialize: (StatementsNode? statements, Location keyword_loc, Location opening_loc, Location closing_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15171
def self.type
:pre_execution_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 15177
def ===(other)
other.is_a?(PreExecutionNode) &&
(statements === other.statements) &&
(keyword_loc.nil? == other.keyword_loc.nil?) &&
(opening_loc.nil? == other.opening_loc.nil?) &&
(closing_loc.nil? == other.closing_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 15069
def accept(visitor)
visitor.visit_pre_execution_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15074
def child_nodes
[statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15138
def closing
closing_loc.slice
end
def closing: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15121
def closing_loc
location = @closing_loc
return location if location.is_a?(Location)
@closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader closing_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15086
def comment_targets
[*statements, keyword_loc, opening_loc, closing_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 15079
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << statements if statements
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15091
def copy(statements: self.statements, keyword_loc: self.keyword_loc, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location)
PreExecutionNode.new(source, statements, keyword_loc, opening_loc, closing_loc, location)
end
def copy: (?statements: StatementsNode?, ?keyword_loc: Location, ?opening_loc: Location, ?closing_loc: Location, ?location: Location) -> PreExecutionNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15099
def deconstruct_keys(keys)
{ statements: statements, keyword_loc: keyword_loc, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { statements: StatementsNode?, keyword_loc: Location, opening_loc: Location, closing_loc: Location, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15143
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15128
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15107
def keyword_loc
location = @keyword_loc
return location if location.is_a?(Location)
@keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15133
def opening
opening_loc.slice
end
def opening: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15114
def opening_loc
location = @opening_loc
return location if location.is_a?(Location)
@opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader opening_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 15161
def type
:pre_execution_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