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.



764
765
766
767
768
769
770
# File 'lib/prism/node.rb', line 764

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

Instance Attribute Details

#argumentsObject (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)
    ^^^^^^^^


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

def arguments
  @arguments
end

Class Method Details

.typeObject

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



847
848
849
# File 'lib/prism/node.rb', line 847

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.



853
854
855
856
857
858
# File 'lib/prism/node.rb', line 853

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



773
774
775
# File 'lib/prism/node.rb', line 773

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

#child_nodesObject Also known as: deconstruct

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



778
779
780
# File 'lib/prism/node.rb', line 778

def child_nodes
  [*arguments]
end

#comment_targetsObject

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



788
789
790
# File 'lib/prism/node.rb', line 788

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

#compact_child_nodesObject

def compact_child_nodes: () -> Array



783
784
785
# File 'lib/prism/node.rb', line 783

def compact_child_nodes
  [*arguments]
end

#contains_forwarding?Boolean

def contains_forwarding?: () -> bool

Returns:

  • (Boolean)


806
807
808
# File 'lib/prism/node.rb', line 806

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

#contains_keyword_splat?Boolean

def contains_keyword_splat?: () -> bool

Returns:

  • (Boolean)


816
817
818
# File 'lib/prism/node.rb', line 816

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

#contains_keywords?Boolean

def contains_keywords?: () -> bool

Returns:

  • (Boolean)


811
812
813
# File 'lib/prism/node.rb', line 811

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

#contains_multiple_splats?Boolean

def contains_multiple_splats?: () -> bool

Returns:

  • (Boolean)


826
827
828
# File 'lib/prism/node.rb', line 826

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

#contains_splat?Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean)


821
822
823
# File 'lib/prism/node.rb', line 821

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



793
794
795
# File 'lib/prism/node.rb', line 793

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 }



801
802
803
# File 'lib/prism/node.rb', line 801

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

#inspectObject

def inspect -> String



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

def inspect
  InspectVisitor.compose(self)
end

#typeObject

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



842
843
844
# File 'lib/prism/node.rb', line 842

def type
  :arguments_node
end