Represents a begin statement.
begin foo end ^^^^^
Represents the statements within the begin block.
begin x end
^
Represents the rescue clause within the begin block.
begin x; rescue y; end
^^^^^^^^
Represents the else clause within the begin block.
begin x; rescue y; else z; end
^^^^^^
Represents the ensure clause within the begin block.
begin x; ensure y; end
^^^^^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1485
def initialize(source, node_id, location, flags, begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc)
@source = source
@node_id = node_id
@location = location
@flags = flags
@begin_keyword_loc = begin_keyword_loc
@statements = statements
@rescue_clause = rescue_clause
@else_clause = else_clause
@ensure_clause = ensure_clause
@end_keyword_loc = end_keyword_loc
end
Initialize a new BeginNode node.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1625
def self.type
:begin_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1631
def ===(other)
other.is_a?(BeginNode) &&
(begin_keyword_loc.nil? == other.begin_keyword_loc.nil?) &&
(statements === other.statements) &&
(rescue_clause === other.rescue_clause) &&
(else_clause === other.else_clause) &&
(ensure_clause === other.ensure_clause) &&
(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.1/lib/prism/node.rb, line 1499
def accept(visitor)
visitor.visit_begin_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1605
def begin_keyword
begin_keyword_loc&.slice
end
def begin_keyword: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1540
def begin_keyword_loc
location = @begin_keyword_loc
case location
when nil
nil
when Location
location
else
@begin_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
Represents the location of the ‘begin` keyword.
begin x end ^^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1504
def child_nodes
[statements, rescue_clause, else_clause, ensure_clause]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1519
def comment_targets
[*begin_keyword_loc, *statements, *rescue_clause, *else_clause, *ensure_clause, *end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1509
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << statements if statements
compact << rescue_clause if rescue_clause
compact << else_clause if else_clause
compact << ensure_clause if ensure_clause
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1524
def copy(node_id: self.node_id, location: self.location, flags: self.flags, begin_keyword_loc: self.begin_keyword_loc, statements: self.statements, rescue_clause: self.rescue_clause, else_clause: self.else_clause, ensure_clause: self.ensure_clause, end_keyword_loc: self.end_keyword_loc)
BeginNode.new(source, node_id, location, flags, begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc)
end
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?begin_keyword_loc: Location?, ?statements: StatementsNode?, ?rescue_clause: RescueNode?, ?else_clause: ElseNode?, ?ensure_clause: EnsureNode?, ?end_keyword_loc: Location?) -> BeginNode
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1532
def deconstruct_keys(keys)
{ node_id: node_id, location: location, begin_keyword_loc: begin_keyword_loc, statements: statements, rescue_clause: rescue_clause, else_clause: else_clause, ensure_clause: ensure_clause, end_keyword_loc: end_keyword_loc }
end
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, begin_keyword_loc: Location?, statements: StatementsNode?, rescue_clause: RescueNode?, else_clause: ElseNode?, ensure_clause: EnsureNode?, end_keyword_loc: Location? }
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1610
def end_keyword
end_keyword_loc&.slice
end
def end_keyword: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1586
def end_keyword_loc
location = @end_keyword_loc
case location
when nil
nil
when Location
location
else
@end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
Represents the location of the ‘end` keyword.
begin x end
^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1615
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1554
def save_begin_keyword_loc(repository)
repository.enter(node_id, :begin_keyword_loc) unless @begin_keyword_loc.nil?
end
Save the begin_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1600
def save_end_keyword_loc(repository)
repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
end
Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 1620
def type
:begin_node
end
Return a symbol representation of this node type. See ‘Node#type`.