Class: Prism::PreExecutionNode

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

Overview

Represents the use of the ‘BEGIN` keyword.

BEGIN { foo }
^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(statements, keyword_loc, opening_loc, closing_loc, location) ⇒ PreExecutionNode

def initialize: (statements: StatementsNode?, keyword_loc: Location, opening_loc: Location, closing_loc: Location, location: Location) -> void



13788
13789
13790
13791
13792
13793
13794
 
# File 'lib/prism/node.rb', line 13788

def initialize(statements, keyword_loc, opening_loc, closing_loc, location)
  @statements = statements
  @keyword_loc = keyword_loc
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



13785
13786
13787
 
# File 'lib/prism/node.rb', line 13785

def closing_loc
  @closing_loc
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



13779
13780
13781
 
# File 'lib/prism/node.rb', line 13779

def keyword_loc
  @keyword_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



13782
13783
13784
 
# File 'lib/prism/node.rb', line 13782

def opening_loc
  @opening_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



13776
13777
13778
 
# File 'lib/prism/node.rb', line 13776

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



13891
13892
13893
 
# File 'lib/prism/node.rb', line 13891

def self.type
  :pre_execution_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13797
13798
13799
 
# File 'lib/prism/node.rb', line 13797

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13802
13803
13804
 
# File 'lib/prism/node.rb', line 13802

def child_nodes
  [statements]
end

#closing ⇒ Object

def closing: () -> String



13848
13849
13850
 
# File 'lib/prism/node.rb', line 13848

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



13814
13815
13816
 
# File 'lib/prism/node.rb', line 13814

def comment_targets
  [*statements, keyword_loc, opening_loc, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13807
13808
13809
13810
13811
 
# File 'lib/prism/node.rb', line 13807

def compact_child_nodes
  compact = []
  compact << statements if statements
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> PreExecutionNode



13819
13820
13821
13822
13823
13824
13825
13826
13827
 
# File 'lib/prism/node.rb', line 13819

def copy(**params)
  PreExecutionNode.new(
    params.fetch(:statements) { statements },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



13833
13834
13835
 
# File 'lib/prism/node.rb', line 13833

def deconstruct_keys(keys)
  { statements: statements, keyword_loc: keyword_loc, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
 
# File 'lib/prism/node.rb', line 13853

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (statements = self.statements).nil?
    inspector << "├── statements: ∅\n"
  else
    inspector << "├── statements:\n"
    inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



13838
13839
13840
 
# File 'lib/prism/node.rb', line 13838

def keyword
  keyword_loc.slice
end

#opening ⇒ Object

def opening: () -> String



13843
13844
13845
 
# File 'lib/prism/node.rb', line 13843

def opening
  opening_loc.slice
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



13881
13882
13883
 
# File 'lib/prism/node.rb', line 13881

def type
  :pre_execution_node
end