Class: Prism::IndexTargetNode

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

Overview

Represents assigning to an index.

foo[bar], = 1
^^^^^^^^

begin
rescue => foo[bar]
          ^^^^^^^^
end

for foo[bar] in baz do end
    ^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, receiver, opening_loc, arguments, closing_loc, block, location) ⇒ IndexTargetNode

def initialize: (flags: Integer, receiver: Node, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, location: Location) -> void



8855
8856
8857
8858
8859
8860
8861
8862
8863
 
# File 'lib/prism/node.rb', line 8855

def initialize(flags, receiver, opening_loc, arguments, closing_loc, block, location)
  @flags = flags
  @receiver = receiver
  @opening_loc = opening_loc
  @arguments = arguments
  @closing_loc = closing_loc
  @block = block
  @location = location
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



8846
8847
8848
 
# File 'lib/prism/node.rb', line 8846

def arguments
  @arguments
end

#block ⇒ Object (readonly)

attr_reader block: Node?



8852
8853
8854
 
# File 'lib/prism/node.rb', line 8852

def block
  @block
end

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



8849
8850
8851
 
# File 'lib/prism/node.rb', line 8849

def closing_loc
  @closing_loc
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



8837
8838
8839
 
# File 'lib/prism/node.rb', line 8837

def flags
  @flags
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



8843
8844
8845
 
# File 'lib/prism/node.rb', line 8843

def opening_loc
  @opening_loc
end

#receiver ⇒ Object (readonly)

attr_reader receiver: Node



8840
8841
8842
 
# File 'lib/prism/node.rb', line 8840

def receiver
  @receiver
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



8983
8984
8985
 
# File 'lib/prism/node.rb', line 8983

def self.type
  :index_target_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



8866
8867
8868
 
# File 'lib/prism/node.rb', line 8866

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

#attribute_write? ⇒ Boolean

def attribute_write?: () -> bool

Returns:

  • (Boolean) 


8921
8922
8923
 
# File 'lib/prism/node.rb', line 8921

def attribute_write?
  flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



8871
8872
8873
 
# File 'lib/prism/node.rb', line 8871

def child_nodes
  [receiver, arguments, block]
end

#closing ⇒ Object

def closing: () -> String



8931
8932
8933
 
# File 'lib/prism/node.rb', line 8931

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



8885
8886
8887
 
# File 'lib/prism/node.rb', line 8885

def comment_targets
  [receiver, opening_loc, *arguments, closing_loc, *block]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



8876
8877
8878
8879
8880
8881
8882
 
# File 'lib/prism/node.rb', line 8876

def compact_child_nodes
  compact = []
  compact << receiver
  compact << arguments if arguments
  compact << block if block
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> IndexTargetNode



8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
 
# File 'lib/prism/node.rb', line 8890

def copy(**params)
  IndexTargetNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:arguments) { arguments },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:block) { block },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



8906
8907
8908
 
# File 'lib/prism/node.rb', line 8906

def deconstruct_keys(keys)
  { flags: flags, receiver: receiver, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
 
# File 'lib/prism/node.rb', line 8936

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── receiver:\n"
  inspector << inspector.child_node(receiver, "│   ")
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  if (arguments = self.arguments).nil?
    inspector << "├── arguments: ∅\n"
  else
    inspector << "├── arguments:\n"
    inspector << arguments.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  if (block = self.block).nil?
    inspector << "└── block: ∅\n"
  else
    inspector << "└── block:\n"
    inspector << block.inspect(inspector.child_inspector("    ")).delete_prefix(inspector.prefix)
  end
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String



8926
8927
8928
 
# File 'lib/prism/node.rb', line 8926

def opening
  opening_loc.slice
end

#safe_navigation? ⇒ Boolean

def safe_navigation?: () -> bool

Returns:

  • (Boolean) 


8911
8912
8913
 
# File 'lib/prism/node.rb', line 8911

def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



8973
8974
8975
 
# File 'lib/prism/node.rb', line 8973

def type
  :index_target_node
end

#variable_call? ⇒ Boolean

def variable_call?: () -> bool

Returns:

  • (Boolean) 


8916
8917
8918
 
# File 'lib/prism/node.rb', line 8916

def variable_call?
  flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end