Class: SyntaxTree::RBS::Format

Inherits:
Visitor
  • Object
show all
Defined in:
lib/syntax_tree/rbs/format.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Visitor

#visit

Constructor Details

#initialize(q) ⇒ Format

Returns a new instance of Format.



8
9
10
 
# File 'lib/syntax_tree/rbs/format.rb', line 8

def initialize(q)
  @q = q
end

Instance Attribute Details

#q ⇒ Object (readonly)

Returns the value of attribute q.



6
7
8
 
# File 'lib/syntax_tree/rbs/format.rb', line 6

def q
  @q
end

Instance Method Details

#visit_alias(node) ⇒ Object

Visit a RBS::AST::Members::Alias node.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/syntax_tree/rbs/format.rb', line 17

def visit_alias(node)
  print_comment(node)
  print_annotations(node)

  if node.kind == :singleton
    q.text("alias self.")
    q.text(node.new_name)
    q.text(" self.")
    q.text(node.old_name)
  else
    q.text("alias ")
    q.text(node.new_name)
    q.text(" ")
    q.text(node.old_name)
  end
end

#visit_alias_type(node) ⇒ Object

Visit a RBS::Types::Alias node.



35
36
37
 
# File 'lib/syntax_tree/rbs/format.rb', line 35

def visit_alias_type(node)
  visit(node.name)
end

#visit_attr_accessor_member(node) ⇒ Object

Visit a RBS::AST::Members::AttrAccessor node.



43
44
45
46
47
 
# File 'lib/syntax_tree/rbs/format.rb', line 43

def visit_attr_accessor_member(node)
  print_comment(node)
  print_annotations(node)
  print_attribute(:accessor, node)
end

#visit_attr_reader_member(node) ⇒ Object

Visit a RBS::AST::Members::AttrReader node.



50
51
52
53
54
 
# File 'lib/syntax_tree/rbs/format.rb', line 50

def visit_attr_reader_member(node)
  print_comment(node)
  print_annotations(node)
  print_attribute(:reader, node)
end

#visit_attr_writer_member(node) ⇒ Object

Visit a RBS::AST::Members::AttrWriter node.



57
58
59
60
61
 
# File 'lib/syntax_tree/rbs/format.rb', line 57

def visit_attr_writer_member(node)
  print_comment(node)
  print_annotations(node)
  print_attribute(:writer, node)
end

#visit_base_type(node) ⇒ Object Also known as: visit_any_type, visit_bool_type, visit_bottom_type, visit_class_type, visit_instance_type, visit_nil_type, visit_self_type, visit_top_type, visit_void_type 



12
13
14
 
# File 'lib/syntax_tree/rbs/format.rb', line 12

def visit_base_type(node)
  q.text(node.to_s)
end

#visit_class_declaration(node) ⇒ Object

Visit a RBS::AST::Declarations::Class node.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/syntax_tree/rbs/format.rb', line 70

