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.



17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
 
# File 'lib/prism/node.rb', line 17203

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



17320
17321
17322
 
# File 'lib/prism/node.rb', line 17320

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



17348
17349
17350
 
# File 'lib/prism/node.rb', line 17348

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.



17354
17355
17356
17357
17358
17359
17360
17361
 
# File 'lib/prism/node.rb', line 17354

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



17215
17216
17217
 
# File 'lib/prism/node.rb', line 17215

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

#child_nodes ⇒ Object Also known as: deconstruct

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



17220
17221
17222
 
# File 'lib/prism/node.rb', line 17220

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String?



17333
17334
17335
 
# File 'lib/prism/node.rb', line 17333

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
 
# File 'lib/prism/node.rb', line 17301

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]



17230
17231
17232
 
# File 'lib/prism/node.rb', line 17230

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



17225
17226
17227
 
# File 'lib/prism/node.rb', line 17225

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



17235
17236
17237
 
# File 'lib/prism/node.rb', line 17235

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 }



17243
17244
17245
 
# File 'lib/prism/node.rb', line 17243

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



17253
17254
17255
 
# File 'lib/prism/node.rb', line 17253

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool



17258
17259
17260
 
# File 'lib/prism/node.rb', line 17258

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool



17248
17249
17250
 
# File 'lib/prism/node.rb', line 17248

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

#inspect ⇒ Object

def inspect -> String



17338
17339
17340
 
# File 'lib/prism/node.rb', line 17338

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



17323
17324
17325
 
# File 'lib/prism/node.rb', line 17323

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
 
# File 'lib/prism/node.rb', line 17263

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.



17315
17316
17317
 
# File 'lib/prism/node.rb', line 17315

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.



17277
17278
17279
 
# File 'lib/prism/node.rb', line 17277

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.



17296
17297
17298
 
# File 'lib/prism/node.rb', line 17296

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`.



17343
17344
17345
 
# File 'lib/prism/node.rb', line 17343

def type
  :symbol_node
end

#value ⇒ Object

def value: () -> String?



17328
17329
17330
 
# File 'lib/prism/node.rb', line 17328

def value
  value_loc&.slice
end

#value_loc ⇒ Object

attr_reader value_loc: Location?



17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
 
# File 'lib/prism/node.rb', line 17282

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