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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(keyword_loc, arguments, location) ⇒ ReturnNode

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



15106
15107
15108
15109
15110
 
# File 'lib/prism/node.rb', line 15106

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?



15103
15104
15105
 
# File 'lib/prism/node.rb', line 15103

def arguments
  @arguments
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



15100
15101
15102
 
# File 'lib/prism/node.rb', line 15100

def keyword_loc
  @keyword_loc
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



15193
15194
15195
 
# File 'lib/prism/node.rb', line 15193

def self.type
  :return_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



15113
15114
15115
 
# File 'lib/prism/node.rb', line 15113

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15118
15119
15120
 
# File 'lib/prism/node.rb', line 15118

def child_nodes
  [arguments]
end

#comment_targets ⇒ Object

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



15130
15131
15132
 
# File 'lib/prism/node.rb', line 15130

def comment_targets
  [keyword_loc, *arguments]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15123
15124
15125
15126
15127
 
# File 'lib/prism/node.rb', line 15123

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

#copy(**params) ⇒ Object

def copy: (**params) -> ReturnNode



15135
15136
15137
15138
15139
15140
15141
 
# File 'lib/prism/node.rb', line 15135

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]



15147
15148
15149
 
# File 'lib/prism/node.rb', line 15147

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
 
# File 'lib/prism/node.rb', line 15157

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



15152
15153
15154
 
# File 'lib/prism/node.rb', line 15152

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



15183
15184
15185
 
# File 'lib/prism/node.rb', line 15183

def type
  :return_node
end