Source file snippet_renderer.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
open! Import
open Diagnostic
open Snippet
open Config
module Multi_id = Multi_line_label.Id
let pp_label_styled ~(config : Config.t) ~severity ~priority pp =
Fmt.styled_multi (Style_sheet.label config.styles priority severity) pp
;;
let pp_label_styled_string ~config ~severity ~priority =
pp_label_styled ~config ~severity ~priority Fmt.string
;;
module Chars = struct
let pp_source_border_left ~(config : Config.t) ppf () =
Fmt.(
styled_multi config.styles.source_border string ppf config.chars.source_border_left)
;;
let pp_source_border_left_break ~(config : Config.t) ppf () =
Fmt.(
styled_multi
config.styles.source_border
string
ppf
config.chars.source_border_left_break)
;;
let pp_caret ~(config : Config.t) ~severity ~priority ppf () =
let caret =
match priority with
| Priority.Primary -> config.chars.single_primary_caret
| Secondary -> config.chars.single_secondary_caret
in
pp_label_styled_string ~config ~severity ~priority ppf caret
;;
let pp_pointer_left ~(config : Config.t) ~severity ~priority ppf () =
pp_label_styled_string ~config ~severity ~priority ppf config.chars.pointer_left
;;
let pp_multi_top ~(config : Config.t) ~severity ~priority ppf () =
pp_label_styled_string ~config ~severity ~priority ppf config.chars.multi_top
;;
let pp_multi_bottom ~(config : Config.t) ~severity ~priority ppf () =
pp_label_styled_string ~config ~severity ~priority ppf config.chars.multi_bottom
;;
let pp_multi_caret_start ~(config : Config.t) ~severity ~priority ppf () =
let caret_start =
match priority with
| Priority.Primary -> config.chars.multi_primary_caret_start
| Secondary -> config.chars.multi_secondary_caret_start
in
pp_label_styled_string ~config ~severity ~priority ppf caret_start
;;
let pp_multi_caret_end ~(config : Config.t) ~severity ~priority ppf () =
let caret_end =
match priority with
| Priority.Primary -> config.chars.multi_primary_caret_end
| Secondary -> config.chars.multi_secondary_caret_end
in
pp_label_styled_string ~config ~severity ~priority ppf caret_end
;;
let pp_snippet_start ~(config : Config.t) ppf () =
Fmt.styled_multi config.styles.source_border Fmt.string ppf config.chars.snippet_start
;;
let pp_note_bullet ~(config : Config.t) ppf () =
Fmt.styled_multi config.styles.note_bullet Fmt.string ppf config.chars.note_bullet
;;
end
let pp_severity ~(config : Config.t) ppf severity =
Fmt.with_style (Style_sheet.header config.styles severity) ppf
@@ fun ppf () -> Severity.pp ppf severity
;;
let ~(config : Config.t) =
Fmt.styled_multi config.styles.header_message Message.pp
;;
let pp_message ~(config : Config.t) ~severity ~priority ppf message =
Fmt.styled_multi
(Style_sheet.label config.styles priority severity)
Message.pp
ppf
message
;;
type multi_kind =
[ `Top of [ `Unique | `Non_unique ]
| `Vertical
| `Bottom
]
module Multi_context = struct
type t =
{ gutters : (Priority.t * multi_kind) Option_array.t
; bindings : int Multi_id.Table.t
}
let create ~len =
{ gutters = Option_array.create ~len; bindings = Multi_id.Table.create () }
;;
let length t = Option_array.length t.gutters
let def t ~multi_id ~top_kind ~priority prologue =
assert (not (Hashtbl.mem t.bindings multi_id));
let gutter, _ =
t.gutters
|> Option_array.findi ~f:(fun _ gutter -> Option.is_none gutter)
|> Option.value_exn ~here:[%here]
in
Hashtbl.set t.bindings ~key:multi_id ~data:gutter;
Option_array.set_some t.gutters gutter (priority, `Top top_kind);
prologue ();
Option_array.set_some t.gutters gutter (priority, `Vertical)
;;
let free t ~multi_id epilogue =
let gutter = Hashtbl.find_exn t.bindings multi_id in
let priority, _ = Option_array.get_some_exn t.gutters gutter in
Option_array.set_some t.gutters gutter (priority, `Bottom);
epilogue ();
Option_array.set_none t.gutters gutter;
Hashtbl.remove t.bindings multi_id
;;
end
let pp_multi_vertline ~(config : Config.t) ~severity ~priority ppf kind =
let gutter =
match kind with
| `Top (`Unique | `Non_unique) -> config.chars.multi_top_left
| `Vertical -> config.chars.multi_left
| `Bottom -> config.chars.multi_bottom_left
in
pp_label_styled_string ~config ~severity ~priority ppf gutter
;;
let pp_multi_underline ~(config : Config.t) ~severity ~priority ppf kind =
match kind with
| `Top `Non_unique -> Chars.pp_multi_top ~config ~severity ~priority ppf ()
| `Top `Unique ->
Fmt.sp ppf ()
| `Bottom -> Chars.pp_multi_bottom ~config ~severity ~priority ppf ()
| `Vertical -> Fmt.sp ppf ()
;;
let pp_multi_lines ~(config : Config.t) ~severity ppf (mctxt : Multi_context.t) =
let set_sep, pr_sep =
let sep = ref Fmt.sp in
(fun sep' -> sep := sep'), fun () -> !sep ppf ()
in
for i = 0 to Multi_context.length mctxt - 1 do
match Option_array.get mctxt.gutters i with
| None ->
pr_sep ();
pr_sep ()
| Some (priority, kind) ->
set_sep (fun ppf () -> pp_multi_underline ~config ~severity ~priority ppf kind);
pp_multi_vertline ~config ~severity ~priority ppf kind;
pr_sep ()
done;
pr_sep ()
;;
type context =
{ line_num_width : int
; multi_context : Multi_context.t
}
let pp_line_number ~(config : Config.t) ~ctxt ppf (lnum : Line_number.t) =
Fmt.with_style config.styles.line_number ppf
@@ fun ppf () -> Fmt.pf ppf "%*d" ctxt.line_num_width (lnum :> int)
;;
let pp_source_line ~config ~severity ~ctxt ~lnum ppf (line : Line.t) =
let pp_segment ppf (segment : Line.segment) =
let content =
String.rstrip segment.content ~drop:(function
| '\n' | '\r' -> true
| _ -> false)
in
match segment.stag with
| Some { priority = Primary; _ } ->
pp_label_styled_string ~config ~severity ~priority:Primary ppf content
| _ ->
Fmt.string ppf content
in
Fmt.(
pf
ppf
"@[<h>%a %a %a%a@]"
(pp_line_number ~config ~ctxt)
lnum
(Chars.pp_source_border_left ~config)
()
(pp_multi_lines ~config ~severity)
ctxt.multi_context
(list ~sep:nop pp_segment)
line.segments)
;;
let pp_line_break ~config ~severity ~ctxt ppf () =
Fmt.pf
ppf
"@[<h>%*s %a %a@]"
ctxt.line_num_width
""
(Chars.pp_source_border_left_break ~config)
()
(pp_multi_lines ~config ~severity)
ctxt.multi_context
;;
let pbox ~prefix pp ppf x =
let s = Fmt.str_like ppf "%a" pp x in
let lines = String.split_lines s in
let nlines = List.length lines in
List.iteri lines ~f:(fun i line ->
Fmt.pf ppf "@[<h>%s%s@]" prefix line;
if i <> nlines - 1 then Fmt.newline ppf ())
;;
let pwibox ~prefix pp ppf x =
let s = Fmt.str_like ppf "%a" pp x in
let lines = String.split_lines s in
let nlines = List.length lines in
let nprefix = String.length prefix in
List.iteri lines ~f:(fun i line ->
if i = 0
then Fmt.pf ppf "@[<h>%s%s@]" prefix line
else Fmt.pf ppf "@[<h>%*s%s@]" nprefix "" line;
if i <> nlines - 1 then Fmt.newline ppf ())
;;
let lbox ~config ~severity ~ctxt pp ppf x =
let prefix =
Fmt.str_like
ppf
"%*s %a %a"
ctxt.line_num_width
""
(Chars.pp_source_border_left ~config)
()
(pp_multi_lines ~config ~severity)
ctxt.multi_context
in
pbox ~prefix pp ppf x
;;
module Multi_line_label = struct
let pp_underlines ~config ~severity ~priority ~width =
Fmt.repeat ~width (pp_multi_underline ~config ~severity ~priority)
;;
let pp_top ~config ~severity ppf (width, priority) =
pp_underlines ~config ~severity ~priority ~width ppf (`Top `Non_unique);
Chars.pp_multi_caret_start ~config ~severity ~priority ppf ()
;;
let pp_bottom ~config ~severity ppf (width, priority, label) =
let prefix =
Fmt.str_like
ppf
"%a%a "
(pp_underlines ~config ~severity ~priority ~width)
`Bottom
(Chars.pp_multi_caret_end ~config ~severity ~priority)
()
in
pwibox ~prefix (pp_message ~config ~severity ~priority) ppf label
;;
let pp_content_top ~ctxt ~(top : Multi_line_label.t option) pp ppf x =
match top with
| Some mll ->
(match mll with
| Top { id = multi_id; priority; _ } ->
Multi_context.def ctxt.multi_context ~multi_id ~top_kind:`Unique ~priority
@@ fun () -> pp ppf x
| _ -> assert false)
| None -> pp ppf x
;;
let pp ~config ~severity ~ctxt ppf (multi_line_label : Multi_line_label.t) =
match multi_line_label with
| Bottom { id; stop; priority; label } ->
Multi_context.free ctxt.multi_context ~multi_id:id
@@ fun () ->
pp_multi_lines ~config ~severity ppf ctxt.multi_context;
pp_bottom
~config
~severity
ppf
((stop :> int) - 2, priority, label)
| Top { id; start; priority } ->
Multi_context.def ctxt.multi_context ~multi_id:id ~top_kind:`Non_unique ~priority
@@ fun () ->
pp_multi_lines ~config ~severity ppf ctxt.multi_context;
pp_top ~config ~severity ppf ((start :> int) - 1, priority)
;;
end
module Inline_labels = struct
(** An inline segment with dangling pointers, with optional messages. *)
type hanging_segment =
{ offset : Column_number.t (** The offset into the line *)
; length : int (** The length of the segment > 0 *)
; priority : Priority.t
; messages : Message.t list
}
type trailing_segment =
{ offset : Column_number.t
; length : int
; priority : Priority.t
; message : Message.t
}
(** A rendering IR for inline labels *)
type t =
{ trailing_segment : trailing_segment option (** An optional trailing label *)
; hanging_segments : hanging_segment list
(** A lexically sorted list of hanging segments *)
}
let is_empty { hanging_segments; trailing_segment } =
List.is_empty hanging_segments && Option.is_none trailing_segment
;;
let pp_trailing_label ~config ~severity =
Fmt.(
option ~none:nop
@@ fun ppf ({ message; priority; _ } : trailing_segment) ->
Fmt.pf ppf " %a" (pp_message ~config ~severity ~priority) message)
;;
let pp_carets ~config ~severity ppf { hanging_segments; trailing_segment } =
let cursor = ref Column_number.initial in
let pr_segment (offset, length, priority) =
assert (Column_number.(!cursor <= offset));
Fmt.sps Column_number.(diff offset !cursor) ppf ();
Fmt.(repeat ~width:length @@ Chars.pp_caret ~config ~severity ~priority) ppf ();
cursor := Column_number.(add offset length)
in
List.iter hanging_segments ~f:(fun { offset; length; priority; _ } ->
pr_segment (offset, length, priority));
Option.iter trailing_segment ~f:(fun { offset; length; priority; _ } ->
pr_segment (offset, length, priority))
;;
let pp_hanging_segments ~config ~severity ppf segments =
let str_pointer_left priority =
Fmt.str_like ppf "%a" (Chars.pp_pointer_left ~config ~severity ~priority) ()
in
let pp_messages ~priority =
let open Fmt in
vbox @@ list ~sep:newline @@ hbox @@ pp_message ~config ~severity ~priority
in
let rec loop cursor pointers = function
| [] ->
Fmt.pf ppf "%s" pointers
| { offset; length; priority = _; messages = [] } :: segments ->
assert (Column_number.(cursor <= offset));
let pointers =
String.append
pointers
(String.make Column_number.(diff (add offset length) cursor) ' ')
in
loop Column_number.(add offset length) pointers segments
| { offset; length = _; priority; messages = _ :: _ as messages } :: segments ->
assert (Column_number.(cursor <= offset));
let pointers =
String.append pointers (String.make Column_number.(diff offset cursor) ' ')
in
loop
Column_number.(add offset 1)
String.(pointers ^ str_pointer_left priority)
segments;
Fmt.newline ppf ();
pbox ~prefix:pointers (pp_messages ~priority) ppf messages
in
loop Column_number.initial "" segments
;;
let pp ~config ~severity ppf t =
pp_carets ~config ~severity ppf t;
pp_trailing_label ~config ~severity ppf t.trailing_segment;
if not (List.is_empty t.hanging_segments)
then Fmt.pf ppf "@.%a" (pp_hanging_segments ~config ~severity) t.hanging_segments
;;
let as_trailing_segment { priority; offset; length; messages } : trailing_segment option
=
match messages with
| [ message ] -> Some { priority; offset; length; message }
| _ -> None
;;
let of_segments (segments : Line.segment list) : t =
let rec loop (segments : Line.segment list) accu =
let rev_segments, offset, prev_segment = accu in
match segments with
| [] ->
(match Option.(prev_segment >>= as_trailing_segment) with
| Some trailing_segment ->
let hanging_segments = List.rev rev_segments in
{ hanging_segments; trailing_segment = Some trailing_segment }
| None ->
let hanging_segments = List.rev (Option.to_list prev_segment @ rev_segments) in
{ hanging_segments; trailing_segment = None })
| { stag = None; content = _; length } :: segments ->
loop segments (rev_segments, Column_number.(add offset length), prev_segment)
| { stag = Some { priority; inline_labels }; content = _; length } :: segments ->
let messages =
inline_labels
|> List.sort
~compare:
(Comparable.lift (Comparable.reverse Priority.compare) ~f:Tuple2.get1)
|> List.map ~f:Tuple2.get2
in
loop
segments
( Option.to_list prev_segment @ rev_segments
, Column_number.add offset length
, Some { priority; messages; offset; length } )
in
loop segments ([], Column_number.initial, None)
;;
end
let pp_multi_line_label ~config ~severity ~ctxt ppf multi_line_label =
Fmt.pf
ppf
"@[<h>%*s %a %a@]"
ctxt.line_num_width
""
(Chars.pp_source_border_left ~config)
()
(Multi_line_label.pp ~config ~severity ~ctxt)
multi_line_label
;;
let pp_line ~config ~severity ~ctxt ~lnum ppf (line : Line.t) =
let inline_labels = Inline_labels.of_segments line.segments in
let multi_line_labels, unique_top_multi_line_label =
List.fold_right
line.multi_line_labels
~init:([], None)
~f:(fun multi_line_label (mlls, utmll) ->
match multi_line_label with
| Top { start; _ } when (start :> int) - 1 <= line.margin_length ->
(match utmll with
| None -> mlls, Some multi_line_label
| Some utmll -> multi_line_label :: utmll :: mlls, None)
| _ -> multi_line_label :: mlls, utmll)
in
Multi_line_label.pp_content_top
~ctxt
~top:unique_top_multi_line_label
(pp_source_line ~config ~severity ~ctxt ~lnum)
ppf
line;
if not (Inline_labels.is_empty inline_labels)
then (
Fmt.newline ppf ();
lbox ~config ~severity ~ctxt (Inline_labels.pp ~config ~severity) ppf inline_labels);
List.iter multi_line_labels ~f:(fun multi_line_label ->
Fmt.newline ppf ();
pp_multi_line_label ~config ~severity ~ctxt ppf multi_line_label)
;;
let pp_locus ~source ppf (line_num, col_num) =
Fmt.pf
ppf
"@[<h>%s:%a:%a@]"
(Option.value (Source.name source) ~default:"unknown")
Line_number.pp
line_num
Column_number.pp
col_num
;;
let pp_source_start ~config ~ctxt ~source ppf locus =
Fmt.pf
ppf
"@[<h>%*s %a %a@]"
ctxt.line_num_width
""
(Chars.pp_snippet_start ~config)
()
(pp_locus ~source)
locus
;;
let pp_line_gutter ~config ~ctxt ppf () =
Fmt.pf
ppf
"@[<h>%*s %a@]"
ctxt.line_num_width
""
(Chars.pp_source_border_left ~config)
()
;;
let pp_block ~config ~severity ~ctxt ppf ({ start; lines } : Snippet.block) =
List.iteri lines ~f:(fun i line ->
if i <> 0 then Fmt.newline ppf ();
let lnum = Line_number.of_line_index @@ Line_index.add start i in
pp_line ~config ~severity ~ctxt ~lnum ppf line)
;;
let pp_source
~config
~severity
~line_num_width
~multi_width
ppf
({ source; blocks; locus } : Snippet.source)
=
let ctxt = { multi_context = Multi_context.create ~len:multi_width; line_num_width } in
pp_source_start ~config ~ctxt ~source ppf locus;
if not (List.is_empty blocks) then Fmt.pf ppf "@.";
List.iteri blocks ~f:(fun i block ->
if i <> 0
then (
Fmt.newline ppf ();
pp_line_break ~config ~severity ~ctxt ppf ());
pp_block ~config ~severity ~ctxt ppf block)
;;
let pp_code ~config ~code_to_string ~severity ppf code =
Fmt.with_style (Style_sheet.header config.styles severity) ppf
@@ fun ppf () ->
Fmt.(option (any "[" ++ of_to_string code_to_string ++ any "]")) ppf code
;;
let ~config ~code_to_string ~severity ~code ppf message =
Fmt.pf
ppf
"@[<h>%a%a: %a@]"
(pp_severity ~config)
severity
(pp_code ~config ~code_to_string ~severity)
code
(pp_header_message ~config)
message
;;
let pp_note ~config ~line_num_width ppf note =
pwibox
~prefix:
(Fmt.str_like ppf "%*s %a " line_num_width "" (Chars.pp_note_bullet ~config) ())
Message.pp
ppf
note
;;
let pp_rich_snippet
~config
~code_to_string
~line_num_width
~multi_width
ppf
(severity, message, code, sources)
=
pp_header ~config ~code_to_string ~severity ~code ppf message;
if not (List.is_empty sources) then Fmt.newline ppf ();
Fmt.(list ~sep:Fmt.newline (pp_source ~config ~severity ~line_num_width ~multi_width))
ppf
sources
;;
let pp_compact_snippet ~config ~code_to_string ppf (severity, message, code, sources) =
match sources with
| [] -> pp_header ~config ~code_to_string ~severity ~code ppf message
| sources ->
(Fmt.list ~sep:Fmt.newline
@@ fun ppf (source, locus) ->
Fmt.pf
ppf
"@[<h>%a: %a@]"
(pp_locus ~source)
locus
(pp_header ~config ~code_to_string ~severity ~code)
message)
ppf
sources
;;
let line_num_width sources =
match sources with
| Compact _ -> 0
| Rich sources ->
Int.max
(sources
|> List.map ~f:(fun { blocks; _ } ->
match List.last blocks with
| None -> 0
| Some { start; lines; _ } ->
let line_num =
Line_number.of_line_index Line_index.(add start (List.length lines))
in
Line_number.to_string line_num |> String.length)
|> List.max_elt ~compare:Int.compare
|> Option.value ~default:0)
3
;;
let multi_width sources =
let rec count_multi : Snippet.Line.t list -> int = function
| [] -> 0
| line :: lines ->
List.count line.multi_line_labels ~f:(function
| Top _ -> true
| Bottom _ -> false)
+ count_multi lines
in
match sources with
| Compact _ -> 0
| Rich sources ->
sources
|> List.map ~f:(fun { Snippet.blocks; _ } ->
let rec loop_blocks : Snippet.block list -> int = function
| [] -> 0
| { lines; _ } :: blocks -> count_multi lines + loop_blocks blocks
in
loop_blocks blocks)
|> List.max_elt ~compare:Int.compare
|> Option.value ~default:0
;;
let pp_snippet
~config
~code_to_string
ppf
({ severity; message; code; sources; notes } : 'code Snippet.t)
=
Fmt.set_style_renderer ppf (Config.style_renderer config);
Format.pp_set_geometry ppf ~max_indent:2 ~margin:Format.pp_max_margin;
let line_num_width = line_num_width sources in
let multi_width = multi_width sources in
Fmt.pf ppf "@[<v>";
(match sources with
| Compact sources ->
pp_compact_snippet ~config ~code_to_string ppf (severity, message, code, sources)
| Rich sources ->
pp_rich_snippet
~config
~code_to_string
~line_num_width
~multi_width
ppf
(severity, message, code, sources));
if not (List.is_empty notes) then Fmt.newline ppf ();
Fmt.(list ~sep:Fmt.newline (pp_note ~config ~line_num_width)) ppf notes;
Fmt.pf ppf "@]"
;;