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.



15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
 
# File 'lib/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

Instance Attribute Details

#unescaped ⇒ Object (readonly)

attr_reader unescaped: String



15384
15385
15386
 
# File 'lib/prism/node.rb', line 15384

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



15412
15413
15414
 
# File 'lib/prism/node.rb', line 15412

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.



15418
15419
15420
15421
15422
15423
15424
15425
 
# File 'lib/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) ⇒ Object

def accept: (Visitor visitor) -> void



15257
15258
15259
 
# File 'lib/prism/node.rb', line 15257

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

#ascii_8bit? ⇒ Boolean

def ascii_8bit?: () -> bool

Returns:

  • (Boolean) 


15315
15316
15317
 
# File 'lib/prism/node.rb', line 15315

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15262
15263
15264
 
# File 'lib/prism/node.rb', line 15262

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



15397
15398
15399
 
# File 'lib/prism/node.rb', line 15397

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



15371
15372
15373
15374
15375
 
# File 'lib/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 ⇒ Object

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



15272
15273
15274
 
# File 'lib/prism/node.rb', line 15272

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15267
15268
15269
 
# File 'lib/prism/node.rb', line 15267

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



15392
15393
15394
 
# File 'lib/prism/node.rb', line 15392

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



15358
15359
15360
15361
15362
 
# File 'lib/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) ⇒ Object

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



15277
15278
15279
 
# File 'lib/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_keys(keys) ⇒ Object

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



15285
15286
15287
 
# File 'lib/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? ⇒ Boolean

def euc_jp?: () -> bool

Returns:

  • (Boolean) 


15310
15311
15312
 
# File 'lib/prism/node.rb', line 15310

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

#extended? ⇒ Boolean

def extended?: () -> bool

Returns:

  • (Boolean) 


15295
15296
15297
 
# File 'lib/prism/node.rb', line 15295

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


15335
15336
15337
 
# File 'lib/prism/node.rb', line 15335

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


15340
15341
15342
 
# File 'lib/prism/node.rb', line 15340

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


15330
15331
15332
 
# File 'lib/prism/node.rb', line 15330

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

#ignore_case? ⇒ Boolean

def ignore_case?: () -> bool

Returns:

  • (Boolean) 


15290
15291
15292
 
# File 'lib/prism/node.rb', line 15290

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

#inspect ⇒ Object

def inspect -> String



15402
15403
15404
 
# File 'lib/prism/node.rb', line 15402

def inspect
  InspectVisitor.compose(self)
end

#multi_line? ⇒ Boolean

def multi_line?: () -> bool

Returns:

  • (Boolean) 


15300
15301
15302
 
# File 'lib/prism/node.rb', line 15300

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

#once? ⇒ Boolean

def once?: () -> bool

Returns:

  • (Boolean) 


15305
15306
15307
 
# File 'lib/prism/node.rb', line 15305

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

#opening ⇒ Object

def opening: () -> String



15387
15388
15389
 
# File 'lib/prism/node.rb', line 15387

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



15345
15346
15347
15348
15349
 
# File 'lib/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) ⇒ Object

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



15379
15380
15381
 
# File 'lib/prism/node.rb', line 15379

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.



15366
15367
15368
 
# File 'lib/prism/node.rb', line 15366

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.



15353
15354
15355
 
# File 'lib/prism/node.rb', line 15353

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



15407
15408
15409
 
# File 'lib/prism/node.rb', line 15407

def type
  :regular_expression_node
end

#utf_8? ⇒ Boolean

def utf_8?: () -> bool

Returns:

  • (Boolean) 


15325
15326
15327
 
# File 'lib/prism/node.rb', line 15325

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

#windows_31j? ⇒ Boolean

def windows_31j?: () -> bool

Returns:

  • (Boolean) 


15320
15321
15322
 
# File 'lib/prism/node.rb', line 15320

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