class Prism::XStringNode

Represents an xstring literal with no interpolation.

`foo`
^^^^^

Attributes

unescaped [R]

attr_reader unescaped: String

Public Class Methods

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

Source

# File lib/prism/node.rb, line 18141
def initialize(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @content_loc = content_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
end

Initialize a new XStringNode node.

type ()

Source

# File lib/prism/node.rb, line 18263
def self.type
  :x_string_node
end

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

Public Instance Methods

=== (other)

Source

# File lib/prism/node.rb, line 18269
def ===(other)
  other.is_a?(XStringNode) &&
    (flags === other.flags) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (content_loc.nil? == other.content_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?) &&
    (unescaped === other.unescaped)
end

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

accept (visitor)

Source

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

def accept: (Visitor visitor) -> void

child_nodes ()

Source

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

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

Also aliased as: deconstruct

closing ()

Source

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

def closing: () -> String

closing_loc ()

Source

# File lib/prism/node.rb, line 18222
def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

attr_reader closing_loc: Location

comment_targets ()

Source

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

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

compact_child_nodes ()

Source

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

def compact_child_nodes: () -> Array

content ()

Source

# File lib/prism/node.rb, line 18243
def content
  content_loc.slice
end

def content: () -> String

content_loc ()

Source

# File lib/prism/node.rb, line 18209
def content_loc
  location = @content_loc
  return location if location.is_a?(Location)
  @content_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

attr_reader content_loc: Location

copy (node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)

Source

# File lib/prism/node.rb, line 18173
def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
  XStringNode.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
end

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

deconstruct ()

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

Alias for: child_nodes

deconstruct_keys (keys)

Source

# File lib/prism/node.rb, line 18181
def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped }
end

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

forced_binary_encoding? ()

Source

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

def forced_binary_encoding?: () -> bool

forced_utf8_encoding? ()

Source

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

def forced_utf8_encoding?: () -> bool

inspect ()

Source

# File lib/prism/node.rb, line 18253
def inspect
  InspectVisitor.compose(self)
end

def inspect -> String

opening ()

Source

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

def opening: () -> String

opening_loc ()

Source

# File lib/prism/node.rb, line 18196
def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

attr_reader opening_loc: Location

save_closing_loc (repository)

Source

# File lib/prism/node.rb, line 18230
def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

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

save_content_loc (repository)

Source

# File lib/prism/node.rb, line 18217
def save_content_loc(repository)
  repository.enter(node_id, :content_loc)
end

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

save_opening_loc (repository)

Source

# File lib/prism/node.rb, line 18204
def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

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

to_interpolated ()

Source

# File lib/prism/node_ext.rb, line 90
def to_interpolated
  InterpolatedXStringNode.new(
    source,
    -1,
    location,
    flags,
    opening_loc,
    [StringNode.new(source, node_id, content_loc, 0, nil, content_loc, nil, unescaped)],
    closing_loc
  )
end

Occasionally it’s helpful to treat a string as if it were interpolated so that there’s a consistent interface for working with strings.

type ()

Source

# File lib/prism/node.rb, line 18258
def type
  :x_string_node
end

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