Class: Prism::StringNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `HeredocQuery`, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::StringNode
Defined in:	lib/prism/node.rb, lib/prism/node_ext.rb, 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"
 ^^^^      ^^^^

Class Method Summary

.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped) ⇒ StringNode constructor

Initialize a new StringNode node.
.type

Return a symbol representation of this node type.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	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.

Instance Attribute Summary

#forced_binary_encoding? ⇒ Boolean readonly

def forced_binary_encoding?: () -> bool.
#forced_utf8_encoding? ⇒ Boolean readonly

def forced_utf8_encoding?: () -> bool.
#frozen? ⇒ Boolean readonly

def frozen?: () -> bool.
#mutable? ⇒ Boolean readonly

def mutable?: () -> bool.
#unescaped readonly

attr_reader unescaped: String.

`HeredocQuery` - Included

#heredoc?

Returns true if this node was represented as a heredoc in the source code.

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#child_nodes (also: #deconstruct)

def child_nodes: () -> Array.
#closing

def closing: () -> String?
#closing_loc

attr_reader closing_loc: Location?
#comment_targets

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

def compact_child_nodes: () -> Array.
#content

def content: () -> String.
#content_loc

attr_reader content_loc: Location.
#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)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location?, ?content_loc: Location, ?closing_loc: Location?, ?unescaped: String) -> StringNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

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

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator.
#inspect

def inspect -> String.
#opening

def opening: () -> String?
#opening_loc

attr_reader opening_loc: Location?
#save_closing_loc(repository)

Save the closing_loc location using the given saved source so that it can be retrieved later.
#save_content_loc(repository)

Save the content_loc location using the given saved source so that it can be retrieved later.
#save_opening_loc(repository)

Save the opening_loc location using the given saved source so that it can be retrieved later.
#to_interpolated

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

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped) ⇒ `StringNode`

Initialize a new StringNode node.

[ GitHub ]

# File 'lib/prism/node.rb', line 18099


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

Class Method Details

.type

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18249


def self.type
  :string_node
end

Instance Attribute Details

#forced_binary_encoding? ⇒ `Boolean` (readonly)

def forced_binary_encoding?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 18155


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

#forced_utf8_encoding? ⇒ `Boolean` (readonly)

def forced_utf8_encoding?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 18150


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

#frozen? ⇒ `Boolean` (readonly)

def frozen?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 18160


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

#mutable? ⇒ `Boolean` (readonly)

def mutable?: () -> bool

[ GitHub ]

# File 'lib/prism/node.rb', line 18165


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

#unescaped (readonly)

attr_reader unescaped: String

[ GitHub ]

# File 'lib/prism/node.rb', line 18221


attr_reader :unescaped

Instance Method Details

#===(other)

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

[ GitHub ]

# File 'lib/prism/node.rb', line 18255


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)

def accept: (Visitor visitor) -> void

[ GitHub ]

# File 'lib/prism/node.rb', line 18111


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 18116


def child_nodes
  []
end

#closing

def closing: () -> String?

[ GitHub ]

# File 'lib/prism/node.rb', line 18234


def closing
  closing_loc&.slice
end

#closing_loc

attr_reader closing_loc: Location?

[ GitHub ]

# File 'lib/prism/node.rb', line 18202


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

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18132


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

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

# File 'lib/prism/node.rb', line 18127


def compact_child_nodes
  []
end

#content

def content: () -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 18229


def content
  content_loc.slice
end

#content_loc

attr_reader content_loc: Location

[ GitHub ]

# File 'lib/prism/node.rb', line 18189


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)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18137


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

Alias for #child_nodes.

[ GitHub ]

# File 'lib/prism/node.rb', line 18142


alias deconstruct child_nodes

#deconstruct_keys(keys)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18145


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

#each_child_node

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

[ GitHub ]

# File 'lib/prism/node.rb', line 18121


def each_child_node
  return to_enum(:each_child_node) unless block_given?

end

#inspect

def inspect -> String

[ GitHub ]

# File 'lib/prism/node.rb', line 18239


def inspect
  InspectVisitor.compose(self)
end

#opening

def opening: () -> String?

[ GitHub ]

# File 'lib/prism/node.rb', line 18224


def opening
  opening_loc&.slice
end

#opening_loc

attr_reader opening_loc: Location?

[ GitHub ]

# File 'lib/prism/node.rb', line 18170


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)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18216


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

#save_content_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18197


def save_content_loc(repository)
  repository.enter(node_id, :content_loc)
end

#save_opening_loc(repository)

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18184


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

#to_interpolated

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

[ GitHub ]

# File 'lib/prism/node_ext.rb', line 75


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

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

[ GitHub ]

# File 'lib/prism/node.rb', line 18244


def type
  :string_node
end

Class: Prism::StringNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

HeredocQuery - Included

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped) ⇒ StringNode

Class Method Details

.type

Instance Attribute Details

#forced_binary_encoding? ⇒ Boolean (readonly)

#forced_utf8_encoding? ⇒ Boolean (readonly)

#frozen? ⇒ Boolean (readonly)

#mutable? ⇒ Boolean (readonly)

#unescaped (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#closing

#closing_loc

#comment_targets

#compact_child_nodes

#content

#content_loc

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

#deconstruct

#deconstruct_keys(keys)

#each_child_node

#inspect

#opening

#opening_loc

#save_closing_loc(repository)

#save_content_loc(repository)

#save_opening_loc(repository)

#to_interpolated

#type

`Node` - Inherited

`HeredocQuery` - Included

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped) ⇒ `StringNode`

#forced_binary_encoding? ⇒ `Boolean` (readonly)

#forced_utf8_encoding? ⇒ `Boolean` (readonly)

#frozen? ⇒ `Boolean` (readonly)

#mutable? ⇒ `Boolean` (readonly)