Class: Prism::ReturnNode

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

Overview

Represents the use of the ‘return` keyword.

return 1
^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(keyword_loc, arguments, location) ⇒ ReturnNode

def initialize: (keyword_loc: Location, arguments: ArgumentsNode?, location: Location) -> void



12494
12495
12496
12497
12498
 
# File 'lib/prism/node.rb', line 12494

def initialize(keyword_loc, arguments, location)
  @keyword_loc = keyword_loc
  @arguments = arguments
  @location = location
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



12491
12492
12493
 
# File 'lib/prism/node.rb', line 12491

def arguments
  @arguments
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



12488
12489
12490
 
# File 'lib/prism/node.rb', line 12488

def keyword_loc
  @keyword_loc
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12501
12502
12503
 
# File 'lib/prism/node.rb', line 12501

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

#child_nodes ⇒ Object Also known as: deconstruct

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



12506
12507
12508
 
# File 'lib/prism/node.rb', line 12506

def child_nodes
  [arguments]
end

#comment_targets ⇒ Object

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



12518
12519
12520
 
# File 'lib/prism/node.rb', line 12518

def comment_targets
  [keyword_loc, *arguments]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12511
12512
12513
12514
12515
 
# File 'lib/prism/node.rb', line 12511

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

#copy(**params) ⇒ Object

def copy: (**params) -> ReturnNode



12523
12524
12525
12526
12527
12528
12529
 
# File 'lib/prism/node.rb', line 12523

def copy(**params)
  ReturnNode.new(
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:arguments) { arguments },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



12535
12536
12537
 
# File 'lib/prism/node.rb', line 12535

def deconstruct_keys(keys)
  { keyword_loc: keyword_loc, arguments: arguments, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
 
# File 'lib/prism/node.rb', line 12544

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

#keyword ⇒ Object

def keyword: () -> String



12540
12541
12542
 
# File 'lib/prism/node.rb', line 12540

def keyword
  keyword_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



12570
12571
12572
 
# File 'lib/prism/node.rb', line 12570

def type
  :return_node
end