class Prism::PreExecutionNode - Documentation for Ruby 4.0
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 }
    ^^^^^^^^^^^^^

### Attributes

statements [R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

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

    # File lib/prism/node.rb, line 15836
    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.

type ()
Source

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

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 15963
    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.

accept (visitor)
Source

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

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`

closing_loc ()
Source

    # File lib/prism/node.rb, line 15919
    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`

comment_targets ()
Source

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

def `comment_targets`: () -> Array[Node | Location]

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 15865
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << statements if statements
      compact
    end

def `compact_child_nodes`: () -> Array

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)
Source

    # File lib/prism/node.rb, line 15877
    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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?statements: `StatementsNode`?, ?keyword_loc: `Location`, ?opening_loc: `Location`, ?closing_loc: `Location`) -> `PreExecutionNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 15885
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, statements: statements, keyword_loc: keyword_loc, opening_loc: opening_loc, closing_loc: closing_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, statements: `StatementsNode`?, `keyword_loc`: `Location`, `opening_loc`: `Location`, `closing_loc`: `Location` }

each_child_node () { |statements| ... }
Source

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

      yield statements if statements
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

    # File lib/prism/node.rb, line 15947
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

keyword ()
Source

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

def keyword: () -> `String`

keyword_loc ()
Source

    # File lib/prism/node.rb, line 15893
    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`

opening ()
Source

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

def opening: () -> `String`

opening_loc ()
Source

    # File lib/prism/node.rb, line 15906
    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`

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 15927
    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 15901
    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 15914
    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.

type ()
Source

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

Return a symbol representation of this node type. See `Node#type`.