Class: Prism::SymbolNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::SymbolNode
Defined in:	lib/prism/node.rb, prism/api_node.c

Overview

Represents a symbol literal or a symbol contained within a %i list.

:foo
^^^^

%i[foo]
   ^^^

Class Method Summary

.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped) ⇒ SymbolNode constructor

Initialize a new SymbolNode 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_us_ascii_encoding? ⇒ Boolean readonly

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

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

attr_reader unescaped: String.

`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.
#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)

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

Alias for #child_nodes.
#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location?, value_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_opening_loc(repository)

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

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

Return a symbol representation of this node type.
#value

def value: () -> String?
#value_loc

attr_reader value_loc: Location?

`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, value_loc, closing_loc, unescaped) ⇒ `SymbolNode`

Initialize a new SymbolNode node.

[ GitHub ]

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


def initialize(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @value_loc = value_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 18591


def self.type
  :symbol_node
end

Instance Attribute Details

#forced_binary_encoding? ⇒ `Boolean` (readonly)

def forced_binary_encoding?: () -> bool

[ GitHub ]

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


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

#forced_us_ascii_encoding? ⇒ `Boolean` (readonly)

def forced_us_ascii_encoding?: () -> bool

[ GitHub ]

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


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

#forced_utf8_encoding? ⇒ `Boolean` (readonly)

def forced_utf8_encoding?: () -> bool

[ GitHub ]

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


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

#unescaped (readonly)

attr_reader unescaped: String

[ GitHub ]

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


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 18597


def ===(other)
  other.is_a?(SymbolNode) &&
    (flags === other.flags) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (value_loc.nil? == other.value_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 18452


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

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


def child_nodes
  []
end

#closing

def closing: () -> String?

[ GitHub ]

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


def closing
  closing_loc&.slice
end

#closing_loc

attr_reader closing_loc: Location?

[ GitHub ]

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


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 18473


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

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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


def compact_child_nodes
  []
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)

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

[ GitHub ]

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


def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
  SymbolNode.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

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


alias deconstruct child_nodes

#deconstruct_keys(keys)

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

[ GitHub ]

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


def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, value_loc: value_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 18462


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 18581


def inspect
  InspectVisitor.compose(self)
end

#opening

def opening: () -> String?

[ GitHub ]

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


def opening
  opening_loc&.slice
end

#opening_loc

attr_reader opening_loc: Location?

[ GitHub ]

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


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 18558


def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
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 18520


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

#save_value_loc(repository)

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

[ GitHub ]

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


def save_value_loc(repository)
  repository.enter(node_id, :value_loc) unless @value_loc.nil?
end

#type

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

[ GitHub ]

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


def type
  :symbol_node
end

#value

def value: () -> String?

[ GitHub ]

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


def value
  value_loc&.slice
end

#value_loc

attr_reader value_loc: Location?

[ GitHub ]

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


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

Class: Prism::SymbolNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped) ⇒ SymbolNode

Class Method Details

.type

Instance Attribute Details

#forced_binary_encoding? ⇒ Boolean (readonly)

#forced_us_ascii_encoding? ⇒ Boolean (readonly)

#forced_utf8_encoding? ⇒ Boolean (readonly)

#unescaped (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#closing

#closing_loc

#comment_targets

#compact_child_nodes

#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_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_opening_loc(repository)

#save_value_loc(repository)

#type

#value

#value_loc

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped) ⇒ `SymbolNode`

#forced_binary_encoding? ⇒ `Boolean` (readonly)

#forced_us_ascii_encoding? ⇒ `Boolean` (readonly)

#forced_utf8_encoding? ⇒ `Boolean` (readonly)