Class: Prism::ReturnNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::ReturnNode
Defined in:	lib/prism/node.rb, prism/api_node.c

Overview

Represents the use of the return keyword.

return 1
^^^^^^^^

Class Method Summary

.new(source, node_id, location, flags, keyword_loc, arguments) ⇒ ReturnNode constructor

Initialize a new ReturnNode node.
.type

Return a symbol representation of this node type.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	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.

Instance Attribute Summary

#arguments readonly

attr_reader arguments: ArgumentsNode?

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#child_nodes (also: #deconstruct)

def child_nodes: () -> Array.
#comment_targets

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

def compact_child_nodes: () -> Array.
#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?arguments: ArgumentsNode?) -> ReturnNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, arguments: ArgumentsNode? }
#each_child_node {|arguments| ... }

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

def inspect -> String.
#keyword

def keyword: () -> String.
#keyword_loc

attr_reader keyword_loc: Location.
#save_keyword_loc(repository)

Save the keyword_loc location using the given saved source so that it can be retrieved later.
#type

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

.new(source, node_id, location, flags, keyword_loc, arguments) ⇒ `ReturnNode`

Initialize a new ReturnNode node.

[ GitHub ]

# File 'lib/prism/node.rb', line 17234


def initialize(source, node_id, location, flags, keyword_loc, arguments)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @arguments = arguments
end

Class Method Details

.type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 17317


def self.type
  :return_node
end

Instance Attribute Details

#arguments (readonly)

attr_reader arguments: ArgumentsNode?

[ GitHub ]

# File 'lib/prism/node.rb', line 17299


attr_reader :arguments

Instance Method Details

#===(other)

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

[ GitHub ]

# File 'lib/prism/node.rb', line 17323


def ===(other)
  other.is_a?(ReturnNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (arguments === other.arguments)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

# File 'lib/prism/node.rb', line 17244


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 17249


def child_nodes
  [arguments]
end

#comment_targets

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

[ GitHub ]

# File 'lib/prism/node.rb', line 17268


def comment_targets
  [keyword_loc, *arguments] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 17261


def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << arguments if arguments
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?arguments: ArgumentsNode?) -> ReturnNode

[ GitHub ]

# File 'lib/prism/node.rb', line 17273


def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)
  ReturnNode.new(source, node_id, location, flags, keyword_loc, arguments)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

# File 'lib/prism/node.rb', line 17278


alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, arguments: ArgumentsNode? }

[ GitHub ]

# File 'lib/prism/node.rb', line 17281


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

#each_child_node {|arguments| ... }

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

Yields:

(arguments)

[ GitHub ]

# File 'lib/prism/node.rb', line 17254


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield arguments if arguments
end

#inspect

def inspect -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 17307


def inspect
  InspectVisitor.compose(self)
end

#keyword

def keyword: () -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 17302


def keyword
  keyword_loc.slice
end

#keyword_loc

attr_reader keyword_loc: Location

[ GitHub ]

# File 'lib/prism/node.rb', line 17286


def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_keyword_loc(repository)

Save the keyword_loc location using the given saved source so that it can be retrieved later.

[ GitHub ]

# File 'lib/prism/node.rb', line 17294


def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 17312


def type
  :return_node
end

Class: Prism::ReturnNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, keyword_loc, arguments) ⇒ ReturnNode

Class Method Details

.type

Instance Attribute Details

#arguments (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, arguments: self.arguments)

#deconstruct

#deconstruct_keys(keys)

#each_child_node {|arguments| ... }

#inspect

#keyword

#keyword_loc

#save_keyword_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, keyword_loc, arguments) ⇒ `ReturnNode`