Class: Prism::DefNode
- 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
^^^^^^^^^^
Instance Attribute Summary collapse
-
#body ⇒ Object
readonly
attr_reader body: StatementsNode | BeginNode | nil.
-
#locals ⇒ Object
readonly
attr_reader locals: Array.
-
#name ⇒ Object
readonly
attr_reader name: Symbol.
-
#parameters ⇒ Object
readonly
attr_reader parameters: ParametersNode?.
-
#receiver ⇒ Object
readonly
attr_reader receiver: Prism::node?.
Class Method Summary collapse
-
.type ⇒ Object
Return a symbol representation of this node type.
Instance Method Summary collapse
-
#===(other) ⇒ Object
Implements case-equality for the node.
-
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array.
-
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes ⇒ Object
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) ⇒ 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.
-
#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? }.
-
#def_keyword ⇒ Object
def def_keyword: () -> String.
-
#def_keyword_loc ⇒ Object
attr_reader def_keyword_loc: Location.
-
#end_keyword ⇒ Object
def end_keyword: () -> String?.
-
#end_keyword_loc ⇒ Object
attr_reader end_keyword_loc: Location?.
-
#equal ⇒ Object
def equal: () -> String?.
-
#equal_loc ⇒ Object
attr_reader equal_loc: Location?.
-
#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
constructor
Initialize a new DefNode node.
-
#inspect ⇒ Object
def inspect -> String.
-
#lparen ⇒ Object
def lparen: () -> String?.
-
#lparen_loc ⇒ Object
attr_reader lparen_loc: Location?.
-
#name_loc ⇒ Object
attr_reader name_loc: Location.
-
#operator ⇒ Object
def operator: () -> String?.
-
#operator_loc ⇒ Object
attr_reader operator_loc: Location?.
-
#rparen ⇒ Object
def rparen: () -> String?.
-
#rparen_loc ⇒ Object
attr_reader rparen_loc: Location?.
-
#save_def_keyword_loc(repository) ⇒ Object
Save the def_keyword_loc location using the given saved source so that it can be retrieved later.
-
#save_end_keyword_loc(repository) ⇒ Object
Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
-
#save_equal_loc(repository) ⇒ Object
Save the equal_loc location using the given saved source so that it can be retrieved later.
-
#save_lparen_loc(repository) ⇒ Object
Save the lparen_loc location using the given saved source so that it can be retrieved later.
-
#save_name_loc(repository) ⇒ Object
Save the name_loc location using the given saved source so that it can be retrieved later.
-
#save_operator_loc(repository) ⇒ Object
Save the operator_loc location using the given saved source so that it can be retrieved later.
-
#save_rparen_loc(repository) ⇒ Object
Save the rparen_loc location using the given saved source so that it can be retrieved later.
-
#type ⇒ Object
Return a symbol representation of this node type.
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.
5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 |
# File 'lib/prism/node.rb', line 5918 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
5997 5998 5999 |
# File 'lib/prism/node.rb', line 5997 def body @body end |
#locals ⇒ Object (readonly)
attr_reader locals: Array
6000 6001 6002 |
# File 'lib/prism/node.rb', line 6000 def locals @locals end |
#name ⇒ Object (readonly)
attr_reader name: Symbol
5975 5976 5977 |
# File 'lib/prism/node.rb', line 5975 def name @name end |
#parameters ⇒ Object (readonly)
attr_reader parameters: ParametersNode?
5994 5995 5996 |
# File 'lib/prism/node.rb', line 5994 def parameters @parameters end |
#receiver ⇒ Object (readonly)
attr_reader receiver: Prism::node?
5991 5992 5993 |
# File 'lib/prism/node.rb', line 5991 def receiver @receiver end |
Class Method Details
.type ⇒ Object
Return a symbol representation of this node type. See ‘Node::type`.
6151 6152 6153 |
# File 'lib/prism/node.rb', line 6151 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.
6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 |
# File 'lib/prism/node.rb', line 6157 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
5938 5939 5940 |
# File 'lib/prism/node.rb', line 5938 def accept(visitor) visitor.visit_def_node(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array
5943 5944 5945 |
# File 'lib/prism/node.rb', line 5943 def child_nodes [receiver, parameters, body] end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
5957 5958 5959 |
# File 'lib/prism/node.rb', line 5957 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
5948 5949 5950 5951 5952 5953 5954 |
# File 'lib/prism/node.rb', line 5948 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
5962 5963 5964 |
# File 'lib/prism/node.rb', line 5962 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? }
5970 5971 5972 |
# File 'lib/prism/node.rb', line 5970 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
6111 6112 6113 |
# File 'lib/prism/node.rb', line 6111 def def_keyword def_keyword_loc.slice end |
#def_keyword_loc ⇒ Object
attr_reader def_keyword_loc: Location
6003 6004 6005 6006 6007 |
# File 'lib/prism/node.rb', line 6003 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?
6136 6137 6138 |
# File 'lib/prism/node.rb', line 6136 def end_keyword end_keyword_loc&.slice end |
#end_keyword_loc ⇒ Object
attr_reader end_keyword_loc: Location?
6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 |
# File 'lib/prism/node.rb', line 6092 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?
6131 6132 6133 |
# File 'lib/prism/node.rb', line 6131 def equal equal_loc&.slice end |
#equal_loc ⇒ Object
attr_reader equal_loc: Location?
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 |
# File 'lib/prism/node.rb', line 6073 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
6141 6142 6143 |
# File 'lib/prism/node.rb', line 6141 def inspect InspectVisitor.compose(self) end |
#lparen ⇒ Object
def lparen: () -> String?
6121 6122 6123 |
# File 'lib/prism/node.rb', line 6121 def lparen lparen_loc&.slice end |
#lparen_loc ⇒ Object
attr_reader lparen_loc: Location?
6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'lib/prism/node.rb', line 6035 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
5978 5979 5980 5981 5982 |
# File 'lib/prism/node.rb', line 5978 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?
6116 6117 6118 |
# File 'lib/prism/node.rb', line 6116 def operator operator_loc&.slice end |
#operator_loc ⇒ Object
attr_reader operator_loc: Location?
6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 |
# File 'lib/prism/node.rb', line 6016 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?
6126 6127 6128 |
# File 'lib/prism/node.rb', line 6126 def rparen rparen_loc&.slice end |
#rparen_loc ⇒ Object
attr_reader rparen_loc: Location?
6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 |
# File 'lib/prism/node.rb', line 6054 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.
6011 6012 6013 |
# File 'lib/prism/node.rb', line 6011 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.
6106 6107 6108 |
# File 'lib/prism/node.rb', line 6106 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.
6087 6088 6089 |
# File 'lib/prism/node.rb', line 6087 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.
6049 6050 6051 |
# File 'lib/prism/node.rb', line 6049 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.
5986 5987 5988 |
# File 'lib/prism/node.rb', line 5986 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.
6030 6031 6032 |
# File 'lib/prism/node.rb', line 6030 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.
6068 6069 6070 |
# File 'lib/prism/node.rb', line 6068 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`.
6146 6147 6148 |
# File 'lib/prism/node.rb', line 6146 def type :def_node end |