Class: Prism::DefNode

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

Overview

Represents a method definition.

def method
end
^^^^^^^^^^

Class Method Summary

.new(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc) ⇒ DefNode constructor

Initialize a new DefNode 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

#body readonly

attr_reader body: StatementsNode | BeginNode | nil.
#locals readonly

attr_reader locals: Array.
#name readonly

attr_reader name: Symbol.
#parameters readonly

attr_reader parameters: ParametersNode?
#receiver readonly

attr_reader receiver: Prism.node?

`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, name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?receiver: Prism.node?, ?parameters: ParametersNode?, ?body: StatementsNode | BeginNode | nil, ?locals: Array, ?def_keyword_loc: Location, ?operator_loc: Location?, ?lparen_loc: Location?, ?rparen_loc: Location?, ?equal_loc: Location?, ?end_keyword_loc: Location?) -> DefNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, receiver: Prism.node?, parameters: ParametersNode?, body: StatementsNode | BeginNode | nil, locals: Array, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location? }
#def_keyword

def def_keyword: () -> String.
#def_keyword_loc

attr_reader def_keyword_loc: Location.
#each_child_node {|receiver| ... }

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

def end_keyword: () -> String?
#end_keyword_loc

attr_reader end_keyword_loc: Location?
#equal

def equal: () -> String?
#equal_loc

attr_reader equal_loc: Location?
#inspect

def inspect -> String.
#lparen

def lparen: () -> String?
#lparen_loc

attr_reader lparen_loc: Location?
#name_loc

attr_reader name_loc: Location.
#operator

def operator: () -> String?
#operator_loc

attr_reader operator_loc: Location?
#rparen

def rparen: () -> String?
#rparen_loc

attr_reader rparen_loc: Location?
#save_def_keyword_loc(repository)

Save the def_keyword_loc location using the given saved source so that it can be retrieved later.
#save_end_keyword_loc(repository)

Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
#save_equal_loc(repository)

Save the equal_loc location using the given saved source so that it can be retrieved later.
#save_lparen_loc(repository)

Save the lparen_loc location using the given saved source so that it can be retrieved later.
#save_name_loc(repository)

Save the name_loc location using the given saved source so that it can be retrieved later.
#save_operator_loc(repository)

Save the operator_loc location using the given saved source so that it can be retrieved later.
#save_rparen_loc(repository)

Save the rparen_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, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc) ⇒ `DefNode`

Initialize a new DefNode node.

[ GitHub ]

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


def initialize(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @receiver = receiver
  @parameters = parameters
  @body = body
  @locals = locals
  @def_keyword_loc = def_keyword_loc
  @operator_loc = operator_loc
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @equal_loc = equal_loc
  @end_keyword_loc = end_keyword_loc
end

Class Method Details

.type

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

[ GitHub ]

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


def self.type
  :def_node
end

Instance Attribute Details

#body (readonly)

attr_reader body: StatementsNode | BeginNode | nil

[ GitHub ]

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


attr_reader :body

#locals (readonly)

attr_reader locals: Array

[ GitHub ]

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


attr_reader :locals

#name (readonly)

attr_reader name: Symbol

[ GitHub ]

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


attr_reader :name

#parameters (readonly)

attr_reader parameters: ParametersNode?

[ GitHub ]

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


attr_reader :parameters

#receiver (readonly)

attr_reader receiver: Prism.node?

[ GitHub ]

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


attr_reader :receiver

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 6524


def ===(other)
  other.is_a?(DefNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (receiver === other.receiver) &&
    (parameters === other.parameters) &&
    (body === other.body) &&
    (locals.length == other.locals.length) &&
    locals.zip(other.locals).all? { |left, right| left === right } &&
    (def_keyword_loc.nil? == other.def_keyword_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (rparen_loc.nil? == other.rparen_loc.nil?) &&
    (equal_loc.nil? == other.equal_loc.nil?) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

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


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

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


def child_nodes
  [receiver, parameters, body]
end

#comment_targets

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

[ GitHub ]

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


def comment_targets
  [name_loc, *receiver, *parameters, *body, def_keyword_loc, *operator_loc, *lparen_loc, *rparen_loc, *equal_loc, *end_keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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


def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << receiver if receiver
  compact << parameters if parameters
  compact << body if body
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?receiver: Prism.node?, ?parameters: ParametersNode?, ?body: StatementsNode | BeginNode | nil, ?locals: Array, ?def_keyword_loc: Location, ?operator_loc: Location?, ?lparen_loc: Location?, ?rparen_loc: Location?, ?equal_loc: Location?, ?end_keyword_loc: Location?) -> DefNode

[ GitHub ]

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


def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc)
  DefNode.new(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

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


alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, receiver: Prism.node?, parameters: ParametersNode?, body: StatementsNode | BeginNode | nil, locals: Array, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location? }

[ GitHub ]

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


def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, name_loc: name_loc, receiver: receiver, parameters: parameters, body: body, locals: locals, def_keyword_loc: def_keyword_loc, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, equal_loc: equal_loc, end_keyword_loc: end_keyword_loc }
end

#def_keyword

def def_keyword: () -> String

[ GitHub ]

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


def def_keyword
  def_keyword_loc.slice
end

#def_keyword_loc

attr_reader def_keyword_loc: Location

[ GitHub ]

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


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

#each_child_node {|receiver| ... }

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

Yields:

(receiver)

[ GitHub ]

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


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield receiver if receiver
  yield parameters if parameters
  yield body if body
end

#end_keyword

def end_keyword: () -> String?

[ GitHub ]

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


def end_keyword
  end_keyword_loc&.slice
end

#end_keyword_loc

attr_reader end_keyword_loc: Location?

[ GitHub ]

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


def end_keyword_loc
  location = @end_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#equal

def equal: () -> String?

[ GitHub ]

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


def equal
  equal_loc&.slice
end

#equal_loc

attr_reader equal_loc: Location?

[ GitHub ]

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


def equal_loc
  location = @equal_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @equal_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#inspect

def inspect -> String

[ GitHub ]

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


def inspect
  InspectVisitor.compose(self)
end

#lparen

def lparen: () -> String?

[ GitHub ]

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


def lparen
  lparen_loc&.slice
end

#lparen_loc

attr_reader lparen_loc: Location?

[ GitHub ]

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


def lparen_loc
  location = @lparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#name_loc

attr_reader name_loc: Location

[ GitHub ]

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


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

#operator

def operator: () -> String?

[ GitHub ]

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


def operator
  operator_loc&.slice
end

#operator_loc

attr_reader operator_loc: Location?

[ GitHub ]

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


def operator_loc
  location = @operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#rparen

def rparen: () -> String?

[ GitHub ]

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


def rparen
  rparen_loc&.slice
end

#rparen_loc

attr_reader rparen_loc: Location?

[ GitHub ]

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


def rparen_loc
  location = @rparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#save_def_keyword_loc(repository)

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

[ GitHub ]

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


def save_def_keyword_loc(repository)
  repository.enter(node_id, :def_keyword_loc)
end

#save_end_keyword_loc(repository)

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

[ GitHub ]

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


def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
end

#save_equal_loc(repository)

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

[ GitHub ]

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


def save_equal_loc(repository)
  repository.enter(node_id, :equal_loc) unless @equal_loc.nil?
end

#save_lparen_loc(repository)

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

[ GitHub ]

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


def save_lparen_loc(repository)
  repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
end

#save_name_loc(repository)

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

[ GitHub ]

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


def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

#save_operator_loc(repository)

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

[ GitHub ]

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


def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
end

#save_rparen_loc(repository)

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

[ GitHub ]

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


def save_rparen_loc(repository)
  repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
end

#type

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

[ GitHub ]

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


def type
  :def_node
end

Class: Prism::DefNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc) ⇒ DefNode

Class Method Details

.type

Instance Attribute Details

#body (readonly)

#locals (readonly)

#name (readonly)

#parameters (readonly)

#receiver (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

#deconstruct

#deconstruct_keys(keys)

#def_keyword

#def_keyword_loc

#each_child_node {|receiver| ... }

#end_keyword

#end_keyword_loc

#equal

#equal_loc

#inspect

#lparen

#lparen_loc

#name_loc

#operator

#operator_loc

#rparen

#rparen_loc

#save_def_keyword_loc(repository)

#save_end_keyword_loc(repository)

#save_equal_loc(repository)

#save_lparen_loc(repository)

#save_name_loc(repository)

#save_operator_loc(repository)

#save_rparen_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc) ⇒ `DefNode`