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.



17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
 
# File 'lib/prism/node.rb', line 17171

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



17288
17289
17290
 
# File 'lib/prism/node.rb', line 17288

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



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

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.



17322
17323
17324
17325
17326
17327
17328
17329
 
# File 'lib/prism/node.rb', line 17322

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



17183
17184
17185
 
# File 'lib/prism/node.rb', line 17183

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

#child_nodes ⇒ Object Also known as: deconstruct

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



17188
17189
17190
 
# File 'lib/prism/node.rb', line 17188

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String?



17301
17302
17303
 
# File 'lib/prism/node.rb', line 17301

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
 
# File 'lib/prism/node.rb', line 17269

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]



17198
17199
17200
 
# File 'lib/prism/node.rb', line 17198

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



17193
17194
17195
 
# File 'lib/prism/node.rb', line 17193

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



17203
17204
17205
 
# File 'lib/prism/node.rb', line 17203

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 }



17211
17212
17213
 
# File 'lib/prism/node.rb', line 17211

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) 


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

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


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

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


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

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

#inspect ⇒ Object

def inspect -> String



17306
17307
17308
 
# File 'lib/prism/node.rb', line 17306

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String?



17291
17292
17293
 
# File 'lib/prism/node.rb', line 17291

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
 
# File 'lib/prism/node.rb', line 17231

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.



17283
17284
17285
 
# File 'lib/prism/node.rb', line 17283

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.



17245
17246
17247
 
# File 'lib/prism/node.rb', line 17245

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.



17264
17265
17266
 
# File 'lib/prism/node.rb', line 17264

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



17311
17312
17313
 
# File 'lib/prism/node.rb', line 17311

def type
  :symbol_node
end

#value ⇒ Object

def value: () -> String?



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

def value
  value_loc&.slice
end

#value_loc ⇒ Object

attr_reader value_loc: Location?



17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
 
# File 'lib/prism/node.rb', line 17250

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