class Prism::RegularExpressionNode - prism: Ruby Standard Library Documentation

# class Prism::RegularExpressionNode

Represents a regular expression literal with no interpolation.

    /foo/i
    ^^^^^^

### Attributes

unescaped[R]

attr_reader unescaped: String

### Public Class Methods

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

Initialize a new `RegularExpressionNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 15412
    def self.type
      :regular_expression_node
    end

### Public Instance Methods

===(other) click to toggle source

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

    # File prism/node.rb, line 15418
    def ===(other)
      other.is_a?(RegularExpressionNode) &&
        (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) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 15257
    def accept(visitor)
      visitor.visit_regular_expression_node(self)
    end

ascii_8bit?() click to toggle source

def ascii_8bit?: () -> bool

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String

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

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`

    # File prism/node.rb, line 15371
    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() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

content() click to toggle source

def content: () -> String

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

content_loc() click to toggle source

attr_reader `content_loc`: `Location`

    # File prism/node.rb, line 15358
    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) click to toggle source

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

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

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

euc_jp?() click to toggle source

def euc_jp?: () -> bool

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

extended?() click to toggle source

def extended?: () -> bool

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

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

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

forced_us_ascii_encoding?() click to toggle source

def forced_us_ascii_encoding?: () -> bool

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

forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

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

ignore_case?() click to toggle source

def ignore_case?: () -> bool

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

inspect() click to toggle source

def inspect -> String

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

multi_line?() click to toggle source

def multi_line?: () -> bool

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

once?() click to toggle source

def once?: () -> bool

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

opening() click to toggle source

def opening: () -> String

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

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`

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

save_closing_loc(repository) click to toggle source

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

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

save_content_loc(repository) click to toggle source

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

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

save_opening_loc(repository) click to toggle source

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

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

type() click to toggle source

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

    # File prism/node.rb, line 15407
    def type
      :regular_expression_node
    end

utf_8?() click to toggle source

def utf_8?: () -> bool

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

windows_31j?() click to toggle source

def windows_31j?: () -> bool

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