Class: Prism::ParametersNode

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

Overview

Represents the list of parameters on a method, block, or lambda definition.

def a(b, c, d)
      ^^^^^^^
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(requireds, optionals, rest, posts, keywords, keyword_rest, block, location) ⇒ ParametersNode

def initialize: (requireds: Array, optionals: Array, rest: RestParameterNode?, posts: Array, keywords: Array, keyword_rest: Node?, block: BlockParameterNode?, location: Location) -> void



10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
 
# File 'lib/prism/node.rb', line 10765

def initialize(requireds, optionals, rest, posts, keywords, keyword_rest, block, location)
  @requireds = requireds
  @optionals = optionals
  @rest = rest
  @posts = posts
  @keywords = keywords
  @keyword_rest = keyword_rest
  @block = block
  @location = location
end

Instance Attribute Details

#block ⇒ Object (readonly)

attr_reader block: BlockParameterNode?



10762
10763
10764
 
# File 'lib/prism/node.rb', line 10762

def block
  @block
end

#keyword_rest ⇒ Object (readonly)

attr_reader keyword_rest: Node?



10759
10760
10761
 
# File 'lib/prism/node.rb', line 10759

def keyword_rest
  @keyword_rest
end

#keywords ⇒ Object (readonly)

attr_reader keywords: Array



10756
10757
10758
 
# File 'lib/prism/node.rb', line 10756

def keywords
  @keywords
end

#optionals ⇒ Object (readonly)

attr_reader optionals: Array



10747
10748
10749
 
# File 'lib/prism/node.rb', line 10747

def optionals
  @optionals
end

#posts ⇒ Object (readonly)

attr_reader posts: Array



10753
10754
10755
 
# File 'lib/prism/node.rb', line 10753

def posts
  @posts
end

#requireds ⇒ Object (readonly)

attr_reader requireds: Array



10744
10745
10746
 
# File 'lib/prism/node.rb', line 10744

def requireds
  @requireds
end

#rest ⇒ Object (readonly)

attr_reader rest: RestParameterNode?



10750
10751
10752
 
# File 'lib/prism/node.rb', line 10750

def rest
  @rest
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10777
10778
10779
 
# File 'lib/prism/node.rb', line 10777

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10782
10783
10784
 
# File 'lib/prism/node.rb', line 10782

def child_nodes
  [*requireds, *optionals, rest, *posts, *keywords, keyword_rest, block]
end

#comment_targets ⇒ Object

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



10800
10801
10802
 
# File 'lib/prism/node.rb', line 10800

def comment_targets
  [*requireds, *optionals, *rest, *posts, *keywords, *keyword_rest, *block]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
 
# File 'lib/prism/node.rb', line 10787

def compact_child_nodes
  compact = []
  compact.concat(requireds)
  compact.concat(optionals)
  compact << rest if rest
  compact.concat(posts)
  compact.concat(keywords)
  compact << keyword_rest if keyword_rest
  compact << block if block
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> ParametersNode



10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
 
# File 'lib/prism/node.rb', line 10805

def copy(**params)
  ParametersNode.new(
    params.fetch(:requireds) { requireds },
    params.fetch(:optionals) { optionals },
    params.fetch(:rest) { rest },
    params.fetch(:posts) { posts },
    params.fetch(:keywords) { keywords },
    params.fetch(:keyword_rest) { keyword_rest },
    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]



10822
10823
10824
 
# File 'lib/prism/node.rb', line 10822

def deconstruct_keys(keys)
  { requireds: requireds, optionals: optionals, rest: rest, posts: posts, keywords: keywords, keyword_rest: keyword_rest, block: block, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
 
# File 'lib/prism/node.rb', line 10826

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── requireds: #{inspector.list("#{inspector.prefix}│   ", requireds)}"
  inspector << "├── optionals: #{inspector.list("#{inspector.prefix}│   ", optionals)}"
  if (rest = self.rest).nil?
    inspector << "├── rest: ∅\n"
  else
    inspector << "├── rest:\n"
    inspector << rest.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── posts: #{inspector.list("#{inspector.prefix}│   ", posts)}"
  inspector << "├── keywords: #{inspector.list("#{inspector.prefix}│   ", keywords)}"
  if (keyword_rest = self.keyword_rest).nil?
    inspector << "├── keyword_rest: ∅\n"
  else
    inspector << "├── keyword_rest:\n"
    inspector << keyword_rest.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  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

#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



10867
10868
10869
 
# File 'lib/prism/node.rb', line 10867

def type
  :parameters_node
end