class Prism::InterpolatedRegularExpressionNode - Documentation for Ruby 4.1
Description: class Prism::InterpolatedRegularExpressionNode: Represents a regular expression literal that contains interpolation.
Keywords: ruby,class,Prism::InterpolatedRegularExpressionNode

🔍

No recent searches

# class Prism::InterpolatedRegularExpressionNode

Represents a regular expression literal that contains interpolation.

    /foo #{bar} baz/
    ^^^^^^^^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, opening_loc, parts, closing_loc)
Source

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

Initialize a new `InterpolatedRegularExpressionNode` node.

### Public Instance Methods

options ()
Source

    # File lib/prism/node_ext.rb, line 56
    def options
      RegularExpressionOptions.options(flags)
    end

Returns a numeric value that represents the flags that were used to create the regular expression.

parts → Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode]
Source

    # File lib/prism/node.rb, line 18426
    def parts
      @parts
    end

Returns the `parts` attribute.

## Flags

### Public Instance Methods

ascii_8bit? ()
Source

    # File lib/prism/node.rb, line 18354
    def ascii_8bit?
      flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
    end

n - forces the ASCII-8BIT encoding

euc_jp? ()
Source

    # File lib/prism/node.rb, line 18346
    def euc_jp?
      flags.anybits?(RegularExpressionFlags::EUC_JP)
    end

e - forces the EUC-JP encoding

extended? ()
Source

    # File lib/prism/node.rb, line 18322
    def extended?
      flags.anybits?(RegularExpressionFlags::EXTENDED)
    end

x - ignores whitespace and allows comments in regular expressions

forced_binary_encoding? ()
Source

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

internal bytes forced the encoding to binary

forced_us_ascii_encoding? ()
Source

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

internal bytes forced the encoding to US-ASCII

forced_utf8_encoding? ()
Source

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

internal bytes forced the encoding to UTF-8

ignore_case? ()
Source

    # File lib/prism/node.rb, line 18314
    def ignore_case?
      flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
    end

i - ignores the case of characters when matching

multi_line? ()
Source

    # File lib/prism/node.rb, line 18330
    def multi_line?
      flags.anybits?(RegularExpressionFlags::MULTI_LINE)
    end

m - allows $ to match the end of lines within strings

once? ()
Source

    # File lib/prism/node.rb, line 18338
    def once?
      flags.anybits?(RegularExpressionFlags::ONCE)
    end

o - only interpolates values into the regular expression once

utf_8? ()
Source

    # File lib/prism/node.rb, line 18370
    def utf_8?
      flags.anybits?(RegularExpressionFlags::UTF_8)
    end

u - forces the UTF-8 encoding

windows_31j? ()
Source

    # File lib/prism/node.rb, line 18362
    def windows_31j?
      flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
    end

s - forces the Windows-31J encoding

## Locations

### Public Instance Methods

closing_loc → Location
Source

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

Returns the `Location` represented by `closing_loc`.

opening_loc → Location
Source

    # File lib/prism/node.rb, line 18405
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    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 18299
    def self.type
      :interpolated_regular_expression_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 18244
    def child_nodes
      [*parts]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 18261
    def compact_child_nodes
      [*parts]
    end

See `Node.compact_child_nodes`.

copy(**fields) → InterpolatedRegularExpressionNode
Source

    # File lib/prism/node.rb, line 18278
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, parts: self.parts, closing_loc: self.closing_loc)
      InterpolatedRegularExpressionNode.new(source, node_id, location, flags, opening_loc, parts, closing_loc)
    end

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

deconstruct ()
Alias for: child_nodes
each_child_node () { |node| ... }
Source

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

      parts.each { |node| yield node }
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 18292
    def type
      :interpolated_regular_expression_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

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

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

## Slicing

### Public Instance Methods

closing → String
Source

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

Slice the location of `closing_loc` from the source.

opening → String
Source

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

Slice the location of `opening_loc` from the source.