Class: Prism::InterpolatedRegularExpressionNode

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 that contains interpolation.

/foo #{bar} baz/
^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, opening_loc, parts, closing_loc, location) ⇒ InterpolatedRegularExpressionNode

def initialize: (flags: Integer, opening_loc: Location, parts: Array, closing_loc: Location, location: Location) -> void



9903
9904
9905
9906
9907
9908
9909
 
# File 'lib/prism/node.rb', line 9903

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

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



9900
9901
9902
 
# File 'lib/prism/node.rb', line 9900

def closing_loc
  @closing_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



9891
9892
9893
 
# File 'lib/prism/node.rb', line 9891

def flags
  @flags
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



9894
9895
9896
 
# File 'lib/prism/node.rb', line 9894

def opening_loc
  @opening_loc
end

#parts ⇒ Object (readonly)

attr_reader parts: Array



9897
9898
9899
 
# File 'lib/prism/node.rb', line 9897

def parts
  @parts
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



10055
10056
10057
 
# File 'lib/prism/node.rb', line 10055

def self.type
  :interpolated_regular_expression_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9912
9913
9914
 
# File 'lib/prism/node.rb', line 9912

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

#ascii_8bit? ⇒ Boolean

def ascii_8bit?: () -> bool

Returns:

  • (Boolean) 


9981
9982
9983
 
# File 'lib/prism/node.rb', line 9981

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

#child_nodes ⇒ Object Also known as: deconstruct

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



9922
9923
9924
 
# File 'lib/prism/node.rb', line 9922

def child_nodes
  [*parts]
end

#closing ⇒ Object

def closing: () -> String



10016
10017
10018
 
# File 'lib/prism/node.rb', line 10016

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



9932
9933
9934
 
# File 'lib/prism/node.rb', line 9932

def comment_targets
  [opening_loc, *parts, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9927
9928
9929
 
# File 'lib/prism/node.rb', line 9927

def compact_child_nodes
  [*parts]
end

#copy(**params) ⇒ Object

def copy: (**params) -> InterpolatedRegularExpressionNode



9937
9938
9939
9940
9941
9942
9943
9944
9945
 
# File 'lib/prism/node.rb', line 9937

def copy(**params)
  InterpolatedRegularExpressionNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:parts) { parts },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



9951
9952
9953
 
# File 'lib/prism/node.rb', line 9951

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

#euc_jp? ⇒ Boolean

def euc_jp?: () -> bool

Returns:

  • (Boolean) 


9976
9977
9978
 
# File 'lib/prism/node.rb', line 9976

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

#extended? ⇒ Boolean

def extended?: () -> bool

Returns:

  • (Boolean) 


9961
9962
9963
 
# File 'lib/prism/node.rb', line 9961

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


10001
10002
10003
 
# File 'lib/prism/node.rb', line 10001

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

#forced_us_ascii_encoding? ⇒ Boolean

def forced_us_ascii_encoding?: () -> bool

Returns:

  • (Boolean) 


10006
10007
10008
 
# File 'lib/prism/node.rb', line 10006

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


9996
9997
9998
 
# File 'lib/prism/node.rb', line 9996

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

#ignore_case? ⇒ Boolean

def ignore_case?: () -> bool

Returns:

  • (Boolean) 


9956
9957
9958
 
# File 'lib/prism/node.rb', line 9956

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



10021
10022
10023
10024
10025
10026
10027
10028
10029
 
# File 'lib/prism/node.rb', line 10021

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 << "├── parts: #{inspector.list("#{inspector.prefix}│   ", parts)}"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#multi_line? ⇒ Boolean

def multi_line?: () -> bool

Returns:

  • (Boolean) 


9966
9967
9968
 
# File 'lib/prism/node.rb', line 9966

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

#once? ⇒ Boolean

def once?: () -> bool

Returns:

  • (Boolean) 


9971
9972
9973
 
# File 'lib/prism/node.rb', line 9971

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

#opening ⇒ Object

def opening: () -> String



10011
10012
10013
 
# File 'lib/prism/node.rb', line 10011

def opening
  opening_loc.slice
end

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



9916
9917
9918
9919
 
# File 'lib/prism/node.rb', line 9916

def set_newline_flag(newline_marked) # :nodoc:
  first = parts.first
  first.set_newline_flag(newline_marked) if first
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



10045
10046
10047
 
# File 'lib/prism/node.rb', line 10045

def type
  :interpolated_regular_expression_node
end

#utf_8? ⇒ Boolean

def utf_8?: () -> bool

Returns:

  • (Boolean) 


9991
9992
9993
 
# File 'lib/prism/node.rb', line 9991

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

#windows_31j? ⇒ Boolean

def windows_31j?: () -> bool

Returns:

  • (Boolean) 


9986
9987
9988
 
# File 'lib/prism/node.rb', line 9986

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