Class: Prism::XStringNode

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

Overview

Represents an xstring literal with no interpolation.

`foo`
^^^^^

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

Initialize a new XStringNode node.



18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
 
# File 'lib/prism/node.rb', line 18141

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



18235
18236
18237
 
# File 'lib/prism/node.rb', line 18235

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



18263
18264
18265
 
# File 'lib/prism/node.rb', line 18263

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



18269
18270
18271
18272
18273
18274
18275
18276
 
# File 'lib/prism/node.rb', line 18269

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



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

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

#child_nodes ⇒ Object Also known as: deconstruct

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



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

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



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

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



18222
18223
18224
18225
18226
 
# File 'lib/prism/node.rb', line 18222

def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#comment_targets ⇒ Object

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



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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



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

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



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

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



18209
18210
18211
18212
18213
 
# File 'lib/prism/node.rb', line 18209

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



18173
18174
18175
 
# File 'lib/prism/node.rb', line 18173

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



18181
18182
18183
 
# File 'lib/prism/node.rb', line 18181

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) 


18191
18192
18193
 
# File 'lib/prism/node.rb', line 18191

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


18186
18187
18188
 
# File 'lib/prism/node.rb', line 18186

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

#inspect ⇒ Object

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



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

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



18196
18197
18198
18199
18200
 
# File 'lib/prism/node.rb', line 18196

def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_closing_loc(repository) ⇒ Object

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



18230
18231
18232
 
# File 'lib/prism/node.rb', line 18230

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_content_loc(repository) ⇒ Object

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



18217
18218
18219
 
# File 'lib/prism/node.rb', line 18217

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.



18204
18205
18206
 
# File 'lib/prism/node.rb', line 18204

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
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.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/prism/node_ext.rb', line 90

def to_interpolated
  InterpolatedXStringNode.new(
    source,
    -1,
    location,
    flags,
    opening_loc,
    [StringNode.new(source, node_id, content_loc, 0, nil, content_loc, nil, unescaped)],
    closing_loc
  )
end

#type ⇒ Object

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



18258
18259
18260
 
# File 'lib/prism/node.rb', line 18258

def type
  :x_string_node
end