class Prism::ProgramNode - prism: Ruby Standard Library Documentation

# 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) click to toggle source

Initialize a new `ProgramNode` node.

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

type() click to toggle source

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

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

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File prism/node.rb, line 14937
    def ===(other)
      other.is_a?(ProgramNode) &&
        (locals.length == other.locals.length) &&
        locals.zip(other.locals).all? { |left, right| left === right } &&
        (statements === other.statements)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

def `child_nodes`: () -> Array[nil | Node]

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

Also aliased as: deconstruct
comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, statements: self.statements) click to toggle source

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

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

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

inspect() click to toggle source

def inspect -> String

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

type() click to toggle source

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

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