def visit_class_declaration(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("class ")
    print_name_and_type_params(node)

    if node.super_class
      q.text(" < ")
      print_name_and_args(node.super_class)
    end

    q.indent { print_members(node) }
    q.breakable(force: true)
    q.text("end")
  end
end

#visit_class_instance_type(node) ⇒ Object

Visit a RBS::Types::ClassInstance node.



90
91
92
 
# File 'lib/syntax_tree/rbs/format.rb', line 90

def visit_class_instance_type(node)
  print_name_and_args(node)
end

#visit_class_instance_variable_member(node) ⇒ Object

Visit a RBS::AST::Members::ClassInstanceVariable node.



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/syntax_tree/rbs/format.rb', line 95

def visit_class_instance_variable_member(node)
  print_comment(node)

  q.group do
    q.text("self.")
    q.text(node.name)
    q.text(": ")
    visit(node.type)
  end
end

#visit_class_singleton_type(node) ⇒ Object

Visit a RBS::Types::ClassSingleton node.



107
108
109
110
111
 
# File 'lib/syntax_tree/rbs/format.rb', line 107

def visit_class_singleton_type(node)
  q.text("singleton(")
  visit(node.name)
  q.text(")")
end

#visit_class_variable_member(node) ⇒ Object

Visit a RBS::AST::Members::ClassVariable node.



117
118
119
120
121
122
123
124
125
 
# File 'lib/syntax_tree/rbs/format.rb', line 117

def visit_class_variable_member(node)
  print_comment(node)

  q.group do
    q.text(node.name)
    q.text(": ")
    visit(node.type)
  end
end

#visit_constant_declaration(node) ⇒ Object

Visit a RBS::AST::Declarations::Constant node.



128
129
130
131
132
133
134
135
136
 
# File 'lib/syntax_tree/rbs/format.rb', line 128

def visit_constant_declaration(node)
  print_comment(node)

  q.group do
    visit(node.name)
    q.text(": ")
    visit(node.type)
  end
end

#visit_extend_member(node) ⇒ Object

Visit a RBS::AST::Members::Extend node.



139
140
141
142
143
144
145
146
147
 
# File 'lib/syntax_tree/rbs/format.rb', line 139

def visit_extend_member(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("extend ")
    print_name_and_args(node)
  end
end

#visit_function_param_type(node) ⇒ Object

Visit a RBS::Types::Function::Param node.



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/syntax_tree/rbs/format.rb', line 150

def visit_function_param_type(node)
  visit(node.type)

  if node.name
    q.text(" ")

    if ::RBS::Parser::KEYWORDS.include?(node.name.to_s)
      q.text("`#{node.name}`")
    else
      q.text(node.name)
    end
  end
end

#visit_global_declaration(node) ⇒ Object

Visit a RBS::AST::Declarations::Global node.



165
166
167
168
169
170
171
172
173
 
# File 'lib/syntax_tree/rbs/format.rb', line 165

def visit_global_declaration(node)
  print_comment(node)

  q.group do
    q.text(node.name)
    q.text(": ")
    visit(node.type)
  end
end

#visit_include_member(node) ⇒ Object

Visit a RBS::AST::Members::Include node.



176
177
178
179
180
181
182
183
184
 
# File 'lib/syntax_tree/rbs/format.rb', line 176

def visit_include_member(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("include ")
    print_name_and_args(node)
  end
end

#visit_instance_variable_member(node) ⇒ Object

Visit a RBS::AST::Members::InstanceVariable node.



190
191
192
193
194
195
196
197
198
 
# File 'lib/syntax_tree/rbs/format.rb', line 190

def visit_instance_variable_member(node)
  print_comment(node)

  q.group do
    q.text(node.name)
    q.text(": ")
    visit(node.type)
  end
end

#visit_interface_declaration(node) ⇒ Object

Visit a RBS::AST::Declarations::Interface node.



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/syntax_tree/rbs/format.rb', line 201

def visit_interface_declaration(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("interface ")
    print_name_and_type_params(node)
    q.indent { print_members(node) }
    q.breakable(force: true)
    q.text("end")
  end
end

#visit_interface_type(node) ⇒ Object

Visit a RBS::Types::Interface node.



215
216
217
 
# File 'lib/syntax_tree/rbs/format.rb', line 215

def visit_interface_type(node)
  print_name_and_args(node)
end

#visit_intersection_type(node) ⇒ Object

Visit a RBS::Types::Intersection node.



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/syntax_tree/rbs/format.rb', line 220

def visit_intersection_type(node)
  separator =
    lambda do
      q.breakable
      q.text("& ")
    end

  q.text("(") if q.force_parens?
  q.group do
    q.force_parens do
      q.seplist(node.types, separator) { |type| visit(type) }
    end
  end
  q.text(")") if q.force_parens?
end

#visit_literal_type(node) ⇒ Object

Visit a RBS::Types::Literal node.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/syntax_tree/rbs/format.rb', line 237

def visit_literal_type(node)
  unless node.literal.is_a?(String)
    q.text(node.literal.inspect)
    return
  end

  # We're going to go straight to the source here, as if we don't then
  # we're going to end up with the result of String#inspect, which does
  # weird things to escape sequences.
  source = q.source[node.location.range]
  quote = source.include?("\\") ? source[0] : "\""
  source = SyntaxTree::Quotes.normalize(source[1..-2], quote)

  q.text(quote)
  q.seplist(
    source.split(/\r?\n/),
    -> { q.breakable(force: true) }
  ) { |line| q.text(line) }
  q.text(quote)
end

#visit_method_definition_member(node) ⇒ Object

Visit a RBS::AST::Members::MethodDefinition node.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/syntax_tree/rbs/format.rb', line 259

def visit_method_definition_member(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("#{node.visibility} ") if node.visibility
    q.text("def ")

    if node.kind == :singleton
      q.text("self.")
    elsif node.kind == :singleton_instance
      q.text("self?.")
    end

    q.text(
      (
        if ::RBS::Parser::KEYWORDS.include?(node.name.to_s)
          "`#{node.name}`"
        else
          node.name
        end
      )
    )
    q.text(":")

    if node.overloads.length == 1 && !node.overloading?
      q.text(" ")
      print_method_overload(node.overloads.first)
    else
      separator =
        lambda do
          q.breakable
          q.text("| ")
        end

      q.group do
        q.indent do
          q.breakable
          q.seplist(node.overloads, separator) do |overload|
            print_method_overload(overload)
          end

          if node.overloading?
            separator.call
            q.text("...")
          end
        end
      end
    end
  end
end

#visit_module_declaration(node) ⇒ Object

Visit a RBS::AST::Declarations::Module node.



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/syntax_tree/rbs/format.rb', line 312

def visit_module_declaration(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("module ")
    print_name_and_type_params(node)

    if node.self_types.any?
      q.text(" : ")
      q.seplist(node.self_types, -> { q.text(", ") }) do |self_type|
        print_name_and_args(self_type)
      end
    end

    q.indent { print_members(node) }
    q.breakable(force: true)
    q.text("end")
  end
end

#visit_optional_type(node) ⇒ Object

Visit a RBS::Types::Optional node.



337
338
339
340
 
# File 'lib/syntax_tree/rbs/format.rb', line 337

def visit_optional_type(node)
  q.force_parens { visit(node.type) }
  q.text("?")
end

#visit_prepend_member(node) ⇒ Object

Visit a RBS::AST::Members::Prepend node.



343
344
345
346
347
348
349
350
351
 
# File 'lib/syntax_tree/rbs/format.rb', line 343

def visit_prepend_member(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("prepend ")
    print_name_and_args(node)
  end
end

#visit_private_member(node) ⇒ Object

Visit a RBS::AST::Members::Private node.



354
355
356
 
# File 'lib/syntax_tree/rbs/format.rb', line 354

def visit_private_member(node)
  q.text("private")
end

#visit_proc_type(node) ⇒ Object

Visit a RBS::Types::Proc node.



359
360
361
362
363
364
365
366
 
# File 'lib/syntax_tree/rbs/format.rb', line 359

def visit_proc_type(node)
  q.group do
    q.text("(") if q.force_parens?
    q.text("^")
    print_method_signature(node)
    q.text(")") if q.force_parens?
  end
end

#visit_public_member(node) ⇒ Object

Visit a RBS::AST::Members::Public node.



369
370
371
 
# File 'lib/syntax_tree/rbs/format.rb', line 369

def visit_public_member(node)
  q.text("public")
end

#visit_record_type(node) ⇒ Object

Visit a RBS::Types::Record node.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/syntax_tree/rbs/format.rb', line 374

def visit_record_type(node)
  separator =
    lambda do
      q.text(",")
      q.breakable
    end

  q.group do
    q.text("{")
    q.indent do
      q.breakable
      q.seplist(node.fields, separator, :each_pair) do |key, type|
        if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_]*\z/)
          q.text("#{key}: ")
        else
          q.text("#{key.inspect} => ")
        end

        visit(type)
      end
    end
    q.breakable
    q.text("}")
  end
end

#visit_root(node) ⇒ Object

Visit a SyntaxTree::RBS::Root node.



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/syntax_tree/rbs/format.rb', line 401

def visit_root(node)
  separator =
    lambda do
      q.breakable(force: true)
      q.breakable(force: true)
    end

  q.seplist(node.declarations, separator) do |declaration|
    visit(declaration)
  end

  q.breakable(force: true)
end

#visit_tuple_type(node) ⇒ Object

Visit a RBS::Types::Tuple node.



422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/syntax_tree/rbs/format.rb', line 422

def visit_tuple_type(node)
  # If we don't have any sub types, we explicitly need the space in
  # between the brackets to not confuse the parser.
  if node.types.empty?
    q.text("[ ]")
    return
  end

  q.group do
    q.text("[")
    q.seplist(node.types, -> { q.text(", ") }) { |type| visit(type) }
    q.text("]")
  end
end

#visit_type_alias(node) ⇒ Object

Visit a RBS::AST::Declarations::TypeAlias node.



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/syntax_tree/rbs/format.rb', line 438

def visit_type_alias(node)
  print_comment(node)
  print_annotations(node)

  q.group do
    q.text("type ")
    visit(node.name)
    q.text(" =")
    q.group do
      q.indent do
        q.breakable
        visit(node.type)
      end
    end
  end
end

#visit_type_name(node) ⇒ Object

Visit a RBS::TypeName node.



456
457
458
 
# File 'lib/syntax_tree/rbs/format.rb', line 456

def visit_type_name(node)
  q.text(node.to_s)
end

#visit_union_type(node) ⇒ Object

Visit a RBS::Types::Union node.



461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/syntax_tree/rbs/format.rb', line 461

def visit_union_type(node)
  separator =
    lambda do
      q.breakable
      q.text("| ")
    end

  q.text("(") if q.force_parens?
  q.group { q.seplist(node.types, separator) { |type| visit(type) } }
  q.text(")") if q.force_parens?
end

#visit_variable_type(node) ⇒ Object

Visit a RBS::Types::Variable node.



474
475
476
 
# File 'lib/syntax_tree/rbs/format.rb', line 474

def visit_variable_type(node)
  q.text(node.name)
end