class Prism::SymbolNode

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

:foo
^^^^

%i[foo]
   ^^^

Public Class Methods

new (source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)

(Source source, Integer node_id, Location location, Integer flags, Location? opening_loc, Location? value_loc, Location? closing_loc, String unescaped) → void

Source

# File lib/prism/node.rb, line 29523
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

Initialize a new SymbolNode node.

Public Instance Methods

unescaped → String

() → String

Source

# File lib/prism/node.rb, line 29731
def unescaped
  @unescaped
end

Returns the unescaped attribute.

Flags

Public Instance Methods

forced_binary_encoding? ()

() → bool

Source

# File lib/prism/node.rb, line 29632
def forced_binary_encoding?
  flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
end

internal bytes forced the encoding to binary

forced_us_ascii_encoding? ()

() → bool

Source

# File lib/prism/node.rb, line 29640
def forced_us_ascii_encoding?
  flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING)
end

internal bytes forced the encoding to US-ASCII

forced_utf8_encoding? ()

() → bool

Source

# File lib/prism/node.rb, line 29624
def forced_utf8_encoding?
  flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
end

internal bytes forced the encoding to UTF-8

Locations

Public Instance Methods

closing_loc → Location | nil

() → Location?

Source

# File lib/prism/node.rb, line 29705
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

Returns the Location represented by closing_loc.

opening_loc → Location | nil

() → Location?

Source

# File lib/prism/node.rb, line 29651
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

Returns the Location represented by opening_loc.

value_loc → Location | nil

() → Location?

Source

# File lib/prism/node.rb, line 29678
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

Returns the Location represented by value_loc.

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

() → :symbol_node

Source

# File lib/prism/node.rb, line 29609
def self.type
  :symbol_node
end

See Node.type.

Public Instance Methods

accept (visitor)

(_Visitor visitor) → untyped

Source

# File lib/prism/node.rb, line 29548
def accept(visitor)
  visitor.visit_symbol_node(self)
end

See Node.accept.

child_nodes ()

() → Array[node?]

Source

# File lib/prism/node.rb, line 29555
def child_nodes
  []
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

() → Array[node | Location]

Source

# File lib/prism/node.rb, line 29578
def comment_targets
  [*opening_loc, *value_loc, *closing_loc] #: Array[Prism::node | Location]
end

See Node.comment_targets.

compact_child_nodes ()

() → Array[node]

Source

# File lib/prism/node.rb, line 29571
def compact_child_nodes
  []
end

See Node.compact_child_nodes.

copy(**fields) → SymbolNode

(?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location?, ?value_loc: Location?, ?closing_loc: Location?, ?unescaped: String) → SymbolNode

Source

# File lib/prism/node.rb, line 29588
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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

() → Array[node?]

Alias for: child_nodes

each_child_node (&blk)

() → Enumerator[node, void]
() { (node) → void } → void

Source

# File lib/prism/node.rb, line 29563
def each_child_node(&blk)
  return to_enum(:each_child_node) unless block_given?

end

See Node.each_child_node.

type ()

() → :symbol_node

Source

# File lib/prism/node.rb, line 29602
def type
  :symbol_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_closing_loc (repository)

(_Repository repository) → Relocation::Entry?

Source

# File lib/prism/node.rb, line 29722
def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

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

save_opening_loc (repository)

(_Repository repository) → Relocation::Entry?

Source

# File lib/prism/node.rb, line 29668
def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

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

save_value_loc (repository)

(_Repository repository) → Relocation::Entry?

Source

# File lib/prism/node.rb, line 29695
def save_value_loc(repository)
  repository.enter(node_id, :value_loc) unless @value_loc.nil?
end

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

Slicing

Public Instance Methods

closing → String | nil

() → String?

Source

# File lib/prism/node.rb, line 29763
def closing
  closing_loc&.slice
end

Slice the location of closing_loc from the source.

opening → String | nil

() → String?

Source

# File lib/prism/node.rb, line 29743
def opening
  opening_loc&.slice
end

Slice the location of opening_loc from the source.

value → String | nil

() → String?

Source

# File lib/prism/node.rb, line 29753
def value
  value_loc&.slice
end

Slice the location of value_loc from the source.