Class: Prism::ArgumentsNode

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

Overview

Represents a set of arguments to a method or a keyword.

return foo, bar, baz
       ^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, arguments) ⇒ ArgumentsNode

Initialize a new ArgumentsNode node.



767
768
769
770
771
772
773
 
# File 'lib/prism/node.rb', line 767

def initialize(source, node_id, location, flags, arguments)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @arguments = arguments
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

The list of arguments, if present. These can be any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo(bar, baz)
    ^^^^^^^^



837
838
839
 
# File 'lib/prism/node.rb', line 837

def arguments
  @arguments
end

Class Method Details

.type ⇒ Object

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



850
851
852
 
# File 'lib/prism/node.rb', line 850

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



856
857
858
859
860
861
 
# File 'lib/prism/node.rb', line 856

def ===(other)
  other.is_a?(ArgumentsNode) &&
    (flags === other.flags) &&
    (arguments.length == other.arguments.length) &&
    arguments.zip(other.arguments).all? { |left, right| left === right }
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



776
777
778
 
# File 'lib/prism/node.rb', line 776

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



781
782
783
 
# File 'lib/prism/node.rb', line 781

def child_nodes
  [*arguments]
end

#comment_targets ⇒ Object

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



791
792
793
 
# File 'lib/prism/node.rb', line 791

def comment_targets
  [*arguments] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



786
787
788
 
# File 'lib/prism/node.rb', line 786

def compact_child_nodes
  [*arguments]
end

#contains_forwarding? ⇒ Boolean

def contains_forwarding?: () -> bool

Returns:

  • (Boolean) 


809
810
811
 
# File 'lib/prism/node.rb', line 809

def contains_forwarding?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_FORWARDING)
end

#contains_keyword_splat? ⇒ Boolean

def contains_keyword_splat?: () -> bool

Returns:

  • (Boolean) 


819
820
821
 
# File 'lib/prism/node.rb', line 819

def contains_keyword_splat?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end

#contains_keywords? ⇒ Boolean

def contains_keywords?: () -> bool

Returns:

  • (Boolean) 


814
815
816
 
# File 'lib/prism/node.rb', line 814

def contains_keywords?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORDS)
end

#contains_multiple_splats? ⇒ Boolean

def contains_multiple_splats?: () -> bool

Returns:

  • (Boolean) 


829
830
831
 
# File 'lib/prism/node.rb', line 829

def contains_multiple_splats?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_MULTIPLE_SPLATS)
end

#contains_splat? ⇒ Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean) 


824
825
826
 
# File 'lib/prism/node.rb', line 824

def contains_splat?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_SPLAT)
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, arguments: self.arguments) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?arguments: Array) -> ArgumentsNode



796
797
798
 
# File 'lib/prism/node.rb', line 796

def copy(node_id: self.node_id, location: self.location, flags: self.flags, arguments: self.arguments)
  ArgumentsNode.new(source, node_id, location, flags, arguments)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, arguments: Array }



804
805
806
 
# File 'lib/prism/node.rb', line 804

def deconstruct_keys(keys)
  { node_id: node_id, location: location, arguments: arguments }
end

#inspect ⇒ Object

def inspect -> String



840
841
842
 
# File 'lib/prism/node.rb', line 840

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



845
846
847
 
# File 'lib/prism/node.rb', line 845

def type
  :arguments_node
end