Class: Prism::SymbolNode

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

Overview

Represents a symbol literal or a symbol contained within a ‘%i` list.

:foo
^^^^

i[foo]
   ^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped) ⇒ SymbolNode

Initialize a new SymbolNode node.



17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
 
# File 'lib/prism/node.rb', line 17374

def initialize(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @value_loc = value_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
end

Instance Attribute Details

#unescaped ⇒ Object (readonly)

attr_reader unescaped: String



17491
17492
17493
 
# File 'lib/prism/node.rb', line 17491

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



17519
17520
17521
 
# File 'lib/prism/node.rb', line 17519

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



17525
17526
17527
17528
17529
17530
17531
17532
 
# File 'lib/prism/node.rb', line 17525

def ===(other)
  other.is_a?(SymbolNode) &&
    (flags === other.flags) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (value_loc.nil? == other.value_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?) &&
    (unescaped === other.unescaped)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



17386
17387
17388
 
# File 'lib/prism/node.rb', line 17386

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



17391
17392
17393
 
# File 'lib/prism/node.rb', line 17391

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String?



17504
17505
17506
 
# File 'lib/prism/node.rb', line 17504

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
 
# File 'lib/prism/node.rb', line 17472

def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#comment_targets ⇒ Object

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



17401
17402
17403
 
# File 'lib/prism/node.rb', line 17401

def comment_targets
  [*opening_loc, *value_loc, *closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



17396
17397
17398
 
# File 'lib/prism/node.rb', line 17396

def compact_child_nodes
  []
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location?, ?value_loc: Location?, ?closing_loc: Location?, ?unescaped: String) -> SymbolNode



17406
17407
17408
 
# File 'lib/prism/node.rb', line 17406

def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
  SymbolNode.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location?, value_loc: Location?, closing_loc: Location?, unescaped: String }



17414
17415
17416
 
# File 'lib/prism/node.rb', line 17414

def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, value_loc: value_loc, closing_loc: closing_loc, unescaped: unescaped }
end

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


17424
17425
17426
 
# File 'lib/prism/node.rb', line 17424

def forced_binary_encoding?
  flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
end

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


17429
17430
17431
 
# File 'lib/prism/node.rb', line 17429

def forced_us_ascii_encoding?
  flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING)
end

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


17419
17420
17421
 
# File 'lib/prism/node.rb', line 17419

def forced_utf8_encoding?
  flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
end

#inspect ⇒ Object

def inspect -> String



17509
17510
17511
 
# File 'lib/prism/node.rb', line 17509

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



17494
17495
17496
 
# File 'lib/prism/node.rb', line 17494

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
 
# File 'lib/prism/node.rb', line 17434

def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#save_closing_loc(repository) ⇒ Object

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



17486
17487
17488
 
# File 'lib/prism/node.rb', line 17486

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

#save_opening_loc(repository) ⇒ Object

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



17448
17449
17450
 
# File 'lib/prism/node.rb', line 17448

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

#save_value_loc(repository) ⇒ Object

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



17467
17468
17469
 
# File 'lib/prism/node.rb', line 17467

def save_value_loc(repository)
  repository.enter(node_id, :value_loc) unless @value_loc.nil?
end

#type ⇒ Object

Return a symbol representation of this node type. See ‘Node#type`.



17514
17515
17516
 
# File 'lib/prism/node.rb', line 17514

def type
  :symbol_node
end

#value ⇒ Object

def value: () -> String?



17499
17500
17501
 
# File 'lib/prism/node.rb', line 17499

def value
  value_loc&.slice
end

#value_loc ⇒ Object

attr_reader value_loc: Location?



17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
 
# File 'lib/prism/node.rb', line 17453

def value_loc
  location = @value_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @value_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end