Class: Prism::RestParameterNode

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

Overview

Represents a rest parameter to a method, block, or lambda definition.

def a(*b)
      ^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name, name_loc, operator_loc) ⇒ RestParameterNode

Initialize a new RestParameterNode node.


15885
15886
15887
15888
15889
15890
15891
15892
15893
# File 'lib/prism/node.rb', line 15885

def initialize(source, node_id, location, flags, name, name_loc, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
end

Instance Attribute Details

#nameObject (readonly)

attr_reader name: Symbol?


15934
15935
15936
# File 'lib/prism/node.rb', line 15934

def name
  @name
end

Class Method Details

.typeObject

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


15984
15985
15986
# File 'lib/prism/node.rb', line 15984

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


15990
15991
15992
15993
15994
15995
15996
# File 'lib/prism/node.rb', line 15990

def ===(other)
  other.is_a?(RestParameterNode) &&
    (flags === other.flags) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void


15896
15897
15898
# File 'lib/prism/node.rb', line 15896

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

#child_nodesObject Also known as: deconstruct

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


15901
15902
15903
# File 'lib/prism/node.rb', line 15901

def child_nodes
  []
end

#comment_targetsObject

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


15911
15912
15913
# File 'lib/prism/node.rb', line 15911

def comment_targets
  [*name_loc, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array


15906
15907
15908
# File 'lib/prism/node.rb', line 15906

def compact_child_nodes
  []
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol?, ?name_loc: Location?, ?operator_loc: Location) -> RestParameterNode


15916
15917
15918
# File 'lib/prism/node.rb', line 15916

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc)
  RestParameterNode.new(source, node_id, location, flags, name, name_loc, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol?, name_loc: Location?, operator_loc: Location }


15924
15925
15926
# File 'lib/prism/node.rb', line 15924

def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, name_loc: name_loc, operator_loc: operator_loc }
end

#inspectObject

def inspect -> String


15974
15975
15976
# File 'lib/prism/node.rb', line 15974

def inspect
  InspectVisitor.compose(self)
end

#name_locObject

attr_reader name_loc: Location?


15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
# File 'lib/prism/node.rb', line 15937

def name_loc
  location = @name_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#operatorObject

def operator: () -> String


15969
15970
15971
# File 'lib/prism/node.rb', line 15969

def operator
  operator_loc.slice
end

#operator_locObject

attr_reader operator_loc: Location


15956
15957
15958
15959
15960
# File 'lib/prism/node.rb', line 15956

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#repeated_parameter?Boolean

def repeated_parameter?: () -> bool

Returns:

  • (Boolean)

15929
15930
15931
# File 'lib/prism/node.rb', line 15929

def repeated_parameter?
  flags.anybits?(ParameterFlags::REPEATED_PARAMETER)
end

#save_name_loc(repository) ⇒ Object

Save the name_loc location using the given saved source so that it can be retrieved later.


15951
15952
15953
# File 'lib/prism/node.rb', line 15951

def save_name_loc(repository)
  repository.enter(node_id, :name_loc) unless @name_loc.nil?
end

#save_operator_loc(repository) ⇒ Object

Save the operator_loc location using the given saved source so that it can be retrieved later.


15964
15965
15966
# File 'lib/prism/node.rb', line 15964

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#typeObject

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


15979
15980
15981
# File 'lib/prism/node.rb', line 15979

def type
  :rest_parameter_node
end