class Prism::StringNode - Documentation for Ruby 4.1
Description: class Prism::StringNode: Represents a string literal, a string contained within a `%w` list, or plain string content within an interpolated string.
Keywords: ruby,class,Prism::StringNode

🔍

No recent searches

# class Prism::StringNode

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"
     ^^^^      ^^^^

### Public Class Methods

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

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

### Public Instance Methods

heredoc? ()
Source

    # File lib/prism/node_ext.rb, line 115
    def heredoc?
      HeredocQuery.heredoc?(opening)
    end

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

to_interpolated ()
Source

    # File lib/prism/node_ext.rb, line 123
    def to_interpolated
      InterpolatedStringNode.new(
        source,
        -1,
        location,
        frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
        opening_loc,
        [copy(location: content_loc, opening_loc: nil, closing_loc: nil)],
        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.

unescaped → String
Source

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

Returns the `unescaped` attribute.

## Flags

### Public Instance Methods

forced_binary_encoding? ()
Source

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

internal bytes forced the encoding to binary

forced_utf8_encoding? ()
Source

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

internal bytes forced the encoding to UTF-8

frozen? ()
Source

    # File lib/prism/node.rb, line 29101
    def frozen?
      flags.anybits?(StringFlags::FROZEN)
    end

frozen by virtue of a `frozen_string_literal: true` comment or `--enable-frozen-string-literal`

mutable? ()
Source

    # File lib/prism/node.rb, line 29109
    def mutable?
      flags.anybits?(StringFlags::MUTABLE)
    end

mutable by virtue of a `frozen_string_literal: false` comment or `--disable-frozen-string-literal`

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

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

content_loc → Location
Source

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

Returns the `Location` represented by `content_loc`.

opening_loc → Location | nil
Source

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

## Node Interface

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

### Public Class Methods

type ()
Source

    # File lib/prism/node.rb, line 29070
    def self.type
      :string_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → StringNode
Source

    # File lib/prism/node.rb, line 29049
    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)
      StringNode.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
    end

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

deconstruct ()
Alias for: child_nodes
each_child_node (&blk)
Source

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

    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 29063
    def type
      :string_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 29186
    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_content_loc (repository)
Source

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

## Slicing

### Public Instance Methods

closing → String | nil
Source

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

Slice the location of `closing_loc` from the source.

content → String
Source

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

Slice the location of `content_loc` from the source.

opening → String | nil
Source

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

Slice the location of `opening_loc` from the source.