Class: Prism::ParenthesesNode

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

Overview

Represents a parenthesized expression

(10 + 34)
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body, opening_loc, closing_loc, location) ⇒ ParenthesesNode

def initialize: (body: Node?, opening_loc: Location, closing_loc: Location, location: Location) -> void



13320
13321
13322
13323
13324
13325
 
# File 'lib/prism/node.rb', line 13320

def initialize(body, opening_loc, closing_loc, location)
  @body = body
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#body ⇒ Object (readonly)

attr_reader body: Node?



13311
13312
13313
 
# File 'lib/prism/node.rb', line 13311

def body
  @body
end

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



13317
13318
13319
 
# File 'lib/prism/node.rb', line 13317

def closing_loc
  @closing_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



13314
13315
13316
 
# File 'lib/prism/node.rb', line 13314

def opening_loc
  @opening_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



13419
13420
13421
 
# File 'lib/prism/node.rb', line 13419

def self.type
  :parentheses_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13328
13329
13330
 
# File 'lib/prism/node.rb', line 13328

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13337
13338
13339
 
# File 'lib/prism/node.rb', line 13337

def child_nodes
  [body]
end

#closing ⇒ Object

def closing: () -> String



13377
13378
13379
 
# File 'lib/prism/node.rb', line 13377

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



13349
13350
13351
 
# File 'lib/prism/node.rb', line 13349

def comment_targets
  [*body, opening_loc, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13342
13343
13344
13345
13346
 
# File 'lib/prism/node.rb', line 13342

def compact_child_nodes
  compact = []
  compact << body if body
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> ParenthesesNode



13354
13355
13356
13357
13358
13359
13360
13361
 
# File 'lib/prism/node.rb', line 13354

def copy(**params)
  ParenthesesNode.new(
    params.fetch(:body) { body },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



13367
13368
13369
 
# File 'lib/prism/node.rb', line 13367

def deconstruct_keys(keys)
  { body: body, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
 
# File 'lib/prism/node.rb', line 13382

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

#opening ⇒ Object

def opening: () -> String



13372
13373
13374
 
# File 'lib/prism/node.rb', line 13372

def opening
  opening_loc.slice
end

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



13332
13333
13334
 
# File 'lib/prism/node.rb', line 13332

def set_newline_flag(newline_marked) # :nodoc:
  # Never mark ParenthesesNode with a newline flag, mark children instead
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



13409
13410
13411
 
# File 'lib/prism/node.rb', line 13409

def type
  :parentheses_node
end