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.



16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
 
# File 'lib/prism/node.rb', line 16434

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



16510
16511
16512
 
# File 'lib/prism/node.rb', line 16510

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



16538
16539
16540
 
# File 'lib/prism/node.rb', line 16538

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.



16544
16545
16546
16547
16548
16549
16550
16551
 
# File 'lib/prism/node.rb', line 16544

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



16446
16447
16448
 
# File 'lib/prism/node.rb', line 16446

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16451
16452
16453
 
# File 'lib/prism/node.rb', line 16451

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



16523
16524
16525
 
# File 'lib/prism/node.rb', line 16523

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



16503
16504
16505
16506
16507
 
# File 'lib/prism/node.rb', line 16503

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]



16461
16462
16463
 
# File 'lib/prism/node.rb', line 16461

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16456
16457
16458
 
# File 'lib/prism/node.rb', line 16456

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



16518
16519
16520
 
# File 'lib/prism/node.rb', line 16518

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



16496
16497
16498
16499
16500
 
# File 'lib/prism/node.rb', line 16496

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



16466
16467
16468
 
# File 'lib/prism/node.rb', line 16466

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 }



16474
16475
16476
 
# File 'lib/prism/node.rb', line 16474

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) 


16484
16485
16486
 
# File 'lib/prism/node.rb', line 16484

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


16479
16480
16481
 
# File 'lib/prism/node.rb', line 16479

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

#inspect ⇒ Object

def inspect -> String



16528
16529
16530
 
# File 'lib/prism/node.rb', line 16528

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



16513
16514
16515
 
# File 'lib/prism/node.rb', line 16513

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



16489
16490
16491
16492
16493
 
# File 'lib/prism/node.rb', line 16489

def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
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`.



16533
16534
16535
 
# File 'lib/prism/node.rb', line 16533

def type
  :x_string_node
end