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.



814
815
816
817
818
819
820
 
# File 'lib/prism/node.rb', line 814

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)
    ^^^^^^^^



891
892
893
 
# File 'lib/prism/node.rb', line 891

def arguments
  @arguments
end

Class Method Details

.type ⇒ Object

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



904
905
906
 
# File 'lib/prism/node.rb', line 904

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.



910
911
912
913
914
915
 
# File 'lib/prism/node.rb', line 910

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



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

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



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

def child_nodes
  [*arguments]
end

#comment_targets ⇒ Object

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



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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



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

def compact_child_nodes
  [*arguments]
end

#contains_forwarding? ⇒ Boolean

def contains_forwarding?: () -> bool

Returns:

  • (Boolean) 


863
864
865
 
# File 'lib/prism/node.rb', line 863

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

#contains_keyword_splat? ⇒ Boolean

def contains_keyword_splat?: () -> bool

Returns:

  • (Boolean) 


873
874
875
 
# File 'lib/prism/node.rb', line 873

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

#contains_keywords? ⇒ Boolean

def contains_keywords?: () -> bool

Returns:

  • (Boolean) 


868
869
870
 
# File 'lib/prism/node.rb', line 868

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

#contains_multiple_splats? ⇒ Boolean

def contains_multiple_splats?: () -> bool

Returns:

  • (Boolean) 


883
884
885
 
# File 'lib/prism/node.rb', line 883

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

#contains_splat? ⇒ Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean) 


878
879
880
 
# File 'lib/prism/node.rb', line 878

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



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

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 }



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

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

#each_child_node ⇒ Object

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



833
834
835
836
837
 
# File 'lib/prism/node.rb', line 833

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  arguments.each { |node| yield node }
end

#inspect ⇒ Object

def inspect -> String



894
895
896
 
# File 'lib/prism/node.rb', line 894

def inspect
  InspectVisitor.compose(self)
end

#type ⇒ Object

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



899
900
901
 
# File 'lib/prism/node.rb', line 899

def type
  :arguments_node
end