class Prism::DefinedNode
Represents the use of the ‘defined?` keyword.
defined?(a) ^^^^^^^^^^^
Attributes
attr_reader value: Prism::node
Public Class Methods
def initialize: (Location
? lparen_loc
, Prism::node value, Location
? rparen_loc
, Location
keyword_loc
, Location
location) -> void
# File lib/prism/node.rb, line 5933 def initialize(source, lparen_loc, value, rparen_loc, keyword_loc, location) @source = source @newline = false @location = location @lparen_loc = lparen_loc @value = value @rparen_loc = rparen_loc @keyword_loc = 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 6063 def self.type :defined_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 5944 def accept(visitor) visitor.visit_defined_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 5949 def child_nodes [value] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 5959 def comment_targets [*lparen_loc, value, *rparen_loc, keyword_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 5954 def compact_child_nodes [value] end
def copy: (?lparen_loc: Location
?, ?value: Prism::node, ?rparen_loc: Location
?, ?keyword_loc: Location
, ?location: Location
) -> DefinedNode
# File lib/prism/node.rb, line 5964 def copy(lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc, location: self.location) DefinedNode.new(source, lparen_loc, value, rparen_loc, keyword_loc, location) end
def deconstruct_keys
: (Array keys) -> { lparen_loc
: Location
?, value: Prism::node, rparen_loc
: Location
?, keyword_loc
: Location
, location: Location
}
# File lib/prism/node.rb, line 5972 def deconstruct_keys(keys) { lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc, location: location } end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 6029 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n" inspector << "├── value:\n" inspector << inspector.child_node(value, "│ ") inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n" inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n" inspector.to_str end
def keyword: () -> String
# File lib/prism/node.rb, line 6024 def keyword keyword_loc.slice end
attr_reader keyword_loc
: Location
# File lib/prism/node.rb, line 6006 def keyword_loc location = @keyword_loc return location if location.is_a?(Location) @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def lparen: () -> String
?
# File lib/prism/node.rb, line 6014 def lparen lparen_loc&.slice end
attr_reader lparen_loc
: Location
?
# File lib/prism/node.rb, line 5977 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 rparen: () -> String
?
# File lib/prism/node.rb, line 6019 def rparen rparen_loc&.slice end
attr_reader rparen_loc
: Location
?
# File lib/prism/node.rb, line 5993 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 6053 def type :defined_node end