Class: Prism::DefinedNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘defined?` keyword.

defined?(a)
^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lparen_loc, value, rparen_loc, keyword_loc, location) ⇒ DefinedNode

def initialize: (lparen_loc: Location?, value: Node, rparen_loc: Location?, keyword_loc: Location, location: Location) -> void



5458
5459
5460
5461
5462
5463
5464
 
# File 'lib/prism/node.rb', line 5458

def initialize(lparen_loc, value, rparen_loc, keyword_loc, location)
  @lparen_loc = lparen_loc
  @value = value
  @rparen_loc = rparen_loc
  @keyword_loc = keyword_loc
  @location = location
end

Instance Attribute Details

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



5455
5456
5457
 
# File 'lib/prism/node.rb', line 5455

def keyword_loc
  @keyword_loc
end

#lparen_loc ⇒ Object (readonly)

attr_reader lparen_loc: Location?



5446
5447
5448
 
# File 'lib/prism/node.rb', line 5446

def lparen_loc
  @lparen_loc
end

#rparen_loc ⇒ Object (readonly)

attr_reader rparen_loc: Location?



5452
5453
5454
 
# File 'lib/prism/node.rb', line 5452

def rparen_loc
  @rparen_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



5449
5450
5451
 
# File 'lib/prism/node.rb', line 5449

def value
  @value
end

Class Method Details

.type ⇒ Object

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



5555
5556
5557
 
# File 'lib/prism/node.rb', line 5555

def self.type
  :defined_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



5467
5468
5469
 
# File 'lib/prism/node.rb', line 5467

def accept(visitor)
  visitor.visit_defined_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



5472
5473
5474
 
# File 'lib/prism/node.rb', line 5472

def child_nodes
  [value]
end

#comment_targets ⇒ Object

def comment_targets: () -> Array[Node | Location]



5482
5483
5484
 
# File 'lib/prism/node.rb', line 5482

def comment_targets
  [*lparen_loc, value, *rparen_loc, keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5477
5478
5479
 
# File 'lib/prism/node.rb', line 5477

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> DefinedNode



5487
5488
5489
5490
5491
5492
5493
5494
5495
 
# File 'lib/prism/node.rb', line 5487

def copy(**params)
  DefinedNode.new(
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:value) { value },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



5501
5502
5503
 
# File 'lib/prism/node.rb', line 5501

def deconstruct_keys(keys)
  { lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



5521
5522
5523
5524
5525
5526
5527
5528
5529
 
# File 'lib/prism/node.rb', line 5521

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

#keyword ⇒ Object

def keyword: () -> String



5516
5517
5518
 
# File 'lib/prism/node.rb', line 5516

def keyword
  keyword_loc.slice
end

#lparen ⇒ Object

def lparen: () -> String?



5506
5507
5508
 
# File 'lib/prism/node.rb', line 5506

def lparen
  lparen_loc&.slice
end

#rparen ⇒ Object

def rparen: () -> String?



5511
5512
5513
 
# File 'lib/prism/node.rb', line 5511

def rparen
  rparen_loc&.slice
end

#type ⇒ Object

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



5545
5546
5547
 
# File 'lib/prism/node.rb', line 5545

def type
  :defined_node
end