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.



16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
 
# File 'lib/prism/node.rb', line 16383

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



16528
16529
16530
 
# File 'lib/prism/node.rb', line 16528

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



16556
16557
16558
 
# File 'lib/prism/node.rb', line 16556

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.



16562
16563
16564
16565
16566
16567
16568
16569
 
# File 'lib/prism/node.rb', line 16562

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



16395
16396
16397
 
# File 'lib/prism/node.rb', line 16395

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

#ascii_8bit? ⇒ Boolean

def ascii_8bit?: () -> bool



16459
16460
16461
 
# File 'lib/prism/node.rb', line 16459

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



16400
16401
16402
 
# File 'lib/prism/node.rb', line 16400

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



16541
16542
16543
 
# File 'lib/prism/node.rb', line 16541

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



16515
16516
16517
16518
16519
 
# File 'lib/prism/node.rb', line 16515

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]



16416
16417
16418
 
# File 'lib/prism/node.rb', line 16416

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16411
16412
16413
 
# File 'lib/prism/node.rb', line 16411

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



16536
16537
16538
 
# File 'lib/prism/node.rb', line 16536

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



16502
16503
16504
16505
16506
 
# File 'lib/prism/node.rb', line 16502

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



16421
16422
16423
 
# File 'lib/prism/node.rb', line 16421

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 }



16429
16430
16431
 
# File 'lib/prism/node.rb', line 16429

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

#each_child_node ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator



16405
16406
16407
16408
 
# File 'lib/prism/node.rb', line 16405

def each_child_node
  return to_enum(:each_child_node) unless block_given?

end

#euc_jp? ⇒ Boolean

def euc_jp?: () -> bool



16454
16455
16456
 
# File 'lib/prism/node.rb', line 16454

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

#extended? ⇒ Boolean

def extended?: () -> bool



16439
16440
16441
 
# File 'lib/prism/node.rb', line 16439

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool



16479
16480
16481
 
# File 'lib/prism/node.rb', line 16479

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool



16484
16485
16486
 
# File 'lib/prism/node.rb', line 16484

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool



16474
16475
16476
 
# File 'lib/prism/node.rb', line 16474

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

#ignore_case? ⇒ Boolean

def ignore_case?: () -> bool



16434
16435
16436
 
# File 'lib/prism/node.rb', line 16434

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

#inspect ⇒ Object

def inspect -> String



16546
16547
16548
 
# File 'lib/prism/node.rb', line 16546

def inspect
  InspectVisitor.compose(self)
end

#multi_line? ⇒ Boolean

def multi_line?: () -> bool



16444
16445
16446
 
# File 'lib/prism/node.rb', line 16444

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

#once? ⇒ Boolean

def once?: () -> bool



16449
16450
16451
 
# File 'lib/prism/node.rb', line 16449

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

#opening ⇒ Object

def opening: () -> String



16531
16532
16533
 
# File 'lib/prism/node.rb', line 16531

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



16489
16490
16491
16492
16493
 
# File 'lib/prism/node.rb', line 16489

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.



16523
16524
16525
 
# File 'lib/prism/node.rb', line 16523

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.



16510
16511
16512
 
# File 'lib/prism/node.rb', line 16510

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.



16497
16498
16499
 
# File 'lib/prism/node.rb', line 16497

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`.



16551
16552
16553
 
# File 'lib/prism/node.rb', line 16551

def type
  :regular_expression_node
end

#utf_8? ⇒ Boolean

def utf_8?: () -> bool



16469
16470
16471
 
# File 'lib/prism/node.rb', line 16469

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

#windows_31j? ⇒ Boolean

def windows_31j?: () -> bool



16464
16465
16466
 
# File 'lib/prism/node.rb', line 16464

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