123456789_123456789_123456789_123456789_123456789_

Class: Prism::StringNode

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

Overview

Represents a string literal, a string contained within a %w list, or plain string content within an interpolated string.

"foo"
^^^^^

%w[foo]
   ^^^

"foo #{bar} baz"
 ^^^^      ^^^^

Class Method Summary

Instance Attribute Summary

HeredocQuery - Included

#heredoc?

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

Node - Inherited

#location

A Location instance that represents the location of this node in the source.
#newline?

See additional method definition at file lib/prism/node.rb line 16.

Instance Method Summary

Node - Inherited

#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#slice

Slice the location of the node from the source.
#to_dot

Convert this node into a graphviz dot graph string.
#deprecated, #newline!, #set_newline_flag

Constructor Details

.new(flags, opening_loc, content_loc, closing_loc, unescaped, location) ⇒ StringNode

def initialize: (flags: Integer, opening_loc: Location?, content_loc: Location, closing_loc: Location?, unescaped: String, location: Location) -> void

[ GitHub ] 

  


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



def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
  @flags = flags
  @opening_loc = opening_loc
  @content_loc = content_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
  @location = location
end


  







Class Method Details



  

    .type  
  



  

    

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.



def self.type: () -> Symbol


  



  [ GitHub ]


  

  


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



def self.type
  :string_node
end


  







Instance Attribute Details



  

    #closing_loc   (readonly)
  



  

    

attr_reader closing_loc: Location?


  



  [ GitHub ]


  

  


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



attr_reader :closing_loc


  








  

    #content_loc   (readonly)
  



  

    

attr_reader content_loc: Location


  



  [ GitHub ]


  

  


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



attr_reader :content_loc


  








  

    #flags   (readonly)
  

  [ GitHub ]


  

  


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



private attr_reader :flags


  








  

    #forced_binary_encoding?  ⇒ Boolean  (readonly)
  



  

    

def forced_binary_encoding?: () -> bool


  





  


  [ GitHub ]


  

  


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



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


  








  

    #forced_utf8_encoding?  ⇒ Boolean  (readonly)
  



  

    

def forced_utf8_encoding?: () -> bool


  





  


  [ GitHub ]


  

  


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



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


  








  

    #frozen?  ⇒ Boolean  (readonly)
  



  

    

def frozen?: () -> bool


  





  


  [ GitHub ]


  

  


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



def frozen?
  flags.anybits?(StringFlags::FROZEN)
end


  








  

    #opening_loc   (readonly)
  



  

    

attr_reader opening_loc: Location?


  



  [ GitHub ]


  

  


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



attr_reader :opening_loc


  








  

    #unescaped   (readonly)
  



  

    

attr_reader unescaped: String


  



  [ GitHub ]


  

  


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



attr_reader :unescaped


  







Instance Method Details



  

    #accept(visitor)  
  



  

    

def accept: (visitor: Visitor) -> void


  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

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


  



  [ GitHub ]


  

  


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



def child_nodes
  []
end


  








  

    #closing  
  



  

    

def closing: () -> String?


  



  [ GitHub ]


  

  


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



def closing
  closing_loc&.slice
end


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


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



def comment_targets
  [*opening_loc, content_loc, *closing_loc]
end


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


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



def compact_child_nodes
  []
end


  








  

    #content  
  



  

    

def content: () -> String


  



  [ GitHub ]


  

  


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



def content
  content_loc.slice
end


  








  

    #copy(**params)  
  



  

    

def copy: (**params) -> StringNode


  



  [ GitHub ]


  

  


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



def copy(**params)
  StringNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:content_loc) { content_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:unescaped) { unescaped },
    params.fetch(:location) { location },
  )
end


  








  

    #deconstruct  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]


  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end


  








  

    #inspect(inspector = NodeInspector.new)  
  



  

    

def inspect(inspector: NodeInspector) -> String


  



  [ GitHub ]


  

  


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



def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("frozen" if frozen?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector << "└── unescaped: #{unescaped.inspect}\n"
  inspector.to_str
end


  








  

    #opening  
  



  

    

def opening: () -> String?


  



  [ GitHub ]


  

  


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



def opening
  opening_loc&.slice
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 66



def to_interpolated
  InterpolatedStringNode.new(
    source,
    frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
    opening_loc,
    [copy(opening_loc: nil, closing_loc: nil, location: content_loc)],
    closing_loc,
    location
  )
end


  








  

    #type  
  



  

    

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling [cls1, cls2].include?(node.class) or putting the node into a case statement and doing case node; when cls1; when cls2; end. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.



Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.



def type: () -> Symbol


  



  [ GitHub ]


  

  


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



def type
  :string_node
end