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(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc) ⇒ DefinedNode

Initialize a new DefinedNode node.



6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
 
# File 'lib/prism/node.rb', line 6567

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

Instance Attribute Details

#value ⇒ Object (readonly)

attr_reader value: Prism::node



6638
6639
6640
 
# File 'lib/prism/node.rb', line 6638

def value
  @value
end

Class Method Details

.type ⇒ Object

Return a symbol representation of this node type. See Node::type.



6698
6699
6700
 
# File 'lib/prism/node.rb', line 6698

def self.type
  :defined_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.



6704
6705
6706
6707
6708
6709
6710
 
# File 'lib/prism/node.rb', line 6704

def ===(other)
  other.is_a?(DefinedNode) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (value === other.value) &&
    (rparen_loc.nil? == other.rparen_loc.nil?) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



6579
6580
6581
 
# File 'lib/prism/node.rb', line 6579

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



6584
6585
6586
 
# File 'lib/prism/node.rb', line 6584

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



6601
6602
6603
 
# File 'lib/prism/node.rb', line 6601

def comment_targets
  [*lparen_loc, value, *rparen_loc, keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6596
6597
6598
 
# File 'lib/prism/node.rb', line 6596

def compact_child_nodes
  [value]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?lparen_loc: Location?, ?value: Prism::node, ?rparen_loc: Location?, ?keyword_loc: Location) -> DefinedNode



6606
6607
6608
 
# File 'lib/prism/node.rb', line 6606

def copy(node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc)
  DefinedNode.new(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, lparen_loc: Location?, value: Prism::node, rparen_loc: Location?, keyword_loc: Location }



6614
6615
6616
 
# File 'lib/prism/node.rb', line 6614

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

#each_child_node {|value| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



6589
6590
6591
6592
6593
 
# File 'lib/prism/node.rb', line 6589

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

#inspect ⇒ Object

def inspect -> String



6688
6689
6690
 
# File 'lib/prism/node.rb', line 6688

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



6683
6684
6685
 
# File 'lib/prism/node.rb', line 6683

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



6660
6661
6662
6663
6664
 
# File 'lib/prism/node.rb', line 6660

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#lparen ⇒ Object

def lparen: () -> String?



6673
6674
6675
 
# File 'lib/prism/node.rb', line 6673

def lparen
  lparen_loc&.slice
end

#lparen_loc ⇒ Object

attr_reader lparen_loc: Location?



6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
 
# File 'lib/prism/node.rb', line 6619

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

#rparen ⇒ Object

def rparen: () -> String?



6678
6679
6680
 
# File 'lib/prism/node.rb', line 6678

def rparen
  rparen_loc&.slice
end

#rparen_loc ⇒ Object

attr_reader rparen_loc: Location?



6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
 
# File 'lib/prism/node.rb', line 6641

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_keyword_loc(repository) ⇒ Object

Save the keyword_loc location using the given saved source so that it can be retrieved later.



6668
6669
6670
 
# File 'lib/prism/node.rb', line 6668

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#save_lparen_loc(repository) ⇒ Object

Save the lparen_loc location using the given saved source so that it can be retrieved later.



6633
6634
6635
 
# File 'lib/prism/node.rb', line 6633

def save_lparen_loc(repository)
  repository.enter(node_id, :lparen_loc) unless @lparen_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.



6655
6656
6657
 
# File 'lib/prism/node.rb', line 6655

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`.



6693
6694
6695
 
# File 'lib/prism/node.rb', line 6693

def type
  :defined_node
end