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.



19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
 
# File 'lib/prism/node.rb', line 19481

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



19581
19582
19583
 
# File 'lib/prism/node.rb', line 19581

def unescaped
  @unescaped
end

Class Method Details

.type ⇒ Object

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



19609
19610
19611
 
# File 'lib/prism/node.rb', line 19609

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.



19615
19616
19617
19618
19619
19620
19621
19622
 
# File 'lib/prism/node.rb', line 19615

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



19493
19494
19495
 
# File 'lib/prism/node.rb', line 19493

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



19498
19499
19500
 
# File 'lib/prism/node.rb', line 19498

def child_nodes
  []
end

#closing ⇒ Object

def closing: () -> String



19594
19595
19596
 
# File 'lib/prism/node.rb', line 19594

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location



19568
19569
19570
19571
19572
 
# File 'lib/prism/node.rb', line 19568

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]



19514
19515
19516
 
# File 'lib/prism/node.rb', line 19514

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



19509
19510
19511
 
# File 'lib/prism/node.rb', line 19509

def compact_child_nodes
  []
end

#content ⇒ Object

def content: () -> String



19589
19590
19591
 
# File 'lib/prism/node.rb', line 19589

def content
  content_loc.slice
end

#content_loc ⇒ Object

attr_reader content_loc: Location



19555
19556
19557
19558
19559
 
# File 'lib/prism/node.rb', line 19555

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



19519
19520
19521
 
# File 'lib/prism/node.rb', line 19519

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 }



19527
19528
19529
 
# File 'lib/prism/node.rb', line 19527

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 ⇒ Object

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



19503
19504
19505
19506
 
# File 'lib/prism/node.rb', line 19503

def each_child_node
  return to_enum(:each_child_node) unless block_given?

end

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool



19537
19538
19539
 
# File 'lib/prism/node.rb', line 19537

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool



19532
19533
19534
 
# File 'lib/prism/node.rb', line 19532

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

#inspect ⇒ Object

def inspect -> String



19599
19600
19601
 
# File 'lib/prism/node.rb', line 19599

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



19584
19585
19586
 
# File 'lib/prism/node.rb', line 19584

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location



19542
19543
19544
19545
19546
 
# File 'lib/prism/node.rb', line 19542

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.



19576
19577
19578
 
# File 'lib/prism/node.rb', line 19576

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.



19563
19564
19565
 
# File 'lib/prism/node.rb', line 19563

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.



19550
19551
19552
 
# File 'lib/prism/node.rb', line 19550

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



19604
19605
19606
 
# File 'lib/prism/node.rb', line 19604

def type
  :x_string_node
end