Class: YARP::BeginNode

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

Overview

Represents a begin statement.

begin
  foo
end
^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc, location) ⇒ BeginNode

def initialize: (begin_keyword_loc: Location?, statements: Node?, rescue_clause: Node?, else_clause: Node?, ensure_clause: Node?, end_keyword_loc: Location?, location: Location) -> void



450
451
452
453
454
455
456
457
458
# File 'lib/yarp/node.rb', line 450

def initialize(begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc, location)
  @begin_keyword_loc = begin_keyword_loc
  @statements = statements
  @rescue_clause = rescue_clause
  @else_clause = else_clause
  @ensure_clause = ensure_clause
  @end_keyword_loc = end_keyword_loc
  @location = location
end

Instance Attribute Details

#begin_keyword_locObject (readonly)

attr_reader begin_keyword_loc: Location?



432
433
434
# File 'lib/yarp/node.rb', line 432

def begin_keyword_loc
  @begin_keyword_loc
end

#else_clauseObject (readonly)

attr_reader else_clause: Node?



441
442
443
# File 'lib/yarp/node.rb', line 441

def else_clause
  @else_clause
end

#end_keyword_locObject (readonly)

attr_reader end_keyword_loc: Location?



447
448
449
# File 'lib/yarp/node.rb', line 447

def end_keyword_loc
  @end_keyword_loc
end

#ensure_clauseObject (readonly)

attr_reader ensure_clause: Node?



444
445
446
# File 'lib/yarp/node.rb', line 444

def ensure_clause
  @ensure_clause
end

#rescue_clauseObject (readonly)

attr_reader rescue_clause: Node?



438
439
440
# File 'lib/yarp/node.rb', line 438

def rescue_clause
  @rescue_clause
end

#statementsObject (readonly)

attr_reader statements: Node?



435
436
437
# File 'lib/yarp/node.rb', line 435

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



461
462
463
# File 'lib/yarp/node.rb', line 461

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

#begin_keywordObject

def begin_keyword: () -> String?



483
484
485
# File 'lib/yarp/node.rb', line 483

def begin_keyword
  begin_keyword_loc&.slice
end

#child_nodesObject Also known as: deconstruct

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



470
471
472
# File 'lib/yarp/node.rb', line 470

def child_nodes
  [statements, rescue_clause, else_clause, ensure_clause]
end

#deconstruct_keys(keys) ⇒ Object

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



478
479
480
# File 'lib/yarp/node.rb', line 478

def deconstruct_keys(keys)
  { begin_keyword_loc: begin_keyword_loc, statements: statements, rescue_clause: rescue_clause, else_clause: else_clause, ensure_clause: ensure_clause, end_keyword_loc: end_keyword_loc, location: location }
end

#end_keywordObject

def end_keyword: () -> String?



488
489
490
# File 'lib/yarp/node.rb', line 488

def end_keyword
  end_keyword_loc&.slice
end

#set_newline_flag(newline_marked) ⇒ Object



465
466
467
# File 'lib/yarp/node.rb', line 465

def set_newline_flag(newline_marked)
  # Never mark BeginNode with a newline flag, mark children instead
end