class Prism::RegularExpressionNode
Represents a regular expression literal with no interpolation.
/foo/i ^^^^^^
Attributes
private attr_reader flags: Integer
attr_reader unescaped: String
Public Class Methods
def initialize: (Integer
flags, Location
opening_loc
, Location
content_loc
, Location
closing_loc
, String
unescaped, Location
location) -> void
# File lib/prism/node.rb, line 15434 def initialize(source, flags, opening_loc, content_loc, closing_loc, unescaped, location) @source = source @newline = false @location = location @flags = flags @opening_loc = opening_loc @content_loc = content_loc @closing_loc = closing_loc @unescaped = unescaped end
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
# File lib/prism/node.rb, line 15613 def self.type :regular_expression_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 15446 def accept(visitor) visitor.visit_regular_expression_node(self) end
def ascii_8bit?: () -> bool
# File lib/prism/node.rb, line 15533 def ascii_8bit? flags.anybits?(RegularExpressionFlags::ASCII_8BIT) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 15451 def child_nodes [] end
def closing: () -> String
# File lib/prism/node.rb, line 15573 def closing closing_loc.slice end
attr_reader closing_loc
: Location
# File lib/prism/node.rb, line 15497 def closing_loc location = @closing_loc return location if location.is_a?(Location) @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 15461 def comment_targets [opening_loc, content_loc, closing_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 15456 def compact_child_nodes [] end
def content: () -> String
# File lib/prism/node.rb, line 15568 def content content_loc.slice end
attr_reader content_loc
: Location
# File lib/prism/node.rb, line 15490 def content_loc location = @content_loc return location if location.is_a?(Location) @content_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
def copy: (?flags: Integer
, ?opening_loc: Location
, ?content_loc: Location
, ?closing_loc: Location
, ?unescaped: String
, ?location: Location
) -> RegularExpressionNode
# File lib/prism/node.rb, line 15466 def copy(flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped, location: self.location) RegularExpressionNode.new(source, flags, opening_loc, content_loc, closing_loc, unescaped, location) end
def deconstruct_keys
: (Array keys) -> { flags: Integer
, opening_loc
: Location
, content_loc
: Location
, closing_loc
: Location
, unescaped: String
, location: Location
}
# File lib/prism/node.rb, line 15474 def deconstruct_keys(keys) { flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location } end
def euc_jp?: () -> bool
# File lib/prism/node.rb, line 15528 def euc_jp? flags.anybits?(RegularExpressionFlags::EUC_JP) end
def extended?: () -> bool
# File lib/prism/node.rb, line 15513 def extended? flags.anybits?(RegularExpressionFlags::EXTENDED) end
def forced_binary_encoding?: () -> bool
# File lib/prism/node.rb, line 15553 def forced_binary_encoding? flags.anybits?(RegularExpressionFlags::FORCED_BINARY_ENCODING) end
def forced_us_ascii_encoding?: () -> bool
# File lib/prism/node.rb, line 15558 def forced_us_ascii_encoding? flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING) end
def forced_utf8_encoding?: () -> bool
# File lib/prism/node.rb, line 15548 def forced_utf8_encoding? flags.anybits?(RegularExpressionFlags::FORCED_UTF8_ENCODING) end
def ignore_case?: () -> bool
# File lib/prism/node.rb, line 15508 def ignore_case? flags.anybits?(RegularExpressionFlags::IGNORE_CASE) end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 15578 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) flags = [("ignore_case" if ignore_case?), ("extended" if extended?), ("multi_line" if multi_line?), ("once" if once?), ("euc_jp" if euc_jp?), ("ascii_8bit" if ascii_8bit?), ("windows_31j" if windows_31j?), ("utf_8" if utf_8?), ("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].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
def multi_line?: () -> bool
# File lib/prism/node.rb, line 15518 def multi_line? flags.anybits?(RegularExpressionFlags::MULTI_LINE) end
def once?: () -> bool
# File lib/prism/node.rb, line 15523 def once? flags.anybits?(RegularExpressionFlags::ONCE) end
def opening: () -> String
# File lib/prism/node.rb, line 15563 def opening opening_loc.slice end
attr_reader opening_loc
: Location
# File lib/prism/node.rb, line 15483 def opening_loc location = @opening_loc return location if location.is_a?(Location) @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
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
# File lib/prism/node.rb, line 15603 def type :regular_expression_node end
def utf_8?: () -> bool
# File lib/prism/node.rb, line 15543 def utf_8? flags.anybits?(RegularExpressionFlags::UTF_8) end
def windows_31j?: () -> bool
# File lib/prism/node.rb, line 15538 def windows_31j? flags.anybits?(RegularExpressionFlags::WINDOWS_31J) end