class Prism::ProgramNode - Documentation for Ruby 4.0
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.

### Attributes

locals [R]

attr_reader locals: Array

statements [R]

attr_reader statements: `StatementsNode`

### Public Class Methods

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

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

type ()
Source

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

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 16047
    def ===(other)
      other.is_a?(ProgramNode) &&
        (locals.length == other.locals.length) &&
        locals.zip(other.locals).all? { |left, right| left === right } &&
        (statements === other.statements)
    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 15985
    def accept(visitor)
      visitor.visit_program_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, statements: self.statements)
Source

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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?locals: Array, ?statements: `StatementsNode`) -> `ProgramNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 16020
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, locals: locals, statements: statements }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, locals: Array, statements: `StatementsNode` }

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

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

      yield statements
    end

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

inspect ()
Source

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

def inspect -> `String`

type ()
Source

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

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