123456789_123456789_123456789_123456789_123456789_

Class: Prism::RegularExpressionNode

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

Overview

Represents a regular expression literal with no interpolation.

/foo/i
^^^^^^

Class Method Summary

Instance Attribute Summary

Instance Method Summary

RegularExpressionOptions - Included

#options

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

Constructor Details

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

Initialize a new RegularExpressionNode node.

[ GitHub ] 

  


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



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 13653



def self.type
  :regular_expression_node
end


  







Instance Attribute Details



  

    #ascii_8bit?  ⇒ Boolean  (readonly)
  



  

    
def ascii_8bit?: () -> bool

  





  


  [ GitHub ]


  

  


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



def ascii_8bit?
  flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
end


  








  

    #euc_jp?  ⇒ Boolean  (readonly)
  



  

    
def euc_jp?: () -> bool

  





  


  [ GitHub ]


  

  


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



def euc_jp?
  flags.anybits?(RegularExpressionFlags::EUC_JP)
end


  








  

    #extended?  ⇒ Boolean  (readonly)
  



  

    
def extended?: () -> bool

  





  


  [ GitHub ]


  

  


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



def extended?
  flags.anybits?(RegularExpressionFlags::EXTENDED)
end


  








  

    #forced_binary_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_binary_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


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



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


  








  

    #forced_us_ascii_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_us_ascii_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


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



def forced_us_ascii_encoding?
  flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING)
end


  








  

    #forced_utf8_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_utf8_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


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



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


  








  

    #ignore_case?  ⇒ Boolean  (readonly)
  



  

    
def ignore_case?: () -> bool

  





  


  [ GitHub ]


  

  


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



def ignore_case?
  flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
end


  








  

    #multi_line?  ⇒ Boolean  (readonly)
  



  

    
def multi_line?: () -> bool

  





  


  [ GitHub ]


  

  


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



def multi_line?
  flags.anybits?(RegularExpressionFlags::MULTI_LINE)
end


  








  

    #once?  ⇒ Boolean  (readonly)
  



  

    
def once?: () -> bool

  





  


  [ GitHub ]


  

  


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



def once?
  flags.anybits?(RegularExpressionFlags::ONCE)
end


  








  

    #unescaped   (readonly)
  



  

    
attr_reader unescaped: String

  



  [ GitHub ]


  

  


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



attr_reader :unescaped


  








  

    #utf_8?  ⇒ Boolean  (readonly)
  



  

    
def utf_8?: () -> bool

  





  


  [ GitHub ]


  

  


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



def utf_8?
  flags.anybits?(RegularExpressionFlags::UTF_8)
end


  








  

    #windows_31j?  ⇒ Boolean  (readonly)
  



  

    
def windows_31j?: () -> bool

  





  


  [ GitHub ]


  

  


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



def windows_31j?
  flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
end


  







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 13659



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  []
end


  








  

    #closing  
  



  

    
def closing: () -> String

  



  [ GitHub ]


  

  


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



def closing
  closing_loc.slice
end


  








  

    #closing_loc  
  



  

    
attr_reader closing_loc: Location

  



  [ GitHub ]


  

  


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



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 13532



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 13527



def compact_child_nodes
  []
end


  








  

    #content  
  



  

    
def content: () -> String

  



  [ GitHub ]


  

  


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



def content
  content_loc.slice
end


  








  

    #content_loc  
  



  

    
attr_reader content_loc: Location

  



  [ GitHub ]


  

  


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



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

  



  [ GitHub ]


  

  


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



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  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



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 13545



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 13643



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String

  



  [ GitHub ]


  

  


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



def opening
  opening_loc.slice
end


  








  

    #opening_loc  
  



  

    
attr_reader opening_loc: Location

  



  [ GitHub ]


  

  


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



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


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :regular_expression_node
end