-
Notifications
You must be signed in to change notification settings - Fork 96
/
driver.ml
1546 lines (1426 loc) · 52.2 KB
/
driver.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
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
(*$ open Ppxlib_cinaps_helpers $*)
open Import
open Utils
open Common
open With_errors
module Arg = Stdlib.Arg
let exe_name = Stdlib.Filename.basename Stdlib.Sys.executable_name
let args = ref []
let add_arg key spec ~doc = args := (key, spec, doc) :: !args
let loc_fname = ref None
let perform_checks = ref Options.perform_checks
let perform_checks_on_extensions = ref Options.perform_checks_on_extensions
let perform_locations_check = ref Options.perform_locations_check
let debug_attribute_drop = ref false
let apply_list = ref None
let preprocessor = ref None
let no_merge = ref false
let request_print_passes = ref false
let request_print_transformations = ref false
let use_color = ref true
let diff_command = ref Options.diff_command
let pretty = ref false
let styler = ref None
let output_metadata_filename = ref None
let corrected_suffix = ref ".ppx-corrected"
let ghost =
object
inherit Ast_traverse.map
method! location loc = { loc with loc_ghost = true }
end
let chop_prefix ~prefix x =
if String.is_prefix ~prefix x then
Some (String.drop_prefix x (String.length prefix))
else None
let get_default_path (loc : Location.t) =
let fname = loc.loc_start.pos_fname in
match chop_prefix ~prefix:"./" fname with
| Some fname -> fname
| None -> fname
let get_default_path_str : structure -> string = function
| [] -> ""
| { pstr_loc = loc; _ } :: _ -> get_default_path loc
let get_default_path_sig : signature -> string = function
| [] -> ""
| { psig_loc = loc; _ } :: _ -> get_default_path loc
module Lint_error = struct
type t = Location.t * string
let of_string loc s = (loc, s)
end
module Cookies = struct
type t = T
let given_through_cli = ref []
let get T name pattern =
Option.map (Astlib.Ast_metadata.get_cookie name) ~f:(fun e ->
let e = Selected_ast.of_ocaml Expression e in
Ast_pattern.parse pattern e.pexp_loc e Fn.id)
let get_res T name pattern =
match
Option.map (Astlib.Ast_metadata.get_cookie name) ~f:(fun e ->
let e = Selected_ast.of_ocaml Expression e in
Ast_pattern.parse_res pattern e.pexp_loc e Fn.id)
with
| None -> Ok None
| Some (Ok e) -> Ok (Some e)
| Some (Error e) -> Error e
let set T name expr =
Astlib.Ast_metadata.set_cookie name (Selected_ast.to_ocaml Expression expr)
let handlers = ref []
let add_handler f = handlers := !handlers @ [ f ]
let add_simple_handler name pattern ~f =
add_handler (fun T -> f (get T name pattern))
let acknowledge_cookies T = List.iter !handlers ~f:(fun f -> f T)
let post_handlers = ref []
let add_post_handler f = post_handlers := !post_handlers @ [ f ]
let call_post_handlers T = List.iter !post_handlers ~f:(fun f -> f T)
end
module Instrument = struct
type pos = Before | After
type t = {
transformation :
Expansion_context.Base.t ->
Parsetree.structure ->
Parsetree.structure With_errors.t;
position : pos;
}
module V2 = struct
let make transformation ~position =
let transformation ctx st = return (transformation ctx st) in
{ transformation; position }
end
let make transformation ~position =
let transformation _ st = transformation st in
V2.make transformation ~position
end
module Transform = struct
type t = {
name : string;
aliases : string list;
impl :
(Expansion_context.Base.t ->
Parsetree.structure ->
Parsetree.structure With_errors.t)
option;
intf :
(Expansion_context.Base.t ->
Parsetree.signature ->
Parsetree.signature With_errors.t)
option;
lint_impl :
(Expansion_context.Base.t -> Parsetree.structure -> Lint_error.t list)
option;
lint_intf :
(Expansion_context.Base.t -> Parsetree.signature -> Lint_error.t list)
option;
preprocess_impl :
(Expansion_context.Base.t ->
Parsetree.structure ->
Parsetree.structure With_errors.t)
option;
preprocess_intf :
(Expansion_context.Base.t ->
Parsetree.signature ->
Parsetree.signature With_errors.t)
option;
enclose_impl :
(Expansion_context.Base.t ->
Location.t option ->
Parsetree.structure * Parsetree.structure)
option;
enclose_intf :
(Expansion_context.Base.t ->
Location.t option ->
Parsetree.signature * Parsetree.signature)
option;
instrument : Instrument.t option;
rules : Context_free.Rule.t list;
registered_at : Caller_id.t;
}
let has_name t name =
String.equal name t.name || List.exists ~f:(String.equal name) t.aliases
let all : t list ref = ref []
let print_caller_id oc (caller_id : Caller_id.t) =
match caller_id with
| None -> output_string oc "<unknown location>"
| Some loc -> Printf.fprintf oc "%s:%d" loc.filename loc.line_number
let register ?(extensions = []) ?(rules = []) ?enclose_impl ?enclose_intf
?impl ?intf ?lint_impl ?lint_intf ?preprocess_impl ?preprocess_intf
?instrument ?(aliases = []) name =
let rules = List.map extensions ~f:Context_free.Rule.extension @ rules in
let caller_id = Caller_id.get ~skip:[ Stdlib.__FILE__ ] in
(match List.filter !all ~f:(fun ct -> has_name ct name) with
| [] -> ()
| ct :: _ ->
Printf.eprintf "Warning: code transformation %s registered twice.\n"
name;
Printf.eprintf " - first time was at %a\n" print_caller_id
ct.registered_at;
Printf.eprintf " - second time is at %a\n" print_caller_id caller_id);
let impl = Option.map impl ~f:(fun f ctx ast -> return (f ctx ast)) in
let intf = Option.map intf ~f:(fun f ctx ast -> return (f ctx ast)) in
let preprocess_impl =
Option.map preprocess_impl ~f:(fun f ctx ast -> return (f ctx ast))
in
let preprocess_intf =
Option.map preprocess_intf ~f:(fun f ctx ast -> return (f ctx ast))
in
let ct =
{
name;
aliases;
rules;
enclose_impl;
enclose_intf;
impl;
intf;
lint_impl;
preprocess_impl;
preprocess_intf;
lint_intf;
instrument;
registered_at = caller_id;
}
in
all := ct :: !all
let rec last prev l = match l with [] -> prev | x :: l -> last x l
let loc_of_list ~get_loc l =
match l with
| [] -> None
| x :: l ->
let first : Location.t = get_loc x in
let last = get_loc (last x l) in
Some { first with loc_end = last.loc_end }
let merge_into_generic_mappers t ~embed_errors ~hook ~expect_mismatch_handler
~tool_name ~input_name =
let { rules; enclose_impl; enclose_intf; impl; intf; _ } = t in
let map =
new Context_free.map_top_down
rules ~embed_errors ~generated_code_hook:hook ~expect_mismatch_handler
in
let gen_header_and_footer context whole_loc f =
let header, footer = f whole_loc in
(match whole_loc with
| Some (loc : Location.t) -> (
let loc_header = { loc with loc_end = loc.loc_start } in
let loc_footer = { loc with loc_start = loc.loc_end } in
(match header with
| [] -> ()
| _ -> hook.f context loc_header (Many header));
match footer with
| [] -> ()
| _ -> hook.f context loc_footer (Many footer))
| None -> (
match header @ footer with
| [] -> ()
| l ->
let pos =
{
Lexing.pos_fname = "";
pos_lnum = 1;
pos_bol = 0;
pos_cnum = 0;
}
in
let loc =
{ Location.loc_start = pos; loc_end = pos; loc_ghost = false }
in
hook.f context loc (Many l)));
(header, footer)
in
let input_name =
match input_name with Some input_name -> input_name | None -> "_none_"
in
let map_impl ctxt st_with_attrs =
let attrs, st =
List.split_while st_with_attrs ~f:(function
| { pstr_desc = Pstr_attribute _; _ } -> true
| _ -> false)
in
let file_path = get_default_path_str st in
let base_ctxt =
Expansion_context.Base.top_level ~tool_name ~file_path ~input_name
in
let header, footer =
match enclose_impl with
| None -> ([], [])
| Some f ->
let whole_loc =
loc_of_list st ~get_loc:(fun st -> st.Parsetree.pstr_loc)
in
gen_header_and_footer Structure_item whole_loc (f base_ctxt)
in
map#structure base_ctxt (List.concat [ attrs; header; st; footer ])
>>= fun st -> match impl with None -> return st | Some f -> f ctxt st
in
let map_intf ctxt sg_with_attrs =
let attrs, sg =
List.split_while sg_with_attrs ~f:(function
| { psig_desc = Psig_attribute _; _ } -> true
| _ -> false)
in
let file_path = get_default_path_sig sg in
let base_ctxt =
Expansion_context.Base.top_level ~tool_name ~file_path ~input_name
in
let header, footer =
match enclose_intf with
| None -> ([], [])
| Some f ->
let whole_loc =
loc_of_list sg ~get_loc:(fun sg -> sg.Parsetree.psig_loc)
in
gen_header_and_footer Signature_item whole_loc (f base_ctxt)
in
map#signature base_ctxt (List.concat [ attrs; header; sg; footer ])
>>= fun sg -> match intf with None -> return sg | Some f -> f ctxt sg
in
{ t with impl = Some map_impl; intf = Some map_intf }
let builtin_of_context_free_rewriters ~hook ~rules ~enclose_impl ~enclose_intf
~input_name =
merge_into_generic_mappers ~hook ~input_name
{
name = "<builtin:context-free>";
aliases = [];
impl = None;
intf = None;
lint_impl = None;
lint_intf = None;
preprocess_impl = None;
preprocess_intf = None;
enclose_impl;
enclose_intf;
instrument = None;
rules;
registered_at = Caller_id.get ~skip:[];
}
let partition_transformations ts =
let before_instrs, after_instrs, rest =
List.fold_left ts ~init:([], [], []) ~f:(fun (bef_i, aft_i, rest) t ->
let reduced_t =
{
t with
lint_impl = None;
lint_intf = None;
preprocess_impl = None;
preprocess_intf = None;
}
in
let f instr =
(instr.Instrument.position, instr.Instrument.transformation)
in
match Option.map t.instrument ~f with
| Some (Before, transf) ->
( { reduced_t with impl = Some transf; rules = [] } :: bef_i,
aft_i,
reduced_t :: rest )
| Some (After, transf) ->
( bef_i,
{ reduced_t with impl = Some transf; rules = [] } :: aft_i,
reduced_t :: rest )
| None -> (bef_i, aft_i, reduced_t :: rest))
in
( `Linters
(List.filter_map ts ~f:(fun t ->
if Option.is_some t.lint_impl || Option.is_some t.lint_intf then
Some
{
name = Printf.sprintf "<lint:%s>" t.name;
aliases = [];
impl = None;
intf = None;
lint_impl = t.lint_impl;
lint_intf = t.lint_intf;
enclose_impl = None;
enclose_intf = None;
preprocess_impl = None;
preprocess_intf = None;
instrument = None;
rules = [];
registered_at = t.registered_at;
}
else None)),
`Preprocess
(List.filter_map ts ~f:(fun t ->
if
Option.is_some t.preprocess_impl
|| Option.is_some t.preprocess_intf
then
Some
{
name = Printf.sprintf "<preprocess:%s>" t.name;
aliases = [];
impl = t.preprocess_impl;
intf = t.preprocess_intf;
lint_impl = None;
lint_intf = None;
enclose_impl = None;
enclose_intf = None;
preprocess_impl = None;
preprocess_intf = None;
instrument = None;
rules = [];
registered_at = t.registered_at;
}
else None)),
`Before_instrs before_instrs,
`After_instrs after_instrs,
`Rest rest )
end
module V2 = struct
let register_transformation = Transform.register
let register_transformation_using_ocaml_current_ast ?impl ?intf ?aliases name
=
let impl =
Option.map impl ~f:(Ppxlib_ast.Selected_ast.of_ocaml_mapper Structure)
in
let intf =
Option.map intf ~f:(Ppxlib_ast.Selected_ast.of_ocaml_mapper Signature)
in
register_transformation ?impl ?intf ?aliases name
end
let add_ctxt_arg (f : 'a -> 'b) : Expansion_context.Base.t -> 'a -> 'b =
fun _ x -> f x
let register_transformation ?extensions ?rules ?enclose_impl ?enclose_intf ?impl
?intf ?lint_impl ?lint_intf ?preprocess_impl ?preprocess_intf =
let impl = Option.map impl ~f:add_ctxt_arg in
let intf = Option.map intf ~f:add_ctxt_arg in
let preprocess_impl = Option.map preprocess_impl ~f:add_ctxt_arg in
let preprocess_intf = Option.map preprocess_intf ~f:add_ctxt_arg in
let lint_impl = Option.map lint_impl ~f:add_ctxt_arg in
let lint_intf = Option.map lint_intf ~f:add_ctxt_arg in
let enclose_impl = Option.map enclose_impl ~f:add_ctxt_arg in
let enclose_intf = Option.map enclose_intf ~f:add_ctxt_arg in
V2.register_transformation ?extensions ?rules ?enclose_impl ?enclose_intf
?impl ?intf ?lint_impl ?lint_intf ?preprocess_impl ?preprocess_intf
let register_code_transformation ~name ?(aliases = []) ~impl ~intf =
register_transformation name ~impl ~intf ~aliases
[@@warning "-16"]
(* This function triggers a warning 16 as of ocaml 4.12 *)
let register_transformation_using_ocaml_current_ast ?impl ?intf =
let impl = Option.map impl ~f:add_ctxt_arg in
let intf = Option.map intf ~f:add_ctxt_arg in
V2.register_transformation_using_ocaml_current_ast ?impl ?intf
let debug_dropped_attribute name ~old_dropped ~new_dropped =
let print_diff what a b =
let diff =
List.filter a ~f:(fun (name : _ Loc.t) ->
not
(List.exists b ~f:(fun (name' : _ Location.loc) ->
name.txt == name'.txt)))
in
if not (List.is_empty diff) then (
Printf.eprintf "The following attributes %s after applying %s:\n" what
name;
List.iter diff ~f:(fun { Location.txt; loc } ->
Stdlib.Format.eprintf "- %a: %s\n" Location.print loc txt);
Stdlib.Format.eprintf "@.")
in
print_diff "disappeared" new_dropped old_dropped;
print_diff "reappeared" old_dropped new_dropped
let get_whole_ast_passes ~embed_errors ~hook ~expect_mismatch_handler ~tool_name
~input_name =
let cts =
match !apply_list with
| None -> List.rev !Transform.all
| Some names ->
List.map names ~f:(fun name ->
List.find !Transform.all ~f:(fun (ct : Transform.t) ->
Transform.has_name ct name))
in
let ( `Linters linters,
`Preprocess preprocess,
`Before_instrs before_instrs,
`After_instrs after_instrs,
`Rest cts ) =
Transform.partition_transformations cts
in
(* Allow only one preprocessor to assure deterministic order *)
(if List.length preprocess > 1 then
let pp =
String.concat ~sep:", " (List.map preprocess ~f:(fun t -> t.name))
in
let err =
Printf.sprintf "At most one preprocessor is allowed, while got: %s" pp
in
failwith err);
let make_generic transforms =
if !no_merge then
List.map transforms
~f:
(Transform.merge_into_generic_mappers ~embed_errors ~hook ~tool_name
~expect_mismatch_handler ~input_name)
else
(let get_enclosers ~f =
List.filter_map transforms ~f:(fun (ct : Transform.t) ->
match f ct with None -> None | Some x -> Some (ct.name, x))
(* Sort them to ensure deterministic ordering *)
|> List.sort ~cmp:(fun (a, _) (b, _) -> String.compare a b)
|> List.map ~f:snd
in
let rules =
List.map transforms ~f:(fun (ct : Transform.t) -> ct.rules)
|> List.concat
and impl_enclosers = get_enclosers ~f:(fun ct -> ct.enclose_impl)
and intf_enclosers = get_enclosers ~f:(fun ct -> ct.enclose_intf) in
match (rules, impl_enclosers, intf_enclosers) with
| [], [], [] -> transforms
| _ ->
let merge_encloser = function
| [] -> None
| enclosers ->
Some
(fun ctxt loc ->
let headers, footers =
List.map enclosers ~f:(fun f -> f ctxt loc) |> List.split
in
let headers = List.concat headers in
let footers = List.concat (List.rev footers) in
(headers, footers))
in
Transform.builtin_of_context_free_rewriters ~rules ~embed_errors
~hook ~expect_mismatch_handler
~enclose_impl:(merge_encloser impl_enclosers)
~enclose_intf:(merge_encloser intf_enclosers)
~tool_name ~input_name
:: transforms)
|> List.filter ~f:(fun (ct : Transform.t) ->
match (ct.impl, ct.intf) with None, None -> false | _ -> true)
in
linters @ preprocess @ before_instrs @ make_generic cts @ after_instrs
let apply_transforms ~tool_name ~file_path ~field ~lint_field ~dropped_so_far
~hook ~expect_mismatch_handler ~input_name ~embed_errors ast =
let cts =
get_whole_ast_passes ~tool_name ~embed_errors ~hook ~expect_mismatch_handler
~input_name
in
let finish (ast, _dropped, lint_errors, errors) =
( ast,
List.map lint_errors ~f:(fun (loc, s) ->
Common.attribute_of_warning loc s),
errors )
in
let acc =
List.fold_left cts ~init:(ast, [], [], [])
~f:(fun
(ast, dropped, (lint_errors : _ list), errors) (ct : Transform.t) ->
let input_name =
match input_name with
| Some input_name -> input_name
| None -> "_none_"
in
let ctxt =
Expansion_context.Base.top_level ~tool_name ~file_path ~input_name
in
let lint_errors, errors =
match lint_field ct with
| None -> (lint_errors, errors)
| Some f -> (
try (lint_errors @ f ctxt ast, errors)
with exn when embed_errors ->
(lint_errors, exn_to_loc_error exn :: errors))
in
match field ct with
| None -> (ast, dropped, lint_errors, errors)
| Some f ->
let (ast, more_errors), errors =
try (f ctxt ast, errors)
with exn when embed_errors ->
((ast, []), exn_to_loc_error exn :: errors)
in
let dropped =
if !debug_attribute_drop then (
let new_dropped = dropped_so_far ast in
debug_dropped_attribute ct.name ~old_dropped:dropped
~new_dropped;
new_dropped)
else []
in
(ast, dropped, lint_errors, errors @ more_errors))
in
finish acc
(*$*)
let error_to_str_extension error =
let loc = Location.none in
let ext = Location.Error.to_extension error in
Ast_builder.Default.pstr_extension ~loc ext []
(*$ str_to_sig _last_text_block *)
let error_to_sig_extension error =
let loc = Location.none in
let ext = Location.Error.to_extension error in
Ast_builder.Default.psig_extension ~loc ext []
(*$*)
let error_to_extension error ~(kind : Kind.t) =
match kind with
| Intf -> Intf_or_impl.Intf [ error_to_sig_extension error ]
| Impl -> Intf_or_impl.Impl [ error_to_str_extension error ]
let exn_to_extension exn ~(kind : Kind.t) =
exn_to_loc_error exn |> error_to_extension ~kind
(* +-----------------------------------------------------------------+
| Actual rewriting of structure/signatures |
+-----------------------------------------------------------------+ *)
let print_passes () =
let tool_name = "ppxlib_driver" in
let embed_errors = false in
let hook = Context_free.Generated_code_hook.nop in
let expect_mismatch_handler = Context_free.Expect_mismatch_handler.nop in
let cts =
get_whole_ast_passes ~embed_errors ~hook ~expect_mismatch_handler ~tool_name
~input_name:None
in
if !perform_checks then
Printf.printf "<builtin:freshen-and-collect-attributes>\n";
List.iter cts ~f:(fun ct -> Printf.printf "%s\n" ct.Transform.name);
if !perform_checks then (
Printf.printf "<builtin:check-unused-attributes>\n";
if !perform_checks_on_extensions then
Printf.printf "<builtin:check-unused-extensions>\n")
let sort_errors_by_loc errors =
List.sort errors ~cmp:(fun error error' ->
let loc = Location.Error.get_location error in
let loc' = Location.Error.get_location error' in
Location.compare loc loc')
(*$*)
let map_structure_gen st ~tool_name ~hook ~expect_mismatch_handler ~input_name
~embed_errors =
Cookies.acknowledge_cookies T;
if !perform_checks then (
Attribute.reset_checks ();
Attribute.collect#structure st);
let lint lint_errors st =
let st =
match lint_errors with
| [] -> st
| _ ->
List.map lint_errors
~f:(fun ({ attr_name = { loc; _ }; _ } as attr) ->
Ast_builder.Default.pstr_attribute ~loc attr)
@ st
in
st
in
let with_errors errors st =
let sorted = sort_errors_by_loc errors in
List.map sorted ~f:(fun error ->
Ast_builder.Default.pstr_extension
~loc:(Location.Error.get_location error)
(Location.Error.to_extension error)
[]
|> ghost#structure_item)
@ st
in
let cookies_and_check st =
Cookies.call_post_handlers T;
let errors =
if !perform_checks then
(* TODO: these two passes could be merged, we now have more passes for
checks than for actual rewriting. *)
let unused_attributes_errors =
Attribute.collect_unused_attributes_errors#structure st []
in
let unused_extension_errors =
if !perform_checks_on_extensions then
Extension.collect_unhandled_extension_errors#structure st []
else []
in
let not_seen_errors = Attribute.collect_unseen_errors () in
unused_attributes_errors @ unused_extension_errors @ not_seen_errors
else []
in
(if !perform_locations_check then
let open Location_check in
ignore
((enforce_invariants !loc_fname)#structure st
Non_intersecting_ranges.empty
: Non_intersecting_ranges.t));
with_errors errors st
in
let file_path = get_default_path_str st in
let st, lint_errors, errors =
apply_transforms st ~tool_name ~file_path
~field:(fun (ct : Transform.t) -> ct.impl)
~lint_field:(fun (ct : Transform.t) -> ct.lint_impl)
~dropped_so_far:Attribute.dropped_so_far_structure ~hook
~expect_mismatch_handler ~input_name ~embed_errors
in
st |> lint lint_errors |> cookies_and_check |> with_errors (List.rev errors)
let map_structure st =
match
map_structure_gen st
~tool_name:(Astlib.Ast_metadata.tool_name ())
~hook:Context_free.Generated_code_hook.nop
~expect_mismatch_handler:Context_free.Expect_mismatch_handler.nop
~input_name:None ~embed_errors:false
with
| ast -> ast
(*$ str_to_sig _last_text_block *)
let map_signature_gen sg ~tool_name ~hook ~expect_mismatch_handler ~input_name
~embed_errors =
Cookies.acknowledge_cookies T;
if !perform_checks then (
Attribute.reset_checks ();
Attribute.collect#signature sg);
let lint lint_errors sg =
let sg =
match lint_errors with
| [] -> sg
| _ ->
List.map lint_errors
~f:(fun ({ attr_name = { loc; _ }; _ } as attr) ->
Ast_builder.Default.psig_attribute ~loc attr)
@ sg
in
sg
in
let with_errors errors sg =
let sorted = sort_errors_by_loc errors in
List.map sorted ~f:(fun error ->
Ast_builder.Default.psig_extension
~loc:(Location.Error.get_location error)
(Location.Error.to_extension error)
[]
|> ghost#signature_item)
@ sg
in
let cookies_and_check sg =
Cookies.call_post_handlers T;
let errors =
if !perform_checks then
(* TODO: these two passes could be merged, we now have more passes for
checks than for actual rewriting. *)
let unused_attributes_errors =
Attribute.collect_unused_attributes_errors#signature sg []
in
let unused_extension_errors =
if !perform_checks_on_extensions then
Extension.collect_unhandled_extension_errors#signature sg []
else []
in
let not_seen_errors = Attribute.collect_unseen_errors () in
unused_attributes_errors @ unused_extension_errors @ not_seen_errors
else []
in
(if !perform_locations_check then
let open Location_check in
ignore
((enforce_invariants !loc_fname)#signature sg
Non_intersecting_ranges.empty
: Non_intersecting_ranges.t));
with_errors errors sg
in
let file_path = get_default_path_sig sg in
let sg, lint_errors, errors =
apply_transforms sg ~tool_name ~file_path
~field:(fun (ct : Transform.t) -> ct.intf)
~lint_field:(fun (ct : Transform.t) -> ct.lint_intf)
~dropped_so_far:Attribute.dropped_so_far_signature ~hook
~expect_mismatch_handler ~input_name ~embed_errors
in
sg |> lint lint_errors |> cookies_and_check |> with_errors (List.rev errors)
let map_signature sg =
match
map_signature_gen sg
~tool_name:(Astlib.Ast_metadata.tool_name ())
~hook:Context_free.Generated_code_hook.nop
~expect_mismatch_handler:Context_free.Expect_mismatch_handler.nop
~input_name:None ~embed_errors:false
with
| ast -> ast
(*$*)
(* +-----------------------------------------------------------------+
| Entry points |
+-----------------------------------------------------------------+ *)
let string_contains_binary_ast s =
let test magic_number =
String.is_prefix s ~prefix:(String.sub magic_number ~pos:0 ~len:9)
in
test Ast_magic.ast_intf_magic_number || test Ast_magic.ast_impl_magic_number
let versioned_errorf input_version input_file_name =
Printf.ksprintf (fun msg ->
let err =
Location.Error.make ~loc:(Location.in_file input_file_name) msg ~sub:[]
in
Error (err, input_version))
let remove_no_error fn = try Stdlib.Sys.remove fn with Sys_error _ -> ()
let protectx x ~f ~finally =
match f x with
| v ->
finally x;
v
| exception e ->
finally x;
raise e
let with_preprocessed_file fn ~f =
match !preprocessor with
| None -> f fn
| Some pp ->
protectx (Stdlib.Filename.temp_file "ocamlpp" "") ~finally:remove_no_error
~f:(fun tmpfile ->
match System.run_preprocessor ~pp ~input:fn ~output:tmpfile with
| Ok () -> f tmpfile
| Error (failed_command, fall_back_version) ->
versioned_errorf fall_back_version fn
"Error while running external preprocessor\nCommand line: %s\n"
failed_command)
let relocate_mapper =
object
inherit [string * string] Ast_traverse.map_with_context
method! position (old_fn, new_fn) pos =
if String.equal pos.pos_fname old_fn then { pos with pos_fname = new_fn }
else pos
end
(* Set the input name globally. This is used by some ppx rewriters
such as bisect_ppx. *)
let set_input_name = Astlib.Location.set_input_name
let load_input ~(kind : Kind.t) ~input_name ~relocate fn =
set_input_name input_name;
let input_source = if String.equal fn "-" then Ast_io.Stdin else File fn in
let input_kind = Ast_io.Possibly_source (kind, input_name) in
match Ast_io.read input_source ~input_kind with
| Ok { input_name = ast_input_name; input_version; ast } ->
let ast_kind = Intf_or_impl.kind ast in
if not (Kind.equal kind ast_kind) then
versioned_errorf input_version fn
"File contains a binary %s AST but an %s was expected"
(Kind.describe ast_kind) (Kind.describe kind)
else if String.equal ast_input_name input_name || not relocate then (
set_input_name ast_input_name;
Ok (ast_input_name, input_version, ast))
else
Ok
( input_name,
input_version,
Intf_or_impl.map_with_context ast relocate_mapper
(ast_input_name, input_name) )
| Error (Unknown_version (unknown_magic, fall_back_version)) ->
versioned_errorf fall_back_version fn
"File is a binary ast for an unknown version of OCaml with magic \
number '%s'"
unknown_magic
| Error (System_error (error, fall_back_version))
| Error (Source_parse_error (error, fall_back_version)) ->
Error (error, fall_back_version)
| Error Not_a_binary_ast -> assert false
let load_input_run_as_ppx fn =
(* If there's an error while loading in run_as_ppx mode, the kind of AST (impl/intf) is still unknown.
That's why, as opposed to load_input, this function raises errors instead of returning a result:
handling an error by returning an AST with the error packed as extension node wouldn't be possible. *)
match Ast_io.read (File fn) ~input_kind:Ast_io.Necessarily_binary with
| Ok { input_name = ast_input_name; input_version; ast } ->
let ast =
match !loc_fname with
| None ->
set_input_name ast_input_name;
ast
| Some input_name ->
set_input_name input_name;
if String.equal ast_input_name input_name then ast
else
Intf_or_impl.map_with_context ast relocate_mapper
(ast_input_name, input_name)
in
(* With `--as-ppx`, ocaml calls the standalone separately for every structure/signature item
with the filename as metadata that it gets from the previous call. relocate_mapper only
relocates positions whose position filename coincides with that metadata filename.
So always return the metadata filename itself, even if `-loc-filename` is provided. *)
(ast_input_name, input_version, ast)
| Error (Unknown_version (unknown_magic, _)) ->
Location.raise_errorf ~loc:(Location.in_file fn)
"The input is a binary ast for an unknown version of OCaml with magic \
number '%s'"
unknown_magic
| Error Not_a_binary_ast ->
Location.raise_errorf ~loc:(Location.in_file fn)
"Expected a binary AST as input"
| Error (System_error (error, _)) | Error (Source_parse_error (error, _)) ->
let open Location.Error in
Location.set_filename (get_location error) fn |> update_loc error |> raise
let load_source_file fn =
let s = In_channel.read_all fn in
if string_contains_binary_ast s then
Location.raise_errorf ~loc:(Location.in_file fn)
"ppxlib_driver: cannot use -reconcile with binary AST files";
s
type output_mode =
| Pretty_print
| Dump_ast
| Dparsetree
| Reconcile of Reconcile.mode
| Null
(*$*)
let extract_cookies_str st =
let st =
match st with
| ({
pstr_desc =
Pstr_attribute { attr_name = { txt = "ocaml.ppx.context"; _ }; _ };
_;
} as prefix)
:: st ->
let prefix = Ppxlib_ast.Selected_ast.to_ocaml Structure [ prefix ] in
assert (
List.is_empty
(Astlib.Ast_metadata.drop_ppx_context_str ~restore:true prefix));
st
| _ -> st
in
(* The cli cookies have to be set after restoring the ppx context,
since restoring the ppx context resets the cookies *)
List.iter !Cookies.given_through_cli ~f:(fun (name, expr) ->
Cookies.set T name expr);
st
let add_cookies_str st =
let prefix =
Astlib.Ast_metadata.add_ppx_context_str ~tool_name:"ppxlib_driver" []
|> Ppxlib_ast.Selected_ast.of_ocaml Structure
in
prefix @ st
(*$ str_to_sig _last_text_block *)
let extract_cookies_sig sg =
let sg =
match sg with
| ({
psig_desc =
Psig_attribute { attr_name = { txt = "ocaml.ppx.context"; _ }; _ };
_;
} as prefix)
:: sg ->
let prefix = Ppxlib_ast.Selected_ast.to_ocaml Signature [ prefix ] in
assert (
List.is_empty
(Astlib.Ast_metadata.drop_ppx_context_sig ~restore:true prefix));
sg
| _ -> sg
in
(* The cli cookies have to be set after restoring the ppx context,
since restoring the ppx context resets the cookies *)
List.iter !Cookies.given_through_cli ~f:(fun (name, expr) ->
Cookies.set T name expr);
sg
let add_cookies_sig sg =
let prefix =
Astlib.Ast_metadata.add_ppx_context_sig ~tool_name:"ppxlib_driver" []
|> Ppxlib_ast.Selected_ast.of_ocaml Signature
in
prefix @ sg
(*$*)
let extract_cookies (ast : Intf_or_impl.t) : Intf_or_impl.t =
match ast with
| Intf x -> Intf (extract_cookies_sig x)
| Impl x -> Impl (extract_cookies_str x)
let add_cookies (ast : Intf_or_impl.t) : Intf_or_impl.t =
match ast with
| Intf x -> Intf (add_cookies_sig x)
| Impl x -> Impl (add_cookies_str x)
let corrections = ref []
let add_to_list r x = r := x :: !r
let register_correction ~loc ~repl =
add_to_list corrections
(Reconcile.Replacement.make_text () ~start:loc.loc_start ~stop:loc.loc_end
~repl)