Class: Prism::SuperNode

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

Overview

Represents the use of the ‘super` keyword with parentheses or arguments.

super()
^^^^^^^

super foo, bar
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(keyword_loc, lparen_loc, arguments, rparen_loc, block, location) ⇒ SuperNode

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



16026
16027
16028
16029
16030
16031
16032
16033
 
# File 'lib/prism/node.rb', line 16026

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



16017
16018
16019
 
# File 'lib/prism/node.rb', line 16017

def arguments
  @arguments
end

#block ⇒ Object (readonly)

attr_reader block: Node?



16023
16024
16025
 
# File 'lib/prism/node.rb', line 16023

def block
  @block
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



16011
16012
16013
 
# File 'lib/prism/node.rb', line 16011

def keyword_loc
  @keyword_loc
end

#lparen_loc ⇒ Object (readonly)

attr_reader lparen_loc: Location?



16014
16015
16016
 
# File 'lib/prism/node.rb', line 16014

def lparen_loc
  @lparen_loc
end

#rparen_loc ⇒ Object (readonly)

attr_reader rparen_loc: Location?



16020
16021
16022
 
# File 'lib/prism/node.rb', line 16020

def rparen_loc
  @rparen_loc
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



16138
16139
16140
 
# File 'lib/prism/node.rb', line 16138

def self.type
  :super_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



16036
16037
16038
 
# File 'lib/prism/node.rb', line 16036

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16041
16042
16043
 
# File 'lib/prism/node.rb', line 16041

def child_nodes
  [arguments, block]
end

#comment_targets ⇒ Object

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



16054
16055
16056
 
# File 'lib/prism/node.rb', line 16054

def comment_targets
  [keyword_loc, *lparen_loc, *arguments, *rparen_loc, *block]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16046
16047
16048
16049
16050
16051
 
# File 'lib/prism/node.rb', line 16046

def compact_child_nodes
  compact = []
  compact << arguments if arguments
  compact << block if block
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> SuperNode



16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
 
# File 'lib/prism/node.rb', line 16059

def copy(**params)
  SuperNode.new(
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:arguments) { arguments },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:block) { block },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



16074
16075
16076
 
# File 'lib/prism/node.rb', line 16074

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
 
# File 'lib/prism/node.rb', line 16094

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  if (arguments = self.arguments).nil?
    inspector << "├── arguments: ∅\n"
  else
    inspector << "├── arguments:\n"
    inspector << arguments.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
  if (block = self.block).nil?
    inspector << "└── block: ∅\n"
  else
    inspector << "└── block:\n"
    inspector << block.inspect(inspector.child_inspector("    ")).delete_prefix(inspector.prefix)
  end
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



16079
16080
16081
 
# File 'lib/prism/node.rb', line 16079

def keyword
  keyword_loc.slice
end

#lparen ⇒ Object

def lparen: () -> String?



16084
16085
16086
 
# File 'lib/prism/node.rb', line 16084

def lparen
  lparen_loc&.slice
end

#rparen ⇒ Object

def rparen: () -> String?



16089
16090
16091
 
# File 'lib/prism/node.rb', line 16089

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



16128
16129
16130
 
# File 'lib/prism/node.rb', line 16128

def type
  :super_node
end