Class: Prism::RegularExpressionNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
lib/prism/node_ext.rb,
ext/prism/api_node.c

Overview

Represents a regular expression literal with no interpolation.

/foo/i
^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped) ⇒ RegularExpressionNode

Initialize a new RegularExpressionNode node.



15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
 
# File 'lib/prism/node.rb', line 15422

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

Instance Attribute Details

#unescaped ⇒ Object (readonly)

attr_reader unescaped: String



15561
15562
15563
 
# File 'lib/prism/node.rb', line 15561

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



15589
15590
15591
 
# File 'lib/prism/node.rb', line 15589

def self.type
  :regular_expression_node
end

Instance Method Details

#===(other) ⇒ Object

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



15595
15596
15597
15598
15599
15600
15601
15602
 
# File 'lib/prism/node.rb', line 15595

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) ⇒ Object

def accept: (Visitor visitor) -> void



15434
15435
15436
 
# File 'lib/prism/node.rb', line 15434

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

#ascii_8bit? ⇒ Boolean

def ascii_8bit?: () -> bool

Returns:

  • (Boolean) 


15492
15493
15494
 
# File 'lib/prism/node.rb', line 15492

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



15439
15440
15441
 
# File 'lib/prism/node.rb', line 15439

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



15574
15575
15576
 
# File 'lib/prism/node.rb', line 15574

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



15548
15549
15550
15551
15552
 
# File 'lib/prism/node.rb', line 15548

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 ⇒ Object

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



15449
15450
15451
 
# File 'lib/prism/node.rb', line 15449

def comment_targets
  [opening_loc, content_loc, closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15444
15445
15446
 
# File 'lib/prism/node.rb', line 15444

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



15569
15570
15571
 
# File 'lib/prism/node.rb', line 15569

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



15535
15536
15537
15538
15539
 
# File 'lib/prism/node.rb', line 15535

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) ⇒ Object

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



15454
15455
15456
 
# File 'lib/prism/node.rb', line 15454

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_keys(keys) ⇒ Object

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



15462
15463
15464
 
# File 'lib/prism/node.rb', line 15462

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? ⇒ Boolean

def euc_jp?: () -> bool

Returns:

  • (Boolean) 


15487
15488
15489
 
# File 'lib/prism/node.rb', line 15487

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

#extended? ⇒ Boolean

def extended?: () -> bool

Returns:

  • (Boolean) 


15472
15473
15474
 
# File 'lib/prism/node.rb', line 15472

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


15512
15513
15514
 
# File 'lib/prism/node.rb', line 15512

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


15517
15518
15519
 
# File 'lib/prism/node.rb', line 15517

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


15507
15508
15509
 
# File 'lib/prism/node.rb', line 15507

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

#ignore_case? ⇒ Boolean

def ignore_case?: () -> bool

Returns:

  • (Boolean) 


15467
15468
15469
 
# File 'lib/prism/node.rb', line 15467

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

#inspect ⇒ Object

def inspect -> String



15579
15580
15581
 
# File 'lib/prism/node.rb', line 15579

def inspect
  InspectVisitor.compose(self)
end

#multi_line? ⇒ Boolean

def multi_line?: () -> bool

Returns:

  • (Boolean) 


15477
15478
15479
 
# File 'lib/prism/node.rb', line 15477

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

#once? ⇒ Boolean

def once?: () -> bool

Returns:

  • (Boolean) 


15482
15483
15484
 
# File 'lib/prism/node.rb', line 15482

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

#opening ⇒ Object

def opening: () -> String



15564
15565
15566
 
# File 'lib/prism/node.rb', line 15564

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



15522
15523
15524
15525
15526
 
# File 'lib/prism/node.rb', line 15522

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) ⇒ Object

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



15556
15557
15558
 
# File 'lib/prism/node.rb', line 15556

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_content_loc(repository) ⇒ Object

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



15543
15544
15545
 
# File 'lib/prism/node.rb', line 15543

def save_content_loc(repository)
  repository.enter(node_id, :content_loc)
end

#save_opening_loc(repository) ⇒ Object

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



15530
15531
15532
 
# File 'lib/prism/node.rb', line 15530

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

#type ⇒ Object

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



15584
15585
15586
 
# File 'lib/prism/node.rb', line 15584

def type
  :regular_expression_node
end

#utf_8? ⇒ Boolean

def utf_8?: () -> bool

Returns:

  • (Boolean) 


15502
15503
15504
 
# File 'lib/prism/node.rb', line 15502

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

#windows_31j? ⇒ Boolean

def windows_31j?: () -> bool

Returns:

  • (Boolean) 


15497
15498
15499
 
# File 'lib/prism/node.rb', line 15497

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