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

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



11311
11312
11313
11314
11315
11316
11317
 
# File 'lib/prism/node.rb', line 11311

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



11308
11309
11310
 
# File 'lib/prism/node.rb', line 11308

def closing_loc
  @closing_loc
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



11302
11303
11304
 
# File 'lib/prism/node.rb', line 11302

def keyword_loc
  @keyword_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



11305
11306
11307
 
# File 'lib/prism/node.rb', line 11305

def opening_loc
  @opening_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



11299
11300
11301
 
# File 'lib/prism/node.rb', line 11299

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



11320
11321
11322
 
# File 'lib/prism/node.rb', line 11320

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11325
11326
11327
 
# File 'lib/prism/node.rb', line 11325

def child_nodes
  [statements]
end

#closing ⇒ Object

def closing: () -> String



11371
11372
11373
 
# File 'lib/prism/node.rb', line 11371

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



11337
11338
11339
 
# File 'lib/prism/node.rb', line 11337

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11330
11331
11332
11333
11334
 
# File 'lib/prism/node.rb', line 11330

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

#copy(**params) ⇒ Object

def copy: (**params) -> PreExecutionNode



11342
11343
11344
11345
11346
11347
11348
11349
11350
 
# File 'lib/prism/node.rb', line 11342

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]



11356
11357
11358
 
# File 'lib/prism/node.rb', line 11356

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 



11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
 
# File 'lib/prism/node.rb', line 11375

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



11361
11362
11363
 
# File 'lib/prism/node.rb', line 11361

def keyword
  keyword_loc.slice
end

#opening ⇒ Object

def opening: () -> String



11366
11367
11368
 
# File 'lib/prism/node.rb', line 11366

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



11403
11404
11405
 
# File 'lib/prism/node.rb', line 11403

def type
  :pre_execution_node
end