Class: Prism::DefNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, PrismNode
Instance Chain: self, PrismNode
Inherits:	PrismNode `::Object` PrismNode Prism::DefNode
Defined in:	lib/prism/node.rb, ext/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.

Instance Attribute Summary

#body readonly

attr_reader body: Prism.node?
#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?

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[nil | Node].
#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: Prism.node?, ?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: Prism.node?, 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.
#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?
#type

Return a symbol representation of this node type.

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 4999


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 5185


def self.type
  :def_node
end

Instance Attribute Details

#body (readonly)

attr_reader body: Prism.node?

[ GitHub ]

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


attr_reader :body

#locals (readonly)

attr_reader locals: Array

[ GitHub ]

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


attr_reader :locals

#name (readonly)

attr_reader name: Symbol

[ GitHub ]

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


attr_reader :name

#parameters (readonly)

attr_reader parameters: ParametersNode?

[ GitHub ]

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


attr_reader :parameters

#receiver (readonly)

attr_reader receiver: Prism.node?

[ GitHub ]

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


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 5191


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 5019


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

#child_nodes Also known as: #deconstruct

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

[ GitHub ]

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


def child_nodes
  [receiver, parameters, body]
end

#comment_targets

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

[ GitHub ]

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


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 5029


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: Prism.node?, ?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 5043


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 5048


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: Prism.node?, 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 5051


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 5145


def def_keyword
  def_keyword_loc.slice
end

#def_keyword_loc

attr_reader def_keyword_loc: Location

[ GitHub ]

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


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

#end_keyword

def end_keyword: () -> String?

[ GitHub ]

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


def end_keyword
  end_keyword_loc&.slice
end

#end_keyword_loc

attr_reader end_keyword_loc: Location?

[ GitHub ]

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


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 5165


def equal
  equal_loc&.slice
end

#equal_loc

attr_reader equal_loc: Location?

[ GitHub ]

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


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 5175


def inspect
  InspectVisitor.compose(self)
end

#lparen

def lparen: () -> String?

[ GitHub ]

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


def lparen
  lparen_loc&.slice
end

#lparen_loc

attr_reader lparen_loc: Location?

[ GitHub ]

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


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 5058


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 5150


def operator
  operator_loc&.slice
end

#operator_loc

attr_reader operator_loc: Location?

[ GitHub ]

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


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 5160


def rparen
  rparen_loc&.slice
end

#rparen_loc

attr_reader rparen_loc: Location?

[ GitHub ]

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


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

#type

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

[ GitHub ]

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


def type
  :def_node
end

Class: Prism::DefNode

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

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

#end_keyword

#end_keyword_loc

#equal

#equal_loc

#inspect

#lparen

#lparen_loc

#name_loc

#operator

#operator_loc

#rparen

#rparen_loc

#type

.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`