class Prism::PreExecutionNode - Documentation for Ruby 4.1
Description: class Prism::PreExecutionNode: Represents the use of the `BEGIN` keyword.
Keywords: ruby,class,Prism::PreExecutionNode

🔍

No recent searches

# class Prism::PreExecutionNode

Represents the use of the `BEGIN` keyword.

    BEGIN { foo }
    ^^^^^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, statements, keyword_loc, opening_loc, closing_loc)
Source

    # File lib/prism/node.rb, line 25362
    def initialize(source, node_id, location, flags, statements, keyword_loc, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @statements = statements
      @keyword_loc = keyword_loc
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

Initialize a new `PreExecutionNode` node.

### Public Instance Methods

statements → StatementsNode | nil
Source

    # File lib/prism/node.rb, line 25468
    def statements
      @statements
    end

Returns the `statements` attribute.

## Locations

### Public Instance Methods

closing_loc → Location
Source

    # File lib/prism/node.rb, line 25523
    def closing_loc
      location = @closing_loc
      return location if location.is_a?(Location)
      @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

Returns the `Location` represented by `closing_loc`.

keyword_loc → Location
Source

    # File lib/prism/node.rb, line 25479
    def keyword_loc
      location = @keyword_loc
      return location if location.is_a?(Location)
      @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

Returns the `Location` represented by `keyword_loc`.

opening_loc → Location
Source

    # File lib/prism/node.rb, line 25501
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

Returns the `Location` represented by `opening_loc`.

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

    # File lib/prism/node.rb, line 25451
    def self.type
      :pre_execution_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

    # File lib/prism/node.rb, line 25387
    def accept(visitor)
      visitor.visit_pre_execution_node(self)
    end

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 25394
    def child_nodes
      [statements]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 25420
    def comment_targets
      [*statements, keyword_loc, opening_loc, closing_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 25411
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      if (statements = self.statements); compact << statements; end
      compact
    end

See `Node.compact_child_nodes`.

copy(**fields) → PreExecutionNode
Source

    # File lib/prism/node.rb, line 25430
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, statements: self.statements, keyword_loc: self.keyword_loc, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      PreExecutionNode.new(source, node_id, location, flags, statements, keyword_loc, opening_loc, closing_loc)
    end

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |statements| ... }
Source

    # File lib/prism/node.rb, line 25402
    def each_child_node(&blk)
      return to_enum(:each_child_node) unless block_given?

      if (statements = self.statements); yield statements; end
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 25444
    def type
      :pre_execution_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 25534
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    end

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 25490
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

Save the `keyword_loc` location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 25512
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

## Slicing

### Public Instance Methods

closing → String
Source

    # File lib/prism/node.rb, line 25566
    def closing
      closing_loc.slice
    end

Slice the location of `closing_loc` from the source.

keyword → String
Source

    # File lib/prism/node.rb, line 25546
    def keyword
      keyword_loc.slice
    end

Slice the location of `keyword_loc` from the source.

opening → String
Source

    # File lib/prism/node.rb, line 25556
    def opening
      opening_loc.slice
    end

Slice the location of `opening_loc` from the source.