Class: Prism::DefNode

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

Overview

Represents a method definition.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#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) ⇒ DefNode

Initialize a new DefNode node.



5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
 
# File 'lib/prism/node.rb', line 5950

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

Instance Attribute Details

#body ⇒ Object (readonly)

attr_reader body: StatementsNode | BeginNode | nil



6029
6030
6031
 
# File 'lib/prism/node.rb', line 6029

def body
  @body
end

#locals ⇒ Object (readonly)

attr_reader locals: Array



6032
6033
6034
 
# File 'lib/prism/node.rb', line 6032

def locals
  @locals
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



6007
6008
6009
 
# File 'lib/prism/node.rb', line 6007

def name
  @name
end

#parameters ⇒ Object (readonly)

attr_reader parameters: ParametersNode?



6026
6027
6028
 
# File 'lib/prism/node.rb', line 6026

def parameters
  @parameters
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Prism::node?



6023
6024
6025
 
# File 'lib/prism/node.rb', line 6023

def receiver
  @receiver
end

Class Method Details

.type ⇒ Object

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



6183
6184
6185
 
# File 'lib/prism/node.rb', line 6183

def self.type
  :def_node
end

Instance Method Details

#===(other) ⇒ Object

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



6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
 
# File 'lib/prism/node.rb', line 6189

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) ⇒ Object

def accept: (Visitor visitor) -> void



5970
5971
5972
 
# File 'lib/prism/node.rb', line 5970

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



5975
5976
5977
 
# File 'lib/prism/node.rb', line 5975

def child_nodes
  [receiver, parameters, body]
end

#comment_targets ⇒ Object

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



5989
5990
5991
 
# File 'lib/prism/node.rb', line 5989

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 ⇒ Object

def compact_child_nodes: () -> Array



5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/prism/node.rb', line 5980

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) ⇒ Object

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



5994
5995
5996
 
# File 'lib/prism/node.rb', line 5994

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_keys(keys) ⇒ Object

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? }



6002
6003
6004
 
# File 'lib/prism/node.rb', line 6002

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 ⇒ Object

def def_keyword: () -> String



6143
6144
6145
 
# File 'lib/prism/node.rb', line 6143

def def_keyword
  def_keyword_loc.slice
end

#def_keyword_loc ⇒ Object

attr_reader def_keyword_loc: Location



6035
6036
6037
6038
6039
 
# File 'lib/prism/node.rb', line 6035

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 ⇒ Object

def end_keyword: () -> String?



6168
6169
6170
 
# File 'lib/prism/node.rb', line 6168

def end_keyword
  end_keyword_loc&.slice
end

#end_keyword_loc ⇒ Object

attr_reader end_keyword_loc: Location?



6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
 
# File 'lib/prism/node.rb', line 6124

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 ⇒ Object

def equal: () -> String?



6163
6164
6165
 
# File 'lib/prism/node.rb', line 6163

def equal
  equal_loc&.slice
end

#equal_loc ⇒ Object

attr_reader equal_loc: Location?



6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
 
# File 'lib/prism/node.rb', line 6105

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 ⇒ Object

def inspect -> String



6173
6174
6175
 
# File 'lib/prism/node.rb', line 6173

def inspect
  InspectVisitor.compose(self)
end

#lparen ⇒ Object

def lparen: () -> String?



6153
6154
6155
 
# File 'lib/prism/node.rb', line 6153

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

attr_reader lparen_loc: Location?



6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
 
# File 'lib/prism/node.rb', line 6067

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 ⇒ Object

attr_reader name_loc: Location



6010
6011
6012
6013
6014
 
# File 'lib/prism/node.rb', line 6010

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

#operator ⇒ Object

def operator: () -> String?



6148
6149
6150
 
# File 'lib/prism/node.rb', line 6148

def operator
  operator_loc&.slice
end

#operator_loc ⇒ Object

attr_reader operator_loc: Location?



6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
 
# File 'lib/prism/node.rb', line 6048

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 ⇒ Object

def rparen: () -> String?



6158
6159
6160
 
# File 'lib/prism/node.rb', line 6158

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

attr_reader rparen_loc: Location?



6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
 
# File 'lib/prism/node.rb', line 6086

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) ⇒ Object

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



6043
6044
6045
 
# File 'lib/prism/node.rb', line 6043

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

#save_end_keyword_loc(repository) ⇒ Object

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



6138
6139
6140
 
# File 'lib/prism/node.rb', line 6138

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

#save_equal_loc(repository) ⇒ Object

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



6119
6120
6121
 
# File 'lib/prism/node.rb', line 6119

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

#save_lparen_loc(repository) ⇒ Object

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



6081
6082
6083
 
# File 'lib/prism/node.rb', line 6081

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

#save_name_loc(repository) ⇒ Object

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



6018
6019
6020
 
# File 'lib/prism/node.rb', line 6018

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

#save_operator_loc(repository) ⇒ Object

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



6062
6063
6064
 
# File 'lib/prism/node.rb', line 6062

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

#save_rparen_loc(repository) ⇒ Object

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



6100
6101
6102
 
# File 'lib/prism/node.rb', line 6100

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

#type ⇒ Object

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



6178
6179
6180
 
# File 'lib/prism/node.rb', line 6178

def type
  :def_node
end