Class: Prism::StringNode

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

Overview

Represents a string literal, a string contained within a ‘%w` list, or plain string content within an interpolated string.

"foo"
^^^^^

%w[foo]
   ^^^

"foo #{bar} baz"
 ^^^^      ^^^^

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

Initialize a new StringNode node.



16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
 
# File 'lib/prism/node.rb', line 16846

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



16962
16963
16964
 
# File 'lib/prism/node.rb', line 16962

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



16990
16991
16992
 
# File 'lib/prism/node.rb', line 16990

def self.type
  :string_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.



16996
16997
16998
16999
17000
17001
17002
17003
 
# File 'lib/prism/node.rb', line 16996

def ===(other)
  other.is_a?(StringNode) &&
    (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



16858
16859
16860
 
# File 'lib/prism/node.rb', line 16858

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16863
16864
16865
 
# File 'lib/prism/node.rb', line 16863

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String?



16975
16976
16977
 
# File 'lib/prism/node.rb', line 16975

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
 
# File 'lib/prism/node.rb', line 16943

def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#comment_targets ⇒ Object

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



16873
16874
16875
 
# File 'lib/prism/node.rb', line 16873

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16868
16869
16870
 
# File 'lib/prism/node.rb', line 16868

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



16970
16971
16972
 
# File 'lib/prism/node.rb', line 16970

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



16930
16931
16932
16933
16934
 
# File 'lib/prism/node.rb', line 16930

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) -> StringNode



16878
16879
16880
 
# File 'lib/prism/node.rb', line 16878

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)
  StringNode.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 }



16886
16887
16888
 
# File 'lib/prism/node.rb', line 16886

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


16896
16897
16898
 
# File 'lib/prism/node.rb', line 16896

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


16891
16892
16893
 
# File 'lib/prism/node.rb', line 16891

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

#frozen? ⇒ Boolean

def frozen?: () -> bool

Returns:

  • (Boolean) 


16901
16902
16903
 
# File 'lib/prism/node.rb', line 16901

def frozen?
  flags.anybits?(StringFlags::FROZEN)
end

#inspect ⇒ Object

def inspect -> String



16980
16981
16982
 
# File 'lib/prism/node.rb', line 16980

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean) 


16906
16907
16908
 
# File 'lib/prism/node.rb', line 16906

def mutable?
  flags.anybits?(StringFlags::MUTABLE)
end

#opening ⇒ Object

def opening: () -> String?



16965
16966
16967
 
# File 'lib/prism/node.rb', line 16965

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
 
# File 'lib/prism/node.rb', line 16911

def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#save_closing_loc(repository) ⇒ Object

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



16957
16958
16959
 
# File 'lib/prism/node.rb', line 16957

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

#save_content_loc(repository) ⇒ Object

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



16938
16939
16940
 
# File 'lib/prism/node.rb', line 16938

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.



16925
16926
16927
 
# File 'lib/prism/node.rb', line 16925

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

#to_interpolated ⇒ Object

Occasionally it’s helpful to treat a string as if it were interpolated so that there’s a consistent interface for working with strings.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/prism/node_ext.rb', line 72

def to_interpolated
  InterpolatedStringNode.new(
    source,
    -1,
    location,
    frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
    opening_loc,
    [copy(location: content_loc, opening_loc: nil, closing_loc: nil)],
    closing_loc
  )
end

#type ⇒ Object

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



16985
16986
16987
 
# File 'lib/prism/node.rb', line 16985

def type
  :string_node
end