123456789_123456789_123456789_123456789_123456789_

Class: Prism::XStringNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, HeredocQuery, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c,
lib/prism/node_ext.rb

Overview

Represents an xstring literal with no interpolation.

{foo}
^^^^^

Class Method Summary

Instance Attribute Summary

HeredocQuery - Included

#heredoc?

Returns true if this node was represented as a heredoc in the source code.

Instance Method Summary

Constructor Details

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

Initialize a new XStringNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 16119



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16222



def self.type
  :x_string_node
end


  







Instance Attribute Details



  

    #forced_binary_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_binary_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16169



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


  








  

    #forced_utf8_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_utf8_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16164



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


  








  

    #unescaped   (readonly)
  



  

    
attr_reader unescaped: String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16195



attr_reader :unescaped


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16228



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


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16131



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16136



def child_nodes
  []
end


  








  

    #closing  
  



  

    
def closing: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16207



def closing
  closing_loc.slice
end


  








  

    #closing_loc  
  



  

    
attr_reader closing_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16188



def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16146



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16141



def compact_child_nodes
  []
end


  








  

    #content  
  



  

    
def content: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16202



def content
  content_loc.slice
end


  








  

    #content_loc  
  



  

    
attr_reader content_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16181



def content_loc
  location = @content_loc
  return location if location.is_a?(Location)
  @content_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #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)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16151



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16156



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16159



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16212



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16197



def opening
  opening_loc.slice
end


  








  

    #opening_loc  
  



  

    
attr_reader opening_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16174



def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #to_interpolated  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node_ext.rb', line 93



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


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 16217



def type
  :x_string_node
end