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

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



15882
15883
15884
15885
15886
15887
15888
15889
 
# File 'lib/prism/node.rb', line 15882

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?



15876
15877
15878
 
# File 'lib/prism/node.rb', line 15876

def closing_loc
  @closing_loc
end

#content_loc ⇒ Object (readonly)

attr_reader content_loc: Location



15873
15874
15875
 
# File 'lib/prism/node.rb', line 15873

def content_loc
  @content_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



15867
15868
15869
 
# File 'lib/prism/node.rb', line 15867

def flags
  @flags
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



15870
15871
15872
 
# File 'lib/prism/node.rb', line 15870

def opening_loc
  @opening_loc
end

#unescaped ⇒ Object (readonly)

attr_reader unescaped: String



15879
15880
15881
 
# File 'lib/prism/node.rb', line 15879

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



15997
15998
15999
 
# File 'lib/prism/node.rb', line 15997

def self.type
  :string_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



15892
15893
15894
 
# File 'lib/prism/node.rb', line 15892

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15897
15898
15899
 
# File 'lib/prism/node.rb', line 15897

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String?



15957
15958
15959
 
# File 'lib/prism/node.rb', line 15957

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

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



15907
15908
15909
 
# File 'lib/prism/node.rb', line 15907

def comment_targets
  [*opening_loc, content_loc, *closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15902
15903
15904
 
# File 'lib/prism/node.rb', line 15902

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



15952
15953
15954
 
# File 'lib/prism/node.rb', line 15952

def content
  content_loc.slice
end

#copy(**params) ⇒ Object

def copy: (**params) -> StringNode



15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
 
# File 'lib/prism/node.rb', line 15912

def copy(**params)
  StringNode.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]



15927
15928
15929
 
# File 'lib/prism/node.rb', line 15927

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


15937
15938
15939
 
# File 'lib/prism/node.rb', line 15937

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


15932
15933
15934
 
# File 'lib/prism/node.rb', line 15932

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

#frozen? ⇒ Boolean

def frozen?: () -> bool

Returns:

  • (Boolean) 


15942
15943
15944
 
# File 'lib/prism/node.rb', line 15942

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
 
# File 'lib/prism/node.rb', line 15962

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("frozen" if frozen?)].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

#opening ⇒ Object

def opening: () -> String?



15947
15948
15949
 
# File 'lib/prism/node.rb', line 15947

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



15987
15988
15989
 
# File 'lib/prism/node.rb', line 15987

def type
  :string_node
end