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(flags, opening_loc, content_loc, closing_loc, unescaped, location) ⇒ RegularExpressionNode

def initialize: (flags: Integer, opening_loc: Location, content_loc: Location, closing_loc: Location, unescaped: String, location: Location) -> void



14305
14306
14307
14308
14309
14310
14311
14312
 
# File 'lib/prism/node.rb', line 14305

def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
  @flags = flags
  @opening_loc = opening_loc
  @content_loc = content_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



14299
14300
14301
 
# File 'lib/prism/node.rb', line 14299

def closing_loc
  @closing_loc
end

#content_loc ⇒ Object (readonly)

attr_reader content_loc: Location



14296
14297
14298
 
# File 'lib/prism/node.rb', line 14296

def content_loc
  @content_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



14290
14291
14292
 
# File 'lib/prism/node.rb', line 14290

def flags
  @flags
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



14293
14294
14295
 
# File 'lib/prism/node.rb', line 14293

def opening_loc
  @opening_loc
end

#unescaped ⇒ Object (readonly)

attr_reader unescaped: String



14302
14303
14304
 
# File 'lib/prism/node.rb', line 14302

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



14460
14461
14462
 
# File 'lib/prism/node.rb', line 14460

def self.type
  :regular_expression_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



14315
14316
14317
 
# File 'lib/prism/node.rb', line 14315

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

#ascii_8bit? ⇒ Boolean

def ascii_8bit?: () -> bool

Returns:

  • (Boolean) 


14380
14381
14382
 
# File 'lib/prism/node.rb', line 14380

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

#child_nodes ⇒ Object Also known as: deconstruct

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



14320
14321
14322
 
# File 'lib/prism/node.rb', line 14320

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



14420
14421
14422
 
# File 'lib/prism/node.rb', line 14420

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



14330
14331
14332
 
# File 'lib/prism/node.rb', line 14330

def comment_targets
  [opening_loc, content_loc, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14325
14326
14327
 
# File 'lib/prism/node.rb', line 14325

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



14415
14416
14417
 
# File 'lib/prism/node.rb', line 14415

def content
  content_loc.slice
end

#copy(**params) ⇒ Object

def copy: (**params) -> RegularExpressionNode



14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
 
# File 'lib/prism/node.rb', line 14335

def copy(**params)
  RegularExpressionNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:content_loc) { content_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:unescaped) { unescaped },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



14350
14351
14352
 
# File 'lib/prism/node.rb', line 14350

def deconstruct_keys(keys)
  { flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end

#euc_jp? ⇒ Boolean

def euc_jp?: () -> bool

Returns:

  • (Boolean) 


14375
14376
14377
 
# File 'lib/prism/node.rb', line 14375

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

#extended? ⇒ Boolean

def extended?: () -> bool

Returns:

  • (Boolean) 


14360
14361
14362
 
# File 'lib/prism/node.rb', line 14360

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


14400
14401
14402
 
# File 'lib/prism/node.rb', line 14400

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


14405
14406
14407
 
# File 'lib/prism/node.rb', line 14405

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


14395
14396
14397
 
# File 'lib/prism/node.rb', line 14395

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

#ignore_case? ⇒ Boolean

def ignore_case?: () -> bool

Returns:

  • (Boolean) 


14355
14356
14357
 
# File 'lib/prism/node.rb', line 14355

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
 
# File 'lib/prism/node.rb', line 14425

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

#multi_line? ⇒ Boolean

def multi_line?: () -> bool

Returns:

  • (Boolean) 


14365
14366
14367
 
# File 'lib/prism/node.rb', line 14365

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

#once? ⇒ Boolean

def once?: () -> bool

Returns:

  • (Boolean) 


14370
14371
14372
 
# File 'lib/prism/node.rb', line 14370

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

#opening ⇒ Object

def opening: () -> String



14410
14411
14412
 
# File 'lib/prism/node.rb', line 14410

def opening
  opening_loc.slice
end

#type ⇒ Object

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



14450
14451
14452
 
# File 'lib/prism/node.rb', line 14450

def type
  :regular_expression_node
end

#utf_8? ⇒ Boolean

def utf_8?: () -> bool

Returns:

  • (Boolean) 


14390
14391
14392
 
# File 'lib/prism/node.rb', line 14390

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

#windows_31j? ⇒ Boolean

def windows_31j?: () -> bool

Returns:

  • (Boolean) 


14385
14386
14387
 
# File 'lib/prism/node.rb', line 14385

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