class Prism::ProgramNode - Documentation for Ruby 4.1
Description: class Prism::ProgramNode: The top level node of any parse tree.
Keywords: ruby,class,Prism::ProgramNode

🔍

No recent searches

# class Prism::ProgramNode

The top level node of any parse tree.

### Public Class Methods

new (source, node_id, location, flags, locals, statements)
Source

    # File lib/prism/node.rb, line 25590
    def initialize(source, node_id, location, flags, locals, statements)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @locals = locals
      @statements = statements
    end

Initialize a new `ProgramNode` node.

### Public Instance Methods

locals → Array[Symbol]
Source

    # File lib/prism/node.rb, line 25692
    def locals
      @locals
    end

Returns the `locals` attribute.

statements → StatementsNode
Source

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

Returns the `statements` attribute.

## 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 25675
    def self.type
      :program_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 25644
    def comment_targets
      [statements] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 25637
    def compact_child_nodes
      [statements]
    end

See `Node.compact_child_nodes`.

copy(**fields) → ProgramNode
Source

    # File lib/prism/node.rb, line 25654
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, statements: self.statements)
      ProgramNode.new(source, node_id, location, flags, locals, statements)
    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 25628
    def each_child_node(&blk)
      return to_enum(:each_child_node) unless block_given?

      yield statements
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 25668
    def type
      :program_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

## Slicing