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(source, node_id, location, flags, statements, keyword_loc, opening_loc, closing_loc) ⇒ PreExecutionNode

Initialize a new PreExecutionNode node.



14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
 
# File 'lib/prism/node.rb', line 14746

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

Instance Attribute Details

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



14793
14794
14795
 
# File 'lib/prism/node.rb', line 14793

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



14860
14861
14862
 
# File 'lib/prism/node.rb', line 14860

def self.type
  :pre_execution_node
end

Instance Method Details

#===(other) ⇒ Object

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



14866
14867
14868
14869
14870
14871
14872
 
# File 'lib/prism/node.rb', line 14866

def ===(other)
  other.is_a?(PreExecutionNode) &&
    (statements === other.statements) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



14758
14759
14760
 
# File 'lib/prism/node.rb', line 14758

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

#child_nodes ⇒ Object Also known as: deconstruct

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



14763
14764
14765
 
# File 'lib/prism/node.rb', line 14763

def child_nodes
  [statements]
end

#closing ⇒ Object

def closing: () -> String



14845
14846
14847
 
# File 'lib/prism/node.rb', line 14845

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



14822
14823
14824
14825
14826
 
# File 'lib/prism/node.rb', line 14822

def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#comment_targets ⇒ Object

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



14775
14776
14777
 
# File 'lib/prism/node.rb', line 14775

def comment_targets
  [*statements, keyword_loc, opening_loc, closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14768
14769
14770
14771
14772
 
# File 'lib/prism/node.rb', line 14768

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << statements if statements
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, statements: self.statements, keyword_loc: self.keyword_loc, opening_loc: self.opening_loc, closing_loc: self.closing_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?statements: StatementsNode?, ?keyword_loc: Location, ?opening_loc: Location, ?closing_loc: Location) -> PreExecutionNode



14780
14781
14782
 
# File 'lib/prism/node.rb', line 14780

def copy(node_id: self.node_id, location: self.location, flags: self.flags, statements: self.statements, keyword_loc: self.keyword_loc, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  PreExecutionNode.new(source, node_id, location, flags, statements, keyword_loc, opening_loc, closing_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, statements: StatementsNode?, keyword_loc: Location, opening_loc: Location, closing_loc: Location }



14788
14789
14790
 
# File 'lib/prism/node.rb', line 14788

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

#inspect ⇒ Object

def inspect -> String



14850
14851
14852
 
# File 'lib/prism/node.rb', line 14850

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



14835
14836
14837
 
# File 'lib/prism/node.rb', line 14835

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



14796
14797
14798
14799
14800
 
# File 'lib/prism/node.rb', line 14796

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#opening ⇒ Object

def opening: () -> String



14840
14841
14842
 
# File 'lib/prism/node.rb', line 14840

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



14809
14810
14811
14812
14813
 
# File 'lib/prism/node.rb', line 14809

def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_closing_loc(repository) ⇒ Object

Save the closing_loc location using the given saved source so that it can be retrieved later.



14830
14831
14832
 
# File 'lib/prism/node.rb', line 14830

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_keyword_loc(repository) ⇒ Object

Save the keyword_loc location using the given saved source so that it can be retrieved later.



14804
14805
14806
 
# File 'lib/prism/node.rb', line 14804

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#save_opening_loc(repository) ⇒ Object

Save the opening_loc location using the given saved source so that it can be retrieved later.



14817
14818
14819
 
# File 'lib/prism/node.rb', line 14817

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

#type ⇒ Object

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



14855
14856
14857
 
# File 'lib/prism/node.rb', line 14855

def type
  :pre_execution_node
end