forked from janestreet/ocamlformat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCmts.ml
754 lines (681 loc) · 25.9 KB
/
Cmts.ml
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
(**************************************************************************)
(* *)
(* OCamlFormat *)
(* *)
(* Copyright (c) Facebook, Inc. and its affiliates. *)
(* *)
(* This source code is licensed under the MIT license found in *)
(* the LICENSE file in the root directory of this source tree. *)
(* *)
(**************************************************************************)
(** Placing and formatting comments in a parsetree. *)
open Migrate_ast
type layout_cache_key =
| Arg of Asttypes.arg_label * Parsetree.expression
| Pattern of Parsetree.pattern
| Expression of Parsetree.expression
module Layout_cache = struct
module Key = struct
type t = layout_cache_key
let expression_to_string e = Format.asprintf "%a" Printast.expression e
let pattern_to_string e = Format.asprintf "%a" Printast.pattern e
let sexp_of_arg_label = function
| Asttypes.Nolabel -> Sexp.Atom "Nolabel"
| Labelled label -> List [Atom "Labelled"; sexp_of_string label]
| Optional label -> List [Atom "Optional"; sexp_of_string label]
let sexp_of_t = function
| Arg (label, expression) ->
Sexp.List
[ Atom "Arg"
; sexp_of_arg_label label
; sexp_of_string (expression_to_string expression) ]
| Pattern pattern ->
List [Atom "Pattern"; sexp_of_string (pattern_to_string pattern)]
| Expression expression ->
List
[ Atom "Expression"
; sexp_of_string (expression_to_string expression) ]
let compare = Poly.compare
let hash = Hashtbl.hash
end
let create () = Hashtbl.create (module Key)
type t = string Hashtbl.M(Key).t
let memo t ~key ~f = Hashtbl.find_or_add t key ~default:f
end
type t =
{ debug: bool
; mutable cmts_before: Cmt.t Multimap.M(Location).t
; mutable cmts_after: Cmt.t Multimap.M(Location).t
; mutable cmts_within: Cmt.t Multimap.M(Location).t
; source: Source.t
; mutable remaining: Set.M(Location).t
; layout_cache: Layout_cache.t }
let copy
{ debug
; cmts_before
; cmts_after
; cmts_within
; source
; remaining
; layout_cache } =
{ debug
; cmts_before
; cmts_after
; cmts_within
; source
; remaining
; layout_cache }
let restore src ~into =
into.cmts_before <- src.cmts_before ;
into.cmts_after <- src.cmts_after ;
into.cmts_within <- src.cmts_within ;
into.remaining <- src.remaining
let update_remaining t ~f = t.remaining <- f t.remaining
let update_cmts t pos ~f =
match pos with
| `After -> t.cmts_after <- f t.cmts_after
| `Before -> t.cmts_before <- f t.cmts_before
| `Within -> t.cmts_within <- f t.cmts_within
let find_at_position t loc pos =
let map =
match pos with
| `After -> t.cmts_after
| `Before -> t.cmts_before
| `Within -> t.cmts_within
in
Map.find map loc
let no_filter (_ : Parser.token) = true
(** Heuristic to determine if two locations should be considered "adjacent".
Holds if there is only whitespace between the locations, or if there is a
[|] character and the first location begins a line and the start column
of the first location is lower than that of the second location. *)
let is_adjacent ?(filter = no_filter) src (l1 : Location.t) (l2 : Location.t)
=
match Source.tokens_between src l1.loc_end l2.loc_start ~filter with
| [] -> true
| [(BAR, _)] ->
Source.begins_line src l1
&& Position.column l1.loc_start < Position.column l2.loc_start
| _ -> false
(** Whether the symbol preceding location [loc] is an infix symbol
(corresponding to [Ast.String_id.is_infix]) or a semicolon. If it is the
case, comments attached to the following item should be kept after the
infix symbol. *)
let infix_symbol_before src (loc : Location.t) =
match
Source.find_token_before src ~filter:(function _ -> true) loc.loc_start
with
| Some (Parser.SEMI, loc') ->
Source.begins_line ~ignore_spaces:true src loc'
| Some (x, _) -> Ast.Token.is_infix x
| None -> false
(** Sets of comments supporting splitting by locations. *)
module CmtSet : sig
type t
val of_list : Cmt.t list -> t
val to_list : t -> Cmt.t list
(** ordered by start location *)
val is_empty : t -> bool
val split : t -> Location.t -> t * t * t
(** [split s {loc_start; loc_end}] splits [s] into the subset of comments
that end before [loc_start], those that start after [loc_end], and
those within the loc. *)
val partition :
Source.t -> prev:Location.t -> next:Location.t -> t -> t * t
(** Heuristic to choose between placing a comment after the previous
location or before the next one. *)
end = struct
type t = Cmt.t list Map.M(Position).t
let empty = Map.empty (module Position)
let is_empty = Map.is_empty
let of_list cmts =
List.fold cmts ~init:empty ~f:(fun map cmt ->
let pos = cmt.Cmt.loc.loc_start in
Map.add_multi map ~key:pos ~data:cmt )
let to_list map = List.concat (Map.data map)
(** Assuming loc_start <= loc_end, the locs are split in 5 sets:
- a: before start
- b: at start
- c: after start, before end
- d: at end
- e: after end *)
let split t {Location.loc_start; loc_end; _} =
let add_opt kvo init =
Option.fold kvo ~init ~f:(fun m (key, data) -> Map.set m ~key ~data)
in
let ( ++ ) = add_opt in
let a_b_c, d, e = Map.split t loc_end in
let a, b, c = Map.split a_b_c loc_start in
(a, b ++ c, d ++ e)
let partition src ~prev ~next cmts =
let ignore_docstrings = function
| Parser.DOCSTRING _ -> false
| _ -> true
in
match to_list cmts with
| Cmt.{loc; _} :: _ as cmtl
when is_adjacent ~filter:ignore_docstrings src prev loc -> (
match
List.group cmtl ~break:(fun l1 l2 ->
not (is_adjacent src (Cmt.loc l1) (Cmt.loc l2)) )
with
| [cmtl] when is_adjacent src (List.last_exn cmtl).loc next ->
let open Location in
let first_loc = (List.hd_exn cmtl).loc in
let last_loc = (List.last_exn cmtl).loc in
let same_line_as_prev l =
prev.loc_end.pos_lnum = l.loc_start.pos_lnum
in
let decide loc =
match
( loc.loc_start.pos_lnum - prev.loc_end.pos_lnum
, next.loc_start.pos_lnum - loc.loc_end.pos_lnum )
with
| 0, 0 -> `Before_next
| 0, _ when infix_symbol_before src loc -> `Before_next
| 0, _ -> `After_prev
| 1, 1 ->
if
Location.compare_start_col (List.last_exn cmtl).loc next
<= 0
then `Before_next
else `After_prev
| 1, y when y > 1 && Source.empty_line_after src loc ->
`After_prev
| _, y
when y > 1
&& first_loc.loc_start.pos_lnum - prev.loc_end.pos_lnum
>= 1
&& Source.empty_line_after src last_loc
&& not (Source.empty_line_before src first_loc) ->
`After_prev
| _ -> `Before_next
in
let prev, next =
if not (same_line_as_prev next) then
let next, prev =
List.partition_tf cmtl ~f:(fun {Cmt.loc= l; _} ->
match decide l with
| `After_prev -> false
| `Before_next -> true )
in
(prev, next)
else ([], cmtl)
in
(of_list prev, of_list next)
| after :: befores -> (of_list after, of_list (List.concat befores))
| [] -> impossible "by parent match" )
| _ -> (empty, cmts)
end
let add_cmts t position loc ?deep_loc cmts =
if not (CmtSet.is_empty cmts) then
let cmtl = CmtSet.to_list cmts in
let key =
match deep_loc with
| Some deep_loc ->
let cmt = List.last_exn cmtl in
if
is_adjacent t.source deep_loc cmt.loc
&& not (Source.begins_line ~ignore_spaces:true t.source cmt.loc)
then deep_loc
else loc
| None -> loc
in
update_cmts t position ~f:(Map.add_exn ~key ~data:cmtl)
(** Traverse the location tree from locs, find the deepest location that
contains each comment, intersperse comments between that location's
children. *)
let rec place t loc_tree ?prev_loc ?deep_loc locs cmts =
match locs with
| curr_loc :: next_locs ->
let before, within, after = CmtSet.split cmts curr_loc in
let before_curr =
match prev_loc with
| None -> before
(* Location.none is a special case, it shouldn't be the location of a
previous element, so if a comment is at the beginning of the file,
it should be placed before the next element. *)
| Some prev_loc when Location.(compare prev_loc none) = 0 -> before
| Some prev_loc ->
let after_prev, before_curr =
CmtSet.partition t.source ~prev:prev_loc ~next:curr_loc before
in
add_cmts t `After prev_loc after_prev ?deep_loc ;
before_curr
in
add_cmts t `Before curr_loc before_curr ;
let deep_loc =
match Loc_tree.children loc_tree curr_loc with
| [] ->
add_cmts t `Within curr_loc within ;
Option.some_if (List.is_empty next_locs) curr_loc
| children -> place t loc_tree children within
in
place t loc_tree ~prev_loc:curr_loc next_locs after ?deep_loc
| [] ->
( match prev_loc with
| Some prev_loc -> add_cmts t `After prev_loc cmts ?deep_loc
| None ->
if t.debug then
List.iter (CmtSet.to_list cmts) ~f:(fun {Cmt.txt; _} ->
Format_.eprintf "lost: %s@\n%!" txt ) ) ;
deep_loc
(** Relocate comments, for Ast transformations such as sugaring. *)
let relocate (t : t) ~src ~before ~after =
if t.debug then
Format.eprintf "relocate %a to %a and %a@\n%!" Location.fmt src
Location.fmt before Location.fmt after ;
let merge_and_sort x y =
List.rev_append x y
|> List.sort ~compare:(Comparable.lift Location.compare_start ~f:Cmt.loc)
in
update_cmts t `Before
~f:(Multimap.update_multi ~src ~dst:before ~f:merge_and_sort) ;
update_cmts t `After
~f:(Multimap.update_multi ~src ~dst:after ~f:merge_and_sort) ;
update_cmts t `Within
~f:(Multimap.update_multi ~src ~dst:after ~f:merge_and_sort) ;
if t.debug then
update_remaining t ~f:(fun s ->
let s = Set.remove s src in
let s = Set.add s after in
Set.add s before )
let relocate_cmts_before (t : t) ~src ~sep ~dst =
let f map =
Multimap.partition_multi map ~src ~dst ~f:(fun Cmt.{loc; _} ->
Location.compare_end loc sep < 0 )
in
update_cmts t `Before ~f ; update_cmts t `Within ~f
let relocate_pattern_matching_cmts (t : t) src tok ~whole_loc ~matched_loc =
let kwd_loc =
Option.value_exn (Source.loc_of_first_token_at src whole_loc tok)
in
relocate_cmts_before t ~src:matched_loc ~sep:kwd_loc ~dst:whole_loc
let relocate_ext_cmts (t : t) src (pre, pld) ~whole_loc =
let open Extended_ast in
match pld with
| PStr
[ { pstr_desc=
Pstr_eval
( { pexp_desc= Pexp_constant {pconst_desc= Pconst_string _; _}
; pexp_loc= _
; pexp_loc_stack= _
; pexp_attributes= _ }
, [] )
; pstr_loc } ]
when Source.is_quoted_string src pstr_loc ->
()
| PStr
[ { pstr_desc=
Pstr_eval
( { pexp_desc= Pexp_sequence (e1, _)
; pexp_loc= _
; pexp_loc_stack= _
; pexp_attributes }
, [] )
; pstr_loc= _ } ]
when List.is_empty pexp_attributes
&& Source.extension_using_sugar ~name:pre ~payload:e1.pexp_loc ->
()
| PStr [{pstr_desc= Pstr_eval _; pstr_loc; _}] ->
let kwd_loc =
match Source.loc_of_first_token_at src whole_loc LBRACKETPERCENT with
| Some loc -> loc
| None -> (
match Source.loc_of_first_token_at src whole_loc PERCENT with
| Some loc -> loc
| None -> impossible "expect token starting extension" )
in
relocate_cmts_before t ~src:pstr_loc ~sep:kwd_loc ~dst:whole_loc
| _ -> ()
let relocate_wrongfully_attached_cmts t src exp =
let open Extended_ast in
match exp.pexp_desc with
| Pexp_match (e0, _) ->
relocate_pattern_matching_cmts t src Parser.MATCH
~whole_loc:exp.pexp_loc ~matched_loc:e0.pexp_loc
| Pexp_try (e0, _) ->
relocate_pattern_matching_cmts t src Parser.TRY ~whole_loc:exp.pexp_loc
~matched_loc:e0.pexp_loc
| Pexp_extension ext -> relocate_ext_cmts t src ext ~whole_loc:exp.pexp_loc
| _ -> ()
(** Initialize global state and place comments. *)
let init fragment ~debug source asts comments_n_docstrings =
let t =
{ debug
; cmts_before= Map.empty (module Location)
; cmts_after= Map.empty (module Location)
; cmts_within= Map.empty (module Location)
; source
; remaining= Set.empty (module Location)
; layout_cache= Layout_cache.create () }
in
let comments =
Normalize_extended_ast.dedup_cmts fragment asts comments_n_docstrings
in
if not (List.is_empty comments) then (
let loc_tree, locs = Loc_tree.of_ast fragment asts in
if debug then
List.iter locs ~f:(fun loc ->
if not (Location.compare loc Location.none = 0) then
update_remaining t ~f:(fun s -> Set.add s loc) ) ;
let locs = Loc_tree.roots loc_tree in
let cmts = CmtSet.of_list comments in
( match locs with
| [] -> add_cmts t `After Location.none cmts
| _ -> ignore @@ place t loc_tree locs cmts ) ;
if debug then (
let get_cmts pos loc =
let cmts = find_at_position t loc pos in
Option.map cmts ~f:(List.map ~f:Cmt.txt)
in
let cmts : Printast.cmts =
{ before= get_cmts `Before
; within= get_cmts `Within
; after= get_cmts `After }
in
Printast.cmts := Some cmts ;
Format.eprintf "AST:\n%a\n%!" (Extended_ast.Printast.ast fragment) asts
) ) ;
t
let preserve_nomemo f t =
let original = copy t in
let finally () = restore original ~into:t in
Exn.protect ~finally ~f:(fun () ->
let buf = Buffer.create 128 in
let fs = Format_.formatter_of_buffer buf in
Fmt.eval fs (f ()) ;
Format_.pp_print_flush fs () ;
Buffer.contents buf )
let preserve ~cache_key f t =
Layout_cache.memo t.layout_cache ~key:cache_key ~f:(fun () ->
preserve_nomemo f t )
let pop_if_debug t loc =
if t.debug then update_remaining t ~f:(fun s -> Set.remove s loc)
let find_cmts ?(filter = Fn.const true) t pos loc =
pop_if_debug t loc ;
Option.map (find_at_position t loc pos) ~f:(fun cmts ->
let picked, not_picked = List.partition_tf cmts ~f:filter in
update_cmts t pos ~f:(Map.set ~key:loc ~data:not_picked) ;
picked )
let break_comment_group source margin {Cmt.loc= a; _} {Cmt.loc= b; _} =
let vertical_align =
Location.line_difference a b = 1 && Location.compare_start_col a b = 0
in
let horizontal_align =
Location.line_difference a b = 0
&& List.is_empty
(Source.tokens_between source a.loc_end b.loc_start
~filter:(function _ -> true) )
in
not
( (Location.is_single_line a margin && Location.is_single_line b margin)
&& (vertical_align || horizontal_align) )
module Asterisk_prefixed = struct
let split Cmt.{txt; loc= {Location.loc_start; _}} =
let len = Position.column loc_start + 3 in
let pat =
String.Search_pattern.create
(String.init len ~f:(function
| 0 -> '\n'
| n when n < len - 1 -> ' '
| _ -> '*' ) )
in
let rec split_ pos =
match String.Search_pattern.index pat ~pos ~in_:txt with
| Some 0 -> "" :: split_ len
| Some idx -> String.sub txt ~pos ~len:(idx - pos) :: split_ (idx + len)
| _ ->
let drop = function ' ' | '\t' -> true | _ -> false in
let line = String.rstrip ~drop (String.drop_prefix txt pos) in
if String.is_empty line then [" "]
else if Char.equal line.[String.length line - 1] '\n' then
[String.drop_suffix line 1; ""]
else if Char.is_whitespace txt.[String.length txt - 1] then
[line ^ " "]
else [line]
in
split_ 0
let fmt lines =
let open Fmt in
vbox 1
( fmt "(*"
$ list_fl lines (fun ~first:_ ~last line ->
match line with
| "" when last -> fmt ")"
| _ -> str line $ fmt_or last "*)" "@,*" ) )
end
module Unwrapped = struct
let unindent_lines ~opn_pos first_line tl_lines =
let indent_of_line s =
(* index of first non-whitespace is indentation, None means white
line *)
String.lfindi s ~f:(fun _ c -> not (Char.is_whitespace c))
in
(* The indentation of the first line must account for the location of the
comment opening *)
let fl_spaces = Option.value ~default:0 (indent_of_line first_line) in
let fl_offset = opn_pos.Lexing.pos_cnum - opn_pos.pos_bol + 2 in
let fl_indent = fl_spaces + fl_offset in
let min_indent =
List.fold_left ~init:fl_indent
~f:(fun acc s ->
Option.value_map ~default:acc ~f:(min acc) (indent_of_line s) )
tl_lines
in
(* Completely trim the first line *)
String.drop_prefix first_line fl_spaces
:: List.map ~f:(fun s -> String.drop_prefix s min_indent) tl_lines
let fmt_multiline_cmt ?epi ~opn_pos ~starts_with_sp first_line tl_lines =
let open Fmt in
let is_white_line s = String.for_all s ~f:Char.is_whitespace in
let unindented = unindent_lines ~opn_pos first_line tl_lines in
let fmt_line ~first ~last:_ s =
let sep, sp =
if is_white_line s then (str "\n", noop)
else (fmt "@;<1000 0>", fmt_if starts_with_sp " ")
in
fmt_if_k (not first) sep $ sp $ str (String.rstrip s)
in
vbox 0 ~name:"multiline" (list_fl unindented fmt_line $ fmt_opt epi)
let fmt Cmt.{txt= s; loc} =
let open Fmt in
let is_sp = function ' ' | '\t' -> true | _ -> false in
match String.split_lines (String.rstrip s) with
| first_line :: (_ :: _ as tl) when not (String.is_empty first_line) ->
let epi =
(* Preserve position of closing but strip empty lines at the end *)
match String.rfindi s ~f:(fun _ c -> not (is_sp c)) with
| Some i when Char.( = ) s.[i] '\n' ->
break 1000 (-2) (* Break before closing *)
| Some i when i < String.length s - 1 ->
str " " (* Preserve a space at the end *)
| _ -> noop
in
(* Preserve the first level of indentation *)
let starts_with_sp = is_sp first_line.[0] in
wrap "(*" "*)"
@@ fmt_multiline_cmt ~opn_pos:loc.loc_start ~epi ~starts_with_sp
first_line tl
| _ -> wrap "(*" "*)" @@ str s
end
module Verbatim = struct
let fmt s (pos : Cmt.pos) =
let open Fmt in
fmt_if_k
(Poly.(pos = After) && String.contains s '\n')
(break_unless_newline 1000 0)
$ wrap "(*" "*)" @@ str s
end
let fmt_cmt (cmt : Cmt.t) ~wrap:wrap_comments ~ocp_indent_compat ~fmt_code
pos =
let mode =
match cmt.txt with
| "" -> impossible "not produced by parser"
(* "(**)" is not parsed as a docstring but as a regular comment
containing '*' and would be rewritten as "(***)" *)
| "*" when Location.width cmt.loc = 4 -> `Verbatim ""
| "*" -> `Verbatim "*"
| "$" -> `Verbatim "$"
(* Qtest pragmas *)
| str when Char.(str.[0] = '$' && not (is_whitespace str.[1])) ->
`Verbatim str
| str when Char.equal str.[0] '$' -> (
let dollar_suf = Char.equal str.[String.length str - 1] '$' in
let cls : Fmt.s = if dollar_suf then "$*)" else "*)" in
let len = String.length str - if dollar_suf then 2 else 1 in
let source = String.sub ~pos:1 ~len str in
match fmt_code source with
| Ok formatted -> `Code (formatted, cls)
| Error (`Msg _) -> `Unwrapped cmt )
| str when Char.equal str.[0] '=' -> `Verbatim cmt.txt
| _ -> (
match Asterisk_prefixed.split cmt with
| [] | [""] -> impossible "not produced by split_asterisk_prefixed"
| [""; ""] -> `Verbatim " "
| [text] when wrap_comments -> `Wrapped (text, "*)")
| [text; ""] when wrap_comments -> `Wrapped (text, " *)")
| [_] | [_; ""] -> `Unwrapped cmt
| lines -> `Asterisk_prefixed lines )
in
let open Fmt in
match mode with
| `Verbatim x -> Verbatim.fmt x pos
| `Code (x, cls) -> hvbox 2 @@ wrap "(*$@;" cls (x $ fmt "@;<1 -2>")
| `Wrapped (x, epi) -> str "(*" $ fill_text x ~epi
| `Unwrapped x when ocp_indent_compat -> Verbatim.fmt x.txt pos
| `Unwrapped x -> Unwrapped.fmt x
| `Asterisk_prefixed x -> Asterisk_prefixed.fmt x
let fmt_cmts_aux t (conf : Conf.t) cmts ~fmt_code pos =
let open Fmt in
let groups =
List.group cmts
~break:(break_comment_group t.source conf.fmt_opts.margin.v)
in
vbox 0 ~name:"cmts"
(list_pn groups (fun ~prev:_ group ~next ->
( match group with
| [] -> impossible "previous match"
| [cmt] ->
fmt_cmt cmt ~wrap:conf.fmt_opts.wrap_comments.v
~ocp_indent_compat:conf.fmt_opts.ocp_indent_compat.v
~fmt_code:(fmt_code conf) pos
| group ->
list group "@;<1000 0>" (fun cmt ->
wrap "(*" "*)" (str (Cmt.txt cmt)) ) )
$
match next with
| Some ({loc= next; _} :: _) ->
let Cmt.{loc= last; _} = List.last_exn group in
fmt_if (Location.line_difference last next > 1) "\n" $ fmt "@ "
| _ -> noop ) )
(** Format comments for loc. *)
let fmt_cmts t conf ~fmt_code ?pro ?epi ?(eol = Fmt.fmt "@\n") ?(adj = eol)
found loc pos =
let open Fmt in
match found with
| None | Some [] -> noop
| Some cmts ->
let epi =
let ({loc= last_loc; _} : Cmt.t) = List.last_exn cmts in
let eol_cmt = Source.ends_line t.source last_loc in
let adj_cmt = eol_cmt && Location.line_difference last_loc loc = 1 in
fmt_or_k eol_cmt (fmt_or_k adj_cmt adj eol) (fmt_opt epi)
in
fmt_opt pro $ fmt_cmts_aux t conf cmts ~fmt_code pos $ epi
let fmt_before t conf ~fmt_code ?pro ?(epi = Fmt.break 1 0) ?eol ?adj loc =
fmt_cmts t conf (find_cmts t `Before loc) ~fmt_code ?pro ~epi ?eol ?adj loc
Before
let fmt_after t conf ~fmt_code ?(pro = Fmt.break 1 0) ?epi ?filter loc =
let open Fmt in
let within =
let cmts = find_cmts ?filter t `Within loc in
fmt_cmts t conf cmts ~fmt_code ~pro ?epi loc Within
in
let after =
let cmts = find_cmts ?filter t `After loc in
fmt_cmts t conf cmts ~fmt_code ~pro ?epi ~eol:noop loc After
in
within $ after
let fmt_within t conf ~fmt_code ?(pro = Fmt.break 1 0) ?(epi = Fmt.break 1 0)
loc =
fmt_cmts t conf (find_cmts t `Within loc) ~fmt_code ~pro ~epi ~eol:Fmt.noop
loc Within
module Toplevel = struct
let fmt_cmts t conf ~fmt_code found (pos : Cmt.pos) =
let open Fmt in
match found with
| None | Some [] -> noop
| Some (({loc= first_loc; _} : Cmt.t) :: _ as cmts) ->
let pro =
match pos with
| Before -> noop
| Within | After ->
if Source.begins_line t.source first_loc then
fmt_or
(Source.empty_line_before t.source first_loc)
"\n@;<1000 0>" "@\n"
else break 1 0
in
let epi =
let ({loc= last_loc; _} : Cmt.t) = List.last_exn cmts in
match pos with
| Before | Within ->
if Source.ends_line t.source last_loc then
fmt_or
(Source.empty_line_after t.source last_loc)
"\n@;<1000 0>" "@\n"
else break 1 0
| After -> noop
in
pro $ fmt_cmts_aux t conf cmts ~fmt_code pos $ epi
let fmt_before t conf ~fmt_code loc =
fmt_cmts t conf (find_cmts t `Before loc) ~fmt_code Before
let fmt_after t conf ~fmt_code loc =
let open Fmt in
let within =
fmt_cmts t conf (find_cmts t `Within loc) ~fmt_code Within
in
let after = fmt_cmts t conf (find_cmts t `After loc) ~fmt_code After in
within $ after
end
let clear_remaining_inside t loc =
if t.debug then
update_remaining t ~f:(Set.filter ~f:(Fn.non (Location.contains loc)))
let drop_inside t loc =
let clear pos =
update_cmts t pos
~f:
(Multimap.filter ~f:(fun {Cmt.loc= cmt_loc; _} ->
not (Location.contains loc cmt_loc) ) )
in
clear `Before ;
clear `Within ;
clear `After ;
clear_remaining_inside t loc
let drop_before t loc =
update_cmts t `Before ~f:(fun m -> Map.remove m loc) ;
t
let has_before t loc = pop_if_debug t loc ; Map.mem t.cmts_before loc
let has_within t loc = pop_if_debug t loc ; Map.mem t.cmts_within loc
let has_after t loc =
pop_if_debug t loc ;
Map.mem t.cmts_within loc || Map.mem t.cmts_after loc
(** returns comments that have not been formatted *)
let remaining_comments t =
List.concat_map ~f:Multimap.to_list
[t.cmts_before; t.cmts_within; t.cmts_after]
let remaining_before t loc = Map.find_multi t.cmts_before loc
let remaining_locs t = Set.to_list t.remaining
let is_docstring (conf : Conf.t) (Cmt.{txt; loc} as cmt) =
match txt with
| "" | "*" -> Either.Second cmt
| _ when Char.equal txt.[0] '*' ->
(* Doc comments here (comming directly from the lexer) include their
leading star [*]. It is not part of the docstring and should be
dropped. *)
let txt = String.drop_prefix txt 1 in
let cmt = Cmt.create txt loc in
if conf.fmt_opts.parse_docstrings.v then Either.First cmt
else Either.Second cmt
| _ -> Either.Second cmt