class Prism::DefNode
Represents a method definition.
def method end ^^^^^^^^^^
Attributes
attr_reader body: StatementsNode
| BeginNode
| nil
attr_reader locals: Array
attr_reader name: Symbol
attr_reader parameters: ParametersNode
?
attr_reader receiver: Prism::node?
Public Class Methods
Initialize a new DefNode
node.
# File lib/prism/node.rb, line 5630 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
Return a symbol representation of this node type. See Node::type
.
# File lib/prism/node.rb, line 5863 def self.type :def_node end
Public Instance Methods
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File lib/prism/node.rb, line 5869 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
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 5650 def accept(visitor) visitor.visit_def_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 5655 def child_nodes [receiver, parameters, body] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 5669 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
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 5660 def compact_child_nodes compact = [] #: Array[Prism::node] compact << receiver if receiver compact << parameters if parameters compact << body if body compact end
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
# File lib/prism/node.rb, line 5674 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
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
? }
# File lib/prism/node.rb, line 5682 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 def_keyword
: () -> String
# File lib/prism/node.rb, line 5823 def def_keyword def_keyword_loc.slice end
attr_reader def_keyword_loc
: Location
# File lib/prism/node.rb, line 5715 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
def end_keyword
: () -> String?
# File lib/prism/node.rb, line 5848 def end_keyword end_keyword_loc&.slice end
attr_reader end_keyword_loc
: Location
?
# File lib/prism/node.rb, line 5804 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
def equal: () -> String?
# File lib/prism/node.rb, line 5843 def equal equal_loc&.slice end
def inspect -> String
# File lib/prism/node.rb, line 5853 def inspect InspectVisitor.compose(self) end
def lparen: () -> String?
# File lib/prism/node.rb, line 5833 def lparen lparen_loc&.slice end
attr_reader lparen_loc
: Location
?
# File lib/prism/node.rb, line 5747 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
def operator: () -> String?
# File lib/prism/node.rb, line 5828 def operator operator_loc&.slice end
attr_reader operator_loc
: Location
?
# File lib/prism/node.rb, line 5728 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
def rparen: () -> String?
# File lib/prism/node.rb, line 5838 def rparen rparen_loc&.slice end
attr_reader rparen_loc
: Location
?
# File lib/prism/node.rb, line 5766 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 the def_keyword_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5723 def save_def_keyword_loc(repository) repository.enter(node_id, :def_keyword_loc) end
Save the end_keyword_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5818 def save_end_keyword_loc(repository) repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil? end
Save the equal_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5799 def save_equal_loc(repository) repository.enter(node_id, :equal_loc) unless @equal_loc.nil? end
Save the lparen_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5761 def save_lparen_loc(repository) repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil? end
Save the name_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5698 def save_name_loc(repository) repository.enter(node_id, :name_loc) end
Save the operator_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5742 def save_operator_loc(repository) repository.enter(node_id, :operator_loc) unless @operator_loc.nil? end
Save the rparen_loc
location using the given saved source so that it can be retrieved later.
# File lib/prism/node.rb, line 5780 def save_rparen_loc(repository) repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil? end
Return a symbol representation of this node type. See Node#type
.
# File lib/prism/node.rb, line 5858 def type :def_node end