Class: Prism::PinnedExpressionNode

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

Overview

Represents the use of the ‘^` operator for pinning an expression in a pattern matching expression.

foo in ^(bar)
       ^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(expression, operator_loc, lparen_loc, rparen_loc, location) ⇒ PinnedExpressionNode

def initialize: (expression: Node, operator_loc: Location, lparen_loc: Location, rparen_loc: Location, location: Location) -> void



13443
13444
13445
13446
13447
13448
13449
 
# File 'lib/prism/node.rb', line 13443

def initialize(expression, operator_loc, lparen_loc, rparen_loc, location)
  @expression = expression
  @operator_loc = operator_loc
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @location = location
end

Instance Attribute Details

#expression ⇒ Object (readonly)

attr_reader expression: Node



13431
13432
13433
 
# File 'lib/prism/node.rb', line 13431

def expression
  @expression
end

#lparen_loc ⇒ Object (readonly)

attr_reader lparen_loc: Location



13437
13438
13439
 
# File 'lib/prism/node.rb', line 13437

def lparen_loc
  @lparen_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



13434
13435
13436
 
# File 'lib/prism/node.rb', line 13434

def operator_loc
  @operator_loc
end

#rparen_loc ⇒ Object (readonly)

attr_reader rparen_loc: Location



13440
13441
13442
 
# File 'lib/prism/node.rb', line 13440

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



13540
13541
13542
 
# File 'lib/prism/node.rb', line 13540

def self.type
  :pinned_expression_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13452
13453
13454
 
# File 'lib/prism/node.rb', line 13452

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13457
13458
13459
 
# File 'lib/prism/node.rb', line 13457

def child_nodes
  [expression]
end

#comment_targets ⇒ Object

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



13467
13468
13469
 
# File 'lib/prism/node.rb', line 13467

def comment_targets
  [expression, operator_loc, lparen_loc, rparen_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13462
13463
13464
 
# File 'lib/prism/node.rb', line 13462

def compact_child_nodes
  [expression]
end

#copy(**params) ⇒ Object

def copy: (**params) -> PinnedExpressionNode



13472
13473
13474
13475
13476
13477
13478
13479
13480
 
# File 'lib/prism/node.rb', line 13472

def copy(**params)
  PinnedExpressionNode.new(
    params.fetch(:expression) { expression },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



13486
13487
13488
 
# File 'lib/prism/node.rb', line 13486

def deconstruct_keys(keys)
  { expression: expression, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13506
13507
13508
13509
13510
13511
13512
13513
13514
 
# File 'lib/prism/node.rb', line 13506

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── expression:\n"
  inspector << inspector.child_node(expression, "│   ")
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  inspector << "└── rparen_loc: #{inspector.location(rparen_loc)}\n"
  inspector.to_str
end

#lparen ⇒ Object

def lparen: () -> String



13496
13497
13498
 
# File 'lib/prism/node.rb', line 13496

def lparen
  lparen_loc.slice
end

#operator ⇒ Object

def operator: () -> String



13491
13492
13493
 
# File 'lib/prism/node.rb', line 13491

def operator
  operator_loc.slice
end

#rparen ⇒ Object

def rparen: () -> String



13501
13502
13503
 
# File 'lib/prism/node.rb', line 13501

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



13530
13531
13532
 
# File 'lib/prism/node.rb', line 13530

def type
  :pinned_expression_node
end