Class: Prism::WhileNode
- Inherits:
-
PrismNode
- Object
- PrismNode
- Prism::WhileNode
- Defined in:
- lib/prism/node.rb,
lib/prism/parse_result/newlines.rb,
ext/prism/api_node.c
Overview
Represents the use of the ‘while` keyword, either in the block form or the modifier form.
while foo
^^^^^^^^^^^^^
while foo do end
^^^^^^^^^^^^^^^^^^^^
Instance Attribute Summary collapse
-
#predicate ⇒ Object
readonly
attr_reader predicate: Prism::node.
-
#statements ⇒ Object
readonly
attr_reader statements: StatementsNode?.
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.
-
#begin_modifier? ⇒ Boolean
def begin_modifier?: () -> bool.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array.
-
#closing ⇒ Object
def closing: () -> String?.
-
#closing_loc ⇒ Object
attr_reader closing_loc: Location?.
-
#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, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?do_keyword_loc: Location?, ?closing_loc: Location?, ?predicate: Prism::node, ?statements: StatementsNode?) -> WhileNode.
-
#deconstruct_keys(keys) ⇒ Object
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, do_keyword_loc: Location?, closing_loc: Location?, predicate: Prism::node, statements: StatementsNode? }.
-
#do_keyword ⇒ Object
def do_keyword: () -> String?.
-
#do_keyword_loc ⇒ Object
attr_reader do_keyword_loc: Location?.
-
#initialize(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements) ⇒ WhileNode
constructor
Initialize a new WhileNode node.
-
#inspect ⇒ Object
def inspect -> String.
-
#keyword ⇒ Object
def keyword: () -> String.
-
#keyword_loc ⇒ Object
attr_reader keyword_loc: Location.
-
#newline_flag!(lines) ⇒ Object
:nodoc:.
-
#save_closing_loc(repository) ⇒ Object
Save the closing_loc location using the given saved source so that it can be retrieved later.
-
#save_do_keyword_loc(repository) ⇒ Object
Save the do_keyword_loc location using the given saved source so that it can be retrieved later.
-
#save_keyword_loc(repository) ⇒ Object
Save the keyword_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, keyword_loc, do_keyword_loc, closing_loc, predicate, statements) ⇒ WhileNode
Initialize a new WhileNode node.
18185 18186 18187 18188 18189 18190 18191 18192 18193 18194 18195 |
# File 'lib/prism/node.rb', line 18185 def initialize(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements) @source = source @node_id = node_id @location = location @flags = flags @keyword_loc = keyword_loc @do_keyword_loc = do_keyword_loc @closing_loc = closing_loc @predicate = predicate @statements = statements end |
Instance Attribute Details
#predicate ⇒ Object (readonly)
attr_reader predicate: Prism::node
18290 18291 18292 |
# File 'lib/prism/node.rb', line 18290 def predicate @predicate end |
#statements ⇒ Object (readonly)
attr_reader statements: StatementsNode?
18293 18294 18295 |
# File 'lib/prism/node.rb', line 18293 def statements @statements end |
Class Method Details
.type ⇒ Object
Return a symbol representation of this node type. See ‘Node::type`.
18321 18322 18323 |
# File 'lib/prism/node.rb', line 18321 def self.type :while_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.
18327 18328 18329 18330 18331 18332 18333 18334 18335 |
# File 'lib/prism/node.rb', line 18327 def ===(other) other.is_a?(WhileNode) && (flags === other.flags) && (keyword_loc.nil? == other.keyword_loc.nil?) && (do_keyword_loc.nil? == other.do_keyword_loc.nil?) && (closing_loc.nil? == other.closing_loc.nil?) && (predicate === other.predicate) && (statements === other.statements) end |
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void
18198 18199 18200 |
# File 'lib/prism/node.rb', line 18198 def accept(visitor) visitor.visit_while_node(self) end |
#begin_modifier? ⇒ Boolean
def begin_modifier?: () -> bool
18234 18235 18236 |
# File 'lib/prism/node.rb', line 18234 def begin_modifier? flags.anybits?(LoopFlags::BEGIN_MODIFIER) end |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array
18203 18204 18205 |
# File 'lib/prism/node.rb', line 18203 def child_nodes [predicate, statements] end |
#closing ⇒ Object
def closing: () -> String?
18306 18307 18308 |
# File 'lib/prism/node.rb', line 18306 def closing closing_loc&.slice end |
#closing_loc ⇒ Object
attr_reader closing_loc: Location?
18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 |
# File 'lib/prism/node.rb', line 18271 def closing_loc location = @closing_loc case location when nil nil when Location location else @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
18216 18217 18218 |
# File 'lib/prism/node.rb', line 18216 def comment_targets [keyword_loc, *do_keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location] end |
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array
18208 18209 18210 18211 18212 18213 |
# File 'lib/prism/node.rb', line 18208 def compact_child_nodes compact = [] #: Array[Prism::node] compact << predicate compact << statements if statements compact end |
#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?do_keyword_loc: Location?, ?closing_loc: Location?, ?predicate: Prism::node, ?statements: StatementsNode?) -> WhileNode
18221 18222 18223 |
# File 'lib/prism/node.rb', line 18221 def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements) WhileNode.new(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements) end |
#deconstruct_keys(keys) ⇒ Object
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, do_keyword_loc: Location?, closing_loc: Location?, predicate: Prism::node, statements: StatementsNode? }
18229 18230 18231 |
# File 'lib/prism/node.rb', line 18229 def deconstruct_keys(keys) { node_id: node_id, location: location, keyword_loc: keyword_loc, do_keyword_loc: do_keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements } end |
#do_keyword ⇒ Object
def do_keyword: () -> String?
18301 18302 18303 |
# File 'lib/prism/node.rb', line 18301 def do_keyword do_keyword_loc&.slice end |
#do_keyword_loc ⇒ Object
attr_reader do_keyword_loc: Location?
18252 18253 18254 18255 18256 18257 18258 18259 18260 18261 18262 |
# File 'lib/prism/node.rb', line 18252 def do_keyword_loc location = @do_keyword_loc case location when nil nil when Location location else @do_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end |
#inspect ⇒ Object
def inspect -> String
18311 18312 18313 |
# File 'lib/prism/node.rb', line 18311 def inspect InspectVisitor.compose(self) end |
#keyword ⇒ Object
def keyword: () -> String
18296 18297 18298 |
# File 'lib/prism/node.rb', line 18296 def keyword keyword_loc.slice end |
#keyword_loc ⇒ Object
attr_reader keyword_loc: Location
18239 18240 18241 18242 18243 |
# File 'lib/prism/node.rb', line 18239 def keyword_loc location = @keyword_loc return location if location.is_a?(Location) @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end |
#newline_flag!(lines) ⇒ Object
:nodoc:
110 111 112 |
# File 'lib/prism/parse_result/newlines.rb', line 110 def newline_flag!(lines) # :nodoc: predicate.newline_flag!(lines) end |
#save_closing_loc(repository) ⇒ Object
Save the closing_loc location using the given saved source so that it can be retrieved later.
18285 18286 18287 |
# File 'lib/prism/node.rb', line 18285 def save_closing_loc(repository) repository.enter(node_id, :closing_loc) unless @closing_loc.nil? end |
#save_do_keyword_loc(repository) ⇒ Object
Save the do_keyword_loc location using the given saved source so that it can be retrieved later.
18266 18267 18268 |
# File 'lib/prism/node.rb', line 18266 def save_do_keyword_loc(repository) repository.enter(node_id, :do_keyword_loc) unless @do_keyword_loc.nil? end |
#save_keyword_loc(repository) ⇒ Object
Save the keyword_loc location using the given saved source so that it can be retrieved later.
18247 18248 18249 |
# File 'lib/prism/node.rb', line 18247 def save_keyword_loc(repository) repository.enter(node_id, :keyword_loc) end |
#type ⇒ Object
Return a symbol representation of this node type. See ‘Node#type`.
18316 18317 18318 |
# File 'lib/prism/node.rb', line 18316 def type :while_node end |