-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
formatter.cr
4635 lines (3924 loc) · 109 KB
/
formatter.cr
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require "../syntax"
module Crystal
def self.format(source, filename = nil)
Crystal::Formatter.format(source, filename: filename)
end
class Formatter < Visitor
def self.format(source, filename = nil)
parser = Parser.new(source)
parser.filename = filename
nodes = parser.parse
formatter = new(source)
formatter.skip_space_or_newline
nodes.accept formatter
formatter.finish
end
record AlignInfo,
id : UInt64,
line : Int32,
start_column : Int32,
middle_column : Int32,
end_column : Int32,
number : Bool do
def size
end_column - start_column
end
end
class CommentInfo
property start_line : Int32
property end_line : Int32
property needs_newline : Bool
def initialize(@start_line : Int32, @kind : Symbol)
@end_line = @start_line
@needs_newline = true
end
end
record HeredocFix,
start_line : Int32,
end_line : Int32,
difference : Int32
@lexer : Lexer
@comment_columns : Array(Int32?)
@indent : Int32
@line : Int32
@column : Int32
@token : Token
@output : IO::Memory
@line_output : IO::Memory
@wrote_newline : Bool
@wrote_comment : Bool
@macro_state : Token::MacroState
@inside_macro : Int32
@inside_cond : Int32
@inside_lib : Int32
@inside_struct_or_union : Int32
@dot_column : Int32?
@def_indent : Int32
@last_write : String
@exp_needs_indent : Bool
@inside_def : Int32
@when_infos : Array(AlignInfo)
@hash_infos : Array(AlignInfo)
@assign_infos : Array(AlignInfo)
@doc_comments : Array(CommentInfo)
@current_doc_comment : CommentInfo?
@hash_in_same_line : Set(UInt64)
@shebang : Bool
@heredoc_fixes : Array(HeredocFix)
@assign_length : Int32?
@current_hash : ASTNode?
def initialize(source)
@lexer = Lexer.new(source)
@lexer.comments_enabled = true
@lexer.count_whitespace = true
@lexer.wants_raw = true
@comment_columns = [nil] of Int32?
@indent = 0
@line = 0
@column = 0
@token = @lexer.token
@token = next_token
@output = IO::Memory.new(source.bytesize)
@line_output = IO::Memory.new
@wrote_newline = false
@wrote_comment = false
@macro_state = Token::MacroState.default
@inside_macro = 0
@inside_cond = 0
@inside_lib = 0
@inside_struct_or_union = 0
@dot_column = nil
@def_indent = 0
@last_write = ""
@exp_needs_indent = true
@inside_def = 0
# When we parse a type, parentheses information is not stored in ASTs, unlike
# for an Expressions node. So when we are printing a type (Path, ProcNotation, Union, etc.)
# we increment this when we find a '(', and decrement it when we find ')', but
# only if `paren_count > 0`: it might be the case of `def foo(x : A)`, but we don't
# want to print that last ')' when printing the type A.
@paren_count = 0
# This stores the column number (if any) of each comment in every line
@when_infos = [] of AlignInfo
@hash_infos = [] of AlignInfo
@assign_infos = [] of AlignInfo
@doc_comments = [] of CommentInfo
@current_doc_comment = nil
@hash_in_same_line = Set(UInt64).new
@shebang = @token.type == :COMMENT && @token.value.to_s.starts_with?("#!")
@heredoc_fixes = [] of HeredocFix
@last_is_heredoc = false
@last_arg_is_skip = false
@string_continuation = 0
@inside_call_or_assign = 0
@passed_backslash_newline = false
# Lines that must not be rstripped (HEREDOC lines)
@no_rstrip_lines = Set(Int32).new
end
def end_visit_any(node)
case node
when StringLiteral, StringInterpolation
# Nothing
else
@last_is_heredoc = false
end
end
def visit(node : FileNode)
true
end
def visit(node : Expressions)
if node.expressions.size == 1 && @token.type == :"("
# If it's (...) with a single expression, we treat it
# like a single expression, indenting it if needed
write "("
next_token_skip_space
if @token.type == :NEWLINE
next_token_skip_space_or_newline
write_line
write_indent(@indent + 2, node.expressions.first)
skip_space_write_line
skip_space_or_newline
write_indent
write_token :")"
return false
end
skip_space_or_newline
accept node.expressions.first
skip_space
if @token.type == :NEWLINE
skip_space_or_newline
write_line
write_indent(@indent + 2)
end
skip_space_or_newline
write ")"
next_token
return false
end
old_indent = @indent
base_indent = old_indent
next_needs_indent = false
has_paren = false
has_begin = false
if node.keyword == :"(" && @token.type == :"("
write "("
next_needs_indent = false
next_token
has_paren = true
elsif node.keyword == :begin && @token.keyword?(:begin)
write "begin"
@indent += 2
write_line
next_token_skip_space_or_newline
if @token.type == :";"
next_token_skip_space_or_newline
end
has_begin = true
base_indent = @indent
next_needs_indent = true
end
last_aligned_assign = nil
max_length = nil
skip_space
node.expressions.each_with_index do |exp, i|
is_assign = assign?(exp)
if is_assign && !last_aligned_assign
last_aligned_assign, max_length = find_assign_chunk(node.expressions, exp, i + 1)
else
max_length = nil unless is_assign
end
if last?(i, node.expressions)
needs_two_lines = false
else
next_exp = node.expressions[i + 1]
needs_two_lines = needs_two_lines?(exp, next_exp)
end
@assign_length = max_length
if next_needs_indent
write_indent(@indent, exp)
else
accept exp
end
@dot_column = nil
found_comment = skip_space
if @token.type == :";"
if needs_two_lines
skip_semicolon_or_space_or_newline
else
found_comment = skip_semicolon_or_space
if @token.type == :NEWLINE
write_line
next_token_skip_space
next_needs_indent = true
else
write "; " unless last?(i, node.expressions) || found_comment
skip_space_or_newline
next_needs_indent = found_comment
end
end
else
next_needs_indent = true
end
unless @exp_needs_indent
next_needs_indent = false
@exp_needs_indent = true
end
if last?(i, node.expressions)
skip_space_or_newline last: true
else
if needs_two_lines
unless found_comment
skip_space_write_line
found_comment = skip_space_or_newline last: true, at_least_one: true
write_line unless found_comment
end
else
consume_newlines
end
end
last_aligned_assign = nil if last_aligned_assign.same?(exp)
end
@indent = old_indent
if has_paren
write_token :")"
end
if has_begin
check_end
next_token
write_line
write_indent
write "end"
end
false
end
def assign?(exp)
case exp
when Assign
exp.target.is_a?(Path)
when VisibilityModifier
assign? exp.exp
when Arg
true
else
false
end
end
def assign_length(exp)
case exp
when Assign
assign_length exp.target
when Arg
exp.name.size
when VisibilityModifier
assign_length exp.exp
when Path
exp.names.first.size
else
0
end
end
def find_assign_chunk(expressions, last, i)
max_length = assign_length(last)
while i < expressions.size
exp = expressions[i]
exp_location = exp.location
break unless exp_location
last_location = last.location
break unless last_location
break unless last_location.line_number + 1 == exp_location.line_number
last = exp
exp_length = assign_length(exp)
max_length = exp_length if exp_length > max_length
i += 1
end
{last, max_length}
end
def needs_two_lines?(node, next_node)
return false if node.is_a?(Attribute) || node.is_a?(MacroIf)
return false if abstract_def?(node) && abstract_def?(next_node)
needs_two_lines?(node) || needs_two_lines?(next_node)
end
def abstract_def?(node)
case node
when Def
node.abstract?
when VisibilityModifier
abstract_def? node.exp
else
false
end
end
def needs_two_lines?(node)
case node
when Def, ClassDef, ModuleDef, LibDef, CStructOrUnionDef, Macro
true
when VisibilityModifier
needs_two_lines? node.exp
else
false
end
end
def visit(node : Nop)
false
end
def visit(node : NilLiteral)
write_keyword :nil
false
end
def visit(node : BoolLiteral)
check_keyword :false, :true
write node.value
next_token
false
end
def visit(node : CharLiteral)
check :CHAR
write @token.raw
next_token
false
end
def visit(node : SymbolLiteral)
check :SYMBOL
write @token.raw
next_token
false
end
def visit(node : NumberLiteral)
if @token.type == :__LINE__
write @token.type
next_token
return false
end
check :NUMBER
write @token.raw
next_token
false
end
def visit(node : StringLiteral)
@last_is_heredoc = false
column = @column
if @token.type == :__FILE__ || @token.type == :__DIR__
write @token.type
next_token
return false
end
check :DELIMITER_START
is_regex = @token.delimiter_state.kind == :regex
is_heredoc = @token.delimiter_state.kind == :heredoc
@last_is_heredoc = is_heredoc
indent_difference = @token.column_number - (@column + 1)
heredoc_line = @line
heredoc_end = @line
write @token.raw
next_string_token
while true
case @token.type
when :STRING
write @token.raw
next_string_token
when :INTERPOLATION_START
# This is the case of #{__DIR__}
write "\#{"
next_token_skip_space_or_newline
write @token.type
next_token_skip_space_or_newline
check :"}"
write "}"
next_string_token
when :DELIMITER_END
heredoc_end = @line
break
end
end
write @token.raw
format_regex_modifiers if is_regex
if is_heredoc
if indent_difference > 0
@heredoc_fixes << HeredocFix.new(heredoc_line, @line, indent_difference)
end
(heredoc_line...heredoc_end).each do |line|
@no_rstrip_lines.add line
end
end
if space_slash_newline?
old_indent = @indent
@indent = column if @string_continuation == 0
@string_continuation += 1
write " \\"
write_line
write_indent
next_token_skip_space_or_newline
visit(node)
@indent = old_indent
@string_continuation -= 1
else
next_token
end
false
end
def visit(node : StringInterpolation)
check :DELIMITER_START
column = @column
old_indent = @indent
old_string_continuation = @string_continuation
is_regex = @token.delimiter_state.kind == :regex
indent_difference = @token.column_number - (@column + 1)
write @token.raw
next_string_token
delimiter_state = @token.delimiter_state
is_heredoc = @token.delimiter_state.kind == :heredoc
@last_is_heredoc = is_heredoc
heredoc_line = @line
heredoc_end = @line
node.expressions.each do |exp|
if @token.type == :DELIMITER_END
# If the delimiter ends with "\n" it's something like "\n HEREDOC",
# so we are done
break if @token.raw.starts_with?("\n")
# This is for " ... " \
# " ... "
@indent = column if @string_continuation == 0
@string_continuation += 1
write @token.raw
write " \\"
write_line
next_token_skip_space_or_newline
check :DELIMITER_START
write_indent
write @token.raw
next_string_token
end
if exp.is_a?(StringLiteral)
# It might be #{__DIR__}, for example
if @token.type == :INTERPOLATION_START
next_token_skip_space_or_newline
write "\#{"
write @token.type
next_token_skip_space_or_newline
check :"}"
write "}"
else
write @token.raw
end
next_string_token
else
skip_strings
check :INTERPOLATION_START
write "\#{"
delimiter_state = @token.delimiter_state
next_token_skip_space_or_newline
indent(@column, exp)
skip_space_or_newline
check :"}"
write "}"
@token.delimiter_state = delimiter_state
next_string_token
end
end
skip_strings
heredoc_end = @line
check :DELIMITER_END
write @token.raw
if is_heredoc
if indent_difference > 0
@heredoc_fixes << HeredocFix.new(heredoc_line, @line, indent_difference)
end
(heredoc_line...heredoc_end).each do |line|
@no_rstrip_lines.add line
end
end
format_regex_modifiers if is_regex
next_token
@string_continuation = old_string_continuation
@indent = old_indent
false
end
private def skip_strings
# Heredocs might indice some spaces that are removed
# because of indentation
while @token.type == :STRING
write @token.raw
next_string_token
end
end
def visit(node : RegexLiteral)
accept node.value
false
end
def format_regex_modifiers
while true
char = @lexer.current_char
case char
when 'i', 'm', 'x'
write char
@lexer.next_char
else
break
end
end
end
def space_slash_newline?
pos, line, col = @lexer.current_pos, @lexer.line_number, @lexer.column_number
while true
char = @lexer.current_char
case char
when ' ', '\t'
@lexer.next_char
when '\\'
@lexer.current_pos = pos
return true
else
break
end
end
@lexer.current_pos = pos
@lexer.line_number = line
@lexer.column_number = col
false
end
def space_newline?
pos, line, col = @lexer.current_pos, @lexer.line_number, @lexer.column_number
while true
char = @lexer.current_char
case char
when ' ', '\t'
@lexer.next_char
when '\n'
@lexer.current_pos = pos
return true
else
break
end
end
@lexer.current_pos = pos
@lexer.line_number = line
@lexer.column_number = col
false
end
def visit(node : ArrayLiteral)
case @token.type
when :"["
format_literal_elements node.elements, :"[", :"]"
when :"[]"
write "[]"
next_token
when :STRING_ARRAY_START, :SYMBOL_ARRAY_START
first = true
write @token.raw
count = 0
while true
has_space_newline = space_newline?
if has_space_newline
write_line
if count == node.elements.size
write_indent
else
write_indent(@indent + 2)
end
end
next_string_array_token
case @token.type
when :STRING
write " " unless first || has_space_newline
write @token.raw
first = false
when :STRING_ARRAY_END
write @token.raw
next_token
break
end
count += 1
end
return false
else
name = node.name.not_nil!
accept name
skip_space
format_literal_elements node.elements, :"{", :"}"
end
if node_of = node.of
write_keyword " ", :of, " "
accept node_of
end
false
end
def visit(node : TupleLiteral)
format_literal_elements node.elements, :"{", :"}"
false
end
def format_literal_elements(elements, prefix, suffix)
slash_is_regex!
write_token prefix
has_newlines = false
wrote_newline = false
write_space_at_end = false
next_needs_indent = false
found_comment = false
found_first_newline = false
skip_space
if @token.type == :NEWLINE
# add one level of indentation for contents if a newline is present
offset = @indent + 2
if elements.empty?
skip_space_or_newline
write_token suffix
return false
end
indent(offset) { consume_newlines }
skip_space_or_newline
wrote_newline = true
next_needs_indent = true
has_newlines = true
found_first_newline = true
else
# indent contents at the same column as starting token if no newline
offset = @column
end
elements.each_with_index do |element, i|
# This is to prevent writing `{{`
current_element = element
if current_element.is_a?(HashLiteral::Entry)
current_element = current_element.key
end
if prefix == :"{" && i == 0 && !wrote_newline && (
current_element.is_a?(TupleLiteral) ||
current_element.is_a?(NamedTupleLiteral) ||
current_element.is_a?(HashLiteral) ||
current_element.is_a?(MacroExpression) ||
current_element.is_a?(MacroIf) ||
current_element.is_a?(MacroFor)
)
write " "
write_space_at_end = true
end
if next_needs_indent
write_indent(offset, element)
else
accept element
end
last = last?(i, elements)
found_comment = skip_space(offset, write_comma: last && has_newlines)
if @token.type == :","
write "," unless last || found_comment
slash_is_regex!
next_token
found_comment = skip_space(offset, write_comma: last && has_newlines)
if @token.type == :NEWLINE
if last && !found_comment
write ","
found_comment = true
end
indent(offset) { consume_newlines }
skip_space_or_newline
next_needs_indent = true
has_newlines = true
else
if !last && !found_comment
write " "
next_needs_indent = false
elsif found_comment
next_needs_indent = true
end
end
end
end
finish_list suffix, has_newlines, found_comment, found_first_newline, write_space_at_end
end
def visit(node : HashLiteral)
if name = node.name
accept name
skip_space
end
old_hash = @current_hash
@current_hash = node
format_literal_elements node.entries, :"{", :"}"
@current_hash = old_hash
if node_of = node.of
write_keyword " ", :of, " "
format_hash_entry nil, node_of
end
if @hash_in_same_line.includes? node.object_id
@hash_infos.reject! { |info| info.id == node.object_id }
end
false
end
def accept(node : HashLiteral::Entry)
format_hash_entry(@current_hash.not_nil!, node)
end
def format_hash_entry(hash, entry)
start_line = @line
start_column = @column
found_in_same_line = false
accept entry.key
skip_space_or_newline
middle_column = @column
if @token.type == :":" && entry.key.is_a?(StringLiteral)
write ": "
slash_is_regex!
next_token
middle_column = @column
found_in_same_line ||= check_hash_info hash, entry.key, start_line, start_column, middle_column
else
slash_is_regex!
write_token " ", :"=>", " "
found_in_same_line ||= check_hash_info hash, entry.key, start_line, start_column, middle_column
end
skip_space_or_newline
accept entry.value
if found_in_same_line
@hash_in_same_line << hash.object_id
end
end
def visit(node : NamedTupleLiteral)
old_hash = @current_hash
@current_hash = node
format_literal_elements node.entries, :"{", :"}"
@current_hash = old_hash
if @hash_in_same_line.includes? node.object_id
@hash_infos.reject! { |info| info.id == node.object_id }
end
false
end
def accept(node : NamedTupleLiteral::Entry)
format_named_tuple_entry(@current_hash.not_nil!, node)
end
def format_named_tuple_entry(hash, entry)
start_line = @line
start_column = @column
found_in_same_line = false
format_named_argument_name(entry.key)
slash_is_regex!
write_token :":", " "
middle_column = @column
found_in_same_line ||= check_hash_info hash, entry.key, start_line, start_column, middle_column
skip_space_or_newline
accept entry.value
if found_in_same_line
@hash_in_same_line << hash.object_id
end
end
def format_named_argument_name(name)
if @token.type == :DELIMITER_START
StringLiteral.new(name).accept self
else
write @token
next_token
end
end
def finish_list(suffix, has_newlines, found_comment, found_first_newline, write_space_at_end)
if @token.type == suffix && !found_first_newline
if @wrote_newline
write_indent
else
write " " if write_space_at_end
end
else
found_comment ||= skip_space_or_newline
check suffix
if has_newlines
unless found_comment
write ","
write_line
end
write_indent
elsif write_space_at_end
write " "
end
skip_space_or_newline
end
write_token suffix
end
def check_hash_info(hash, key, start_line, start_column, middle_column)
end_column = @column
found_in_same_line = false
if @line == start_line
last_info = @hash_infos.last?
if last_info && last_info.line == @line
found_in_same_line = true
elsif hash
number = key.is_a?(NumberLiteral)
@hash_infos << AlignInfo.new(hash.object_id, @line, start_column, middle_column, end_column, number)
end
end
found_in_same_line
end
def visit(node : RangeLiteral)
accept node.from
skip_space_or_newline
write_token(node.exclusive? ? :"..." : :"..")
skip_space_or_newline
accept node.to
false
end
def check_open_paren
if @token.type == :"("
write "("
next_token_skip_space
@paren_count += 1
true
else
false
end
end
def check_close_paren
if @token.type == :")" && @paren_count > 0
@paren_count -= 1
write_token :")"
end
end
def visit(node : Path)
# This is the case of $0, which generates `PROGRAM_NAME` by the parser
if @token.type == :GLOBAL_MATCH_DATA_INDEX
write "$"
write @token.value
next_token
return false
end
check_open_paren
# Sometimes the :: is not present because the parser generates ::Nil, for example
if node.global? && @token.type == :"::"
write "::"
next_token_skip_space_or_newline
end
node.names.each_with_index do |name, i|
skip_space_or_newline
check :CONST
write @token.value
next_token
skip_space unless last?(i, node.names)
if @token.type == :"::"
write "::"
next_token
end
end
check_close_paren
false
end
def visit(node : Generic)
name = node.name
first_name = name.global? && name.names.size == 1 && name.names.first
if name.global? && @token.type == :"::"
write "::"
next_token_skip_space_or_newline
end