Class: Prism::ProgramNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

The top level node of any parse tree.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(locals, statements, location) ⇒ ProgramNode

def initialize: (locals: Array, statements: StatementsNode, location: Location) -> void



13905
13906
13907
13908
13909
 
# File 'lib/prism/node.rb', line 13905

def initialize(locals, statements, location)
  @locals = locals
  @statements = statements
  @location = location
end

Instance Attribute Details

#locals ⇒ Object (readonly)

attr_reader locals: Array



13899
13900
13901
 
# File 'lib/prism/node.rb', line 13899

def locals
  @locals
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode



13902
13903
13904
 
# File 'lib/prism/node.rb', line 13902

def statements
  @statements
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



13981
13982
13983
 
# File 'lib/prism/node.rb', line 13981

def self.type
  :program_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13912
13913
13914
 
# File 'lib/prism/node.rb', line 13912

def accept(visitor)
  visitor.visit_program_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



13917
13918
13919
 
# File 'lib/prism/node.rb', line 13917

def child_nodes
  [statements]
end

#comment_targets ⇒ Object

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



13927
13928
13929
 
# File 'lib/prism/node.rb', line 13927

def comment_targets
  [statements]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13922
13923
13924
 
# File 'lib/prism/node.rb', line 13922

def compact_child_nodes
  [statements]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ProgramNode



13932
13933
13934
13935
13936
13937
13938
 
# File 'lib/prism/node.rb', line 13932

def copy(**params)
  ProgramNode.new(
    params.fetch(:locals) { locals },
    params.fetch(:statements) { statements },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



13944
13945
13946
 
# File 'lib/prism/node.rb', line 13944

def deconstruct_keys(keys)
  { locals: locals, statements: statements, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13949
13950
13951
13952
13953
13954
13955
 
# File 'lib/prism/node.rb', line 13949

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── locals: #{locals.inspect}\n"
  inspector << "└── statements:\n"
  inspector << inspector.child_node(statements, "    ")
  inspector.to_str
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



13971
13972
13973
 
# File 'lib/prism/node.rb', line 13971

def type
  :program_node
end