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.



18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
 
# File 'lib/prism/node.rb', line 18344

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



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

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



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

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.



18472
18473
18474
18475
18476
18477
18478
18479
 
# File 'lib/prism/node.rb', line 18472

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



18356
18357
18358
 
# File 'lib/prism/node.rb', line 18356

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



18361
18362
18363
 
# File 'lib/prism/node.rb', line 18361

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



18451
18452
18453
 
# File 'lib/prism/node.rb', line 18451

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



18425
18426
18427
18428
18429
 
# File 'lib/prism/node.rb', line 18425

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]



18371
18372
18373
 
# File 'lib/prism/node.rb', line 18371

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



18366
18367
18368
 
# File 'lib/prism/node.rb', line 18366

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



18446
18447
18448
 
# File 'lib/prism/node.rb', line 18446

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



18412
18413
18414
18415
18416
 
# File 'lib/prism/node.rb', line 18412

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



18376
18377
18378
 
# File 'lib/prism/node.rb', line 18376

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 }



18384
18385
18386
 
# File 'lib/prism/node.rb', line 18384

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) 


18394
18395
18396
 
# File 'lib/prism/node.rb', line 18394

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


18389
18390
18391
 
# File 'lib/prism/node.rb', line 18389

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

#inspect ⇒ Object

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



18441
18442
18443
 
# File 'lib/prism/node.rb', line 18441

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



18399
18400
18401
18402
18403
 
# File 'lib/prism/node.rb', line 18399

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.



18433
18434
18435
 
# File 'lib/prism/node.rb', line 18433

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.



18420
18421
18422
 
# File 'lib/prism/node.rb', line 18420

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.



18407
18408
18409
 
# File 'lib/prism/node.rb', line 18407

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.



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/prism/node_ext.rb', line 93

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`.



18461
18462
18463
 
# File 'lib/prism/node.rb', line 18461

def type
  :x_string_node
end