Class: Prism::FlipFlopNode

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

Overview

Represents the use of the ‘..` or `…` operators to create flip flops.

baz if foo .. bar
       ^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, left, right, operator_loc, location) ⇒ FlipFlopNode

def initialize: (flags: Integer, left: Node?, right: Node?, operator_loc: Location, location: Location) -> void



6249
6250
6251
6252
6253
6254
6255
 
# File 'lib/prism/node.rb', line 6249

def initialize(flags, left, right, operator_loc, location)
  @flags = flags
  @left = left
  @right = right
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



6237
6238
6239
 
# File 'lib/prism/node.rb', line 6237

def flags
  @flags
end

#left ⇒ Object (readonly)

attr_reader left: Node?



6240
6241
6242
 
# File 'lib/prism/node.rb', line 6240

def left
  @left
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



6246
6247
6248
 
# File 'lib/prism/node.rb', line 6246

def operator_loc
  @operator_loc
end

#right ⇒ Object (readonly)

attr_reader right: Node?



6243
6244
6245
 
# File 'lib/prism/node.rb', line 6243

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



6354
6355
6356
 
# File 'lib/prism/node.rb', line 6354

def self.type
  :flip_flop_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



6258
6259
6260
 
# File 'lib/prism/node.rb', line 6258

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6263
6264
6265
 
# File 'lib/prism/node.rb', line 6263

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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



6276
6277
6278
 
# File 'lib/prism/node.rb', line 6276

def comment_targets
  [*left, *right, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6268
6269
6270
6271
6272
6273
 
# File 'lib/prism/node.rb', line 6268

def compact_child_nodes
  compact = []
  compact << left if left
  compact << right if right
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> FlipFlopNode



6281
6282
6283
6284
6285
6286
6287
6288
6289
 
# File 'lib/prism/node.rb', line 6281

def copy(**params)
  FlipFlopNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:left) { left },
    params.fetch(:right) { right },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



6295
6296
6297
 
# File 'lib/prism/node.rb', line 6295

def deconstruct_keys(keys)
  { flags: flags, left: left, right: right, operator_loc: operator_loc, location: location }
end

#exclude_end? ⇒ Boolean

def exclude_end?: () -> bool

Returns:

  • (Boolean) 


6300
6301
6302
 
# File 'lib/prism/node.rb', line 6300

def exclude_end?
  flags.anybits?(RangeFlags::EXCLUDE_END)
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
 
# File 'lib/prism/node.rb', line 6310

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("exclude_end" if exclude_end?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  if (left = self.left).nil?
    inspector << "├── left: ∅\n"
  else
    inspector << "├── left:\n"
    inspector << left.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  if (right = self.right).nil?
    inspector << "├── right: ∅\n"
  else
    inspector << "├── right:\n"
    inspector << right.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



6305
6306
6307
 
# File 'lib/prism/node.rb', line 6305

def operator
  operator_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



6344
6345
6346
 
# File 'lib/prism/node.rb', line 6344

def type
  :flip_flop_node
end