class Prism::DefNode
Represents a method definition.
def method end ^^^^^^^^^^
Attributes
attr_reader body: Prism::node?
attr_reader locals: Array
attr_reader name: Symbol
attr_reader parameters: ParametersNode
?
attr_reader receiver: Prism::node?
Public Class Methods
def initialize: (Symbol
name, Location
name_loc
, Prism::node? receiver, ParametersNode
? parameters, Prism::node? body, Array locals, Location
def_keyword_loc
, Location
? operator_loc
, Location
? lparen_loc
, Location
? rparen_loc
, Location
? equal_loc
, Location
? end_keyword_loc
, Location
location) -> void
# File lib/prism/node.rb, line 5685 def initialize(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location) @source = source @newline = false @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
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. Note that like type
, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File lib/prism/node.rb, line 5922 def self.type :def_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 5704 def accept(visitor) visitor.visit_def_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 5709 def child_nodes [receiver, parameters, body] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 5723 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 5714 def compact_child_nodes compact = [] #: Array[Prism::node] compact << receiver if receiver compact << parameters if parameters compact << body if body compact end
def copy: (?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
?, ?location: Location
) -> DefNode
# File lib/prism/node.rb, line 5728 def copy(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, location: self.location) DefNode.new(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location) end
def deconstruct_keys
: (Array keys) -> { 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
?, location: Location
}
# File lib/prism/node.rb, line 5736 def deconstruct_keys(keys) { 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, location: location } end
def def_keyword
: () -> String
# File lib/prism/node.rb, line 5836 def def_keyword def_keyword_loc.slice end
attr_reader def_keyword_loc
: Location
# File lib/prism/node.rb, line 5763 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 5861 def end_keyword end_keyword_loc&.slice end
attr_reader end_keyword_loc
: Location
?
# File lib/prism/node.rb, line 5822 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 5856 def equal equal_loc&.slice end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 5866 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── name: #{name.inspect}\n" inspector << "├── name_loc: #{inspector.location(name_loc)}\n" if (receiver = self.receiver).nil? inspector << "├── receiver: ∅\n" else inspector << "├── receiver:\n" inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end if (parameters = self.parameters).nil? inspector << "├── parameters: ∅\n" else inspector << "├── parameters:\n" inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end if (body = self.body).nil? inspector << "├── body: ∅\n" else inspector << "├── body:\n" inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix) end inspector << "├── locals: #{locals.inspect}\n" inspector << "├── def_keyword_loc: #{inspector.location(def_keyword_loc)}\n" inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n" inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n" inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n" inspector << "├── equal_loc: #{inspector.location(equal_loc)}\n" inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n" inspector.to_str end
def lparen: () -> String
?
# File lib/prism/node.rb, line 5846 def lparen lparen_loc&.slice end
attr_reader lparen_loc
: Location
?
# File lib/prism/node.rb, line 5783 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 5841 def operator operator_loc&.slice end
attr_reader operator_loc
: Location
?
# File lib/prism/node.rb, line 5770 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 5851 def rparen rparen_loc&.slice end
attr_reader rparen_loc
: Location
?
# File lib/prism/node.rb, line 5796 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
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type
, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol
# File lib/prism/node.rb, line 5912 def type :def_node end