Class: YARP::BlockParametersNode

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

Overview

Represents a block’s parameters declaration.

-> (a, b = 1; local) { }
   ^^^^^^^^^^^^^^^^^

foo do |a, b = 1; local|
       ^^^^^^^^^^^^^^^^^
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parameters, locals, opening_loc, closing_loc, location) ⇒ BlockParametersNode

def initialize: (parameters: ParametersNode?, locals: Array, opening_loc: Location?, closing_loc: Location?, location: Location) -> void



1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/yarp/node.rb', line 1078

def initialize(parameters, locals, opening_loc, closing_loc, location)
  @parameters = parameters
  @locals = locals
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location?



1075
1076
1077
 
# File 'lib/yarp/node.rb', line 1075

def closing_loc
  @closing_loc
end

#locals ⇒ Object (readonly)

attr_reader locals: Array



1069
1070
1071
 
# File 'lib/yarp/node.rb', line 1069

def locals
  @locals
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



1072
1073
1074
 
# File 'lib/yarp/node.rb', line 1072

def opening_loc
  @opening_loc
end

#parameters ⇒ Object (readonly)

attr_reader parameters: ParametersNode?



1066
1067
1068
 
# File 'lib/yarp/node.rb', line 1066

def parameters
  @parameters
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



1087
1088
1089
 
# File 'lib/yarp/node.rb', line 1087

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1092
1093
1094
 
# File 'lib/yarp/node.rb', line 1092

def child_nodes
  [parameters, *locals]
end

#closing ⇒ Object

def closing: () -> String?



1126
1127
1128
 
# File 'lib/yarp/node.rb', line 1126

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

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



1097
1098
1099
 
# File 'lib/yarp/node.rb', line 1097

def comment_targets
  [*parameters, *locals, *opening_loc, *closing_loc]
end

#copy(**params) ⇒ Object

def copy: (**params) -> BlockParametersNode



1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/yarp/node.rb', line 1102

def copy(**params)
  BlockParametersNode.new(
    params.fetch(:parameters) { parameters },
    params.fetch(:locals) { locals },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



1116
1117
1118
 
# File 'lib/yarp/node.rb', line 1116

def deconstruct_keys(keys)
  { parameters: parameters, locals: locals, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/yarp/node.rb', line 1130

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (parameters = self.parameters).nil?
    inspector << "├── parameters: ∅\n"
  else
    inspector << "├── parameters:\n"
    inspector << parameters.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── locals: #{inspector.list("#{inspector.prefix}│   ", locals)}"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String?



1121
1122
1123
 
# File 'lib/yarp/node.rb', line 1121

def opening
  opening_loc&.slice
end