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.



15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
 
# File 'lib/prism/node.rb', line 15836

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?



15890
15891
15892
 
# File 'lib/prism/node.rb', line 15890

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



15957
15958
15959
 
# File 'lib/prism/node.rb', line 15957

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.



15963
15964
15965
15966
15967
15968
15969
 
# File 'lib/prism/node.rb', line 15963

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



15848
15849
15850
 
# File 'lib/prism/node.rb', line 15848

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



15853
15854
15855
 
# File 'lib/prism/node.rb', line 15853

def child_nodes
  [statements]
end

#closing ⇒ Object

def closing: () -> String



15942
15943
15944
 
# File 'lib/prism/node.rb', line 15942

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



15919
15920
15921
15922
15923
 
# File 'lib/prism/node.rb', line 15919

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]



15872
15873
15874
 
# File 'lib/prism/node.rb', line 15872

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15865
15866
15867
15868
15869
 
# File 'lib/prism/node.rb', line 15865

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



15877
15878
15879
 
# File 'lib/prism/node.rb', line 15877

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 }



15885
15886
15887
 
# File 'lib/prism/node.rb', line 15885

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

#each_child_node {|statements| ... } ⇒ Object

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

Yields:



15858
15859
15860
15861
15862
 
# File 'lib/prism/node.rb', line 15858

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield statements if statements
end

#inspect ⇒ Object

def inspect -> String



15947
15948
15949
 
# File 'lib/prism/node.rb', line 15947

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



15932
15933
15934
 
# File 'lib/prism/node.rb', line 15932

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



15893
15894
15895
15896
15897
 
# File 'lib/prism/node.rb', line 15893

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



15937
15938
15939
 
# File 'lib/prism/node.rb', line 15937

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



15906
15907
15908
15909
15910
 
# File 'lib/prism/node.rb', line 15906

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.



15927
15928
15929
 
# File 'lib/prism/node.rb', line 15927

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.



15901
15902
15903
 
# File 'lib/prism/node.rb', line 15901

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.



15914
15915
15916
 
# File 'lib/prism/node.rb', line 15914

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`.



15952
15953
15954
 
# File 'lib/prism/node.rb', line 15952

def type
  :pre_execution_node
end