-
Notifications
You must be signed in to change notification settings - Fork 125
/
bslRegisterLib.ml
1718 lines (1371 loc) · 52.1 KB
/
bslRegisterLib.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
(*
Copyright © 2011, 2012 MLstate
This file is part of Opa.
Opa is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
Opa is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with Opa. If not, see <http://www.gnu.org/licenses/>.
*)
(* CF mli *)
module File = File
module List = Base.List
module String = Base.String
module Format = Base.Format
exception SigInt
let set_signal_sigint () =
Sys.set_signal Sys.sigint (Sys.Signal_handle (fun _ -> raise SigInt))
let unset_signal_sigint () =
assert false (* TODO if needed *)
(* The bsl used is the dummy version, bslregister does not generated projection code *)
module BSL = BslLib.BSL
(* alias *)
module BPI = BslPluginInterface
module BI = BslInterface
module BMP = BslMarshalPlugin
module BRI = BSL.RegisterInterface
module BRParse = BslRegisterParser
module BRState = BslRegisterParserState
module BDir = BslDirectives
(*
Types alias and definition.
*)
type language = BslLanguage.t
type filename = string
type module_name = string
type contents = string
type uniq_id = string
type line_number = int
type skey = string
type implementation = string
type js_contents = [`code of JsAst.code | `verbatim of string ]
(* debug *)
let debug fmt =
OManager.printf ("@[<2>@{<cyan>[bslregister]@}@ "^^fmt^^"@]@.")
(*
Parsing files.
*)
(*
From a previous primitive library, Ordered topologicly
*)
type depends = {
d_plugins : BPI.plugin list ;
d_bymap : BSL.ByPassMap.t ;
d_ml_runtimes : module_name list ;
d_parents : BPI.uniq_id list ;
d_js_code : ( filename * contents ) list ;
d_nodejs_code : ( filename * contents ) list ;
d_opa_code : ( filename * contents ) list ;
}
(*
Some of then are needed, because their name appears in some generated files
*)
type identification = {
i_basename : BPI.plugin_basename option ;
i_ml_plugin : module_name ;
i_ml_runtime : module_name ;
i_uniq_id : uniq_id ;
}
(*
Calls to BRI register_primitive and register_type need to be grouped,
once all languages have been processed.
This type is used for collecting calls, and the effective calls to the
BRI is done only @finalize.
TODO: there is currently a hack about BslTags, the file BslLib expects
BslTags.parsed_t, where is should be BslTags.t.
Once BslLib is no more using a hack about this, we can change
the type of field c_rpi_tags for BslTags.t
*)
type rp_impl = {
c_rpi_filename : filename ;
c_rpi_tags : BslTags.parsed_t ;
c_rpi_type : BslTypes.t ;
c_rpi_implementation : implementation ;
}
type collecting_rp_ips = rp_impl BslLanguageMap.t
type rp_call = {
c_rp_ks : skey list ;
c_rp_ty : BslTypes.t ; (* purged from opa values *)
c_rp_ips : collecting_rp_ips ;
c_rp_obj : implementation option ;
}
type collecting_rp_calls = rp_call BslKeyMap.t
type rt_call = {
c_rt_ks : skey list ;
c_rt_ty : BslTypes.t ;
}
type collecting_rt_calls = rt_call BslKeyMap.t
(*
The session
*)
type session = {
(* 1) static part, built at creation time *)
s_options : BI.options ;
s_pprocess : string -> string -> string ;
s_depends : depends ;
s_identification : identification ;
(* 2) evoluation as long as we process files *)
s_conf : BslConf.t ;
s_js_confs : BslJsConf.t ;
s_nodejs_conf : BslJsConf.t ;
s_marshal_plugin_s : BMP.session ;
s_ml_dynloader_loader : FBuffer.t ;
s_ml_dynloader_plugin : FBuffer.t ;
s_rev_js_parsed_files : BslJs.decorated_file list ;
s_rev_nodejs_parsed_files : BslJs.decorated_file list ;
s_rev_ml_parsed_files : BslDirectives.bypasslang_decorated_file list ;
s_rev_opa_decorated_files : BslDirectives.opalang_decorated_file list ;
s_has_server_code : bool ;
(*
3) collecting calls to the Register Interface.
*)
s_rp_calls : collecting_rp_calls ;
s_rt_calls : collecting_rt_calls ;
(* 4) A pre-finalization, which keep the type session for its representation *)
(*
opa files may contains include directives which need to be solved at finalization
opa_code and opa_interface are obtained at finalization time
*)
s_js_pack : JsPackage.t ;
s_nodejs_pack : JsPackage.t ;
s_ml_runtime : FBuffer.t option;
s_ml_runtime_mli : FBuffer.t option;
s_opa_code : (filename * contents) list ;
s_opa_interface : (filename * contents) list ;
}
(*
Create
*)
let create_s_fbuffer () = FBuffer.create (8 * 1024)
(*
Load some plugins
*)
let load_plugin plugins =
let dynlink plugin =
OManager.verbose "loading primitives from file @{<bright>%S@}" (BslDynlink.file plugin) ;
BslDynlink.load_bypass_plugin plugin
in
List.iter dynlink plugins
(*
Fold depends plugin
*)
let d_fold_plugin
(rev_ml_runtime_list, rev_parent_list, rev_js_code_list, rev_nodejs_code_list, rev_opa_code_list) plugin =
BSL.RegisterInterface.dynload_no_obj plugin.BPI.dynloader ;
let rev_ml_runtime_list = plugin.BPI.ml_runtime :: rev_ml_runtime_list in
let rev_parent_list = plugin.BPI.uniq_id :: rev_parent_list in
let rev_opa_code_list = List.rev_append plugin.BPI.opa_code rev_opa_code_list in
rev_ml_runtime_list, rev_parent_list, rev_js_code_list, rev_nodejs_code_list, rev_opa_code_list
let create_s_depends options =
(* This has a side effect on BslPluginTable *)
load_plugin options.BI.bypass_plugins ;
let d_plugins = BslPluginTable.finalize () in
let (ml, prt, js, nodejs, opa) =
List.fold_left d_fold_plugin ([], [], [], [], []) d_plugins
in
let d_ml_runtimes = List.rev ml in
let d_parents = List.rev prt in
let d_js_code = List.rev js in
let d_nodejs_code = List.rev nodejs in
let d_opa_code = List.rev opa in
(* All dynload have been done in d_fold, we can build the depends bymap *)
let d_bymap = BSL.RegisterTable.build_bypass_map () in
let depends = {
d_plugins ;
d_bymap ;
d_ml_runtimes ;
d_parents ;
d_js_code ;
d_nodejs_code ;
d_opa_code ;
}
in
depends
let create_uniq_id name =
(* FIXME: thing about where does go the function now () *)
let now = DebugTracer.now in
let buildinfos = BuildInfos.version_id in
let now = now () in
let uniq_id = Printf.sprintf "%s_%s_%s" name buildinfos now in
uniq_id
let create_s_identification options =
let i_basename = options.BI.basename in
let i_ml_plugin = OcamlUtils.Module.of_filename options.BI.ml_plugin_filename in
let i_ml_runtime = OcamlUtils.Module.of_filename options.BI.ml_runtime_filename in
let i_uniq_id = create_uniq_id i_ml_plugin in
let identification = {
i_basename ;
i_ml_plugin ;
i_ml_runtime ;
i_uniq_id ;
}
in
identification
(* some checks *)
let check_session session =
let depends = session.s_depends in
let identification = session.s_identification in
let error_unicity kind name =
OManager.error (
"Generation of @{<bright>%s@} module-clash@\n" ^^
"The asked target module name @{<bright>%S@} " ^^
"is already used by a previous loaded primitive library@\n" ^^
"Please specify another target ( try option --help )@\n"
) kind name
in
(* unicity of plugin names *)
let _ =
let ml_plugin = identification.i_uniq_id in
if List.mem ml_plugin depends.d_parents then
error_unicity "MLplugin" ml_plugin
in
(* unicity of runtime names *)
let _ =
let ml_runtime = identification.i_ml_runtime in
if List.mem ml_runtime depends.d_ml_runtimes then
error_unicity "MLruntime" ml_runtime
in
session
let create ~options =
let s_options = options in
let s_pprocess = fun _ content -> content in
let s_depends = create_s_depends options in
let s_identification = create_s_identification options in
let s_conf = BslConf.default in
let s_js_confs = BslJsConf.empty options.BI.js_files in
let s_nodejs_conf = BslJsConf.empty options.BI.nodejs_files in
let s_marshal_plugin_s = BMP.create () in
let s_ml_dynloader_loader = create_s_fbuffer () in
let s_ml_dynloader_plugin = create_s_fbuffer () in
let s_rev_js_parsed_files = [] in
let s_rev_nodejs_parsed_files = [] in
let s_rev_ml_parsed_files = [] in
let s_rev_opa_decorated_files = [] in
let s_has_server_code = false in
let s_rp_calls = BslKeyMap.empty in
let s_rt_calls = BslKeyMap.empty in
let s_js_pack = JsPackage.default ~name:"fake" in
let s_nodejs_pack = JsPackage.default ~name:"fake" in
let s_ml_runtime = None in
let s_ml_runtime_mli = None in
let s_opa_code = [] in
let s_opa_interface = [] in
let session = {
s_options ;
s_pprocess ;
s_depends ;
s_identification ;
s_conf ;
s_js_confs ;
s_nodejs_conf ;
s_marshal_plugin_s ;
s_ml_dynloader_plugin ;
s_ml_dynloader_loader ;
s_rev_js_parsed_files ;
s_rev_nodejs_parsed_files ;
s_rev_ml_parsed_files ;
s_rev_opa_decorated_files ;
s_has_server_code ;
s_rp_calls ;
s_rt_calls ;
s_js_pack ;
s_nodejs_pack ;
s_ml_runtime ;
s_ml_runtime_mli ;
s_opa_code ;
s_opa_interface ;
}
in
check_session session
let set_pprocess ~pprocess session =
{ session with s_pprocess = pprocess }
(*
Registering
*)
(*
Note
The goal there is that from the plugin, it should be possible to get exactly
to the same point as there, with the same calls to the RegisterInterface now,
later when somebody will dynload the plugin.
A way of doing that, is to have the strict same interface for the 3 register_*
The register of this module returns the session.
CF
+ BslPluginInterface.register_*
*)
(*
Collecting calls.
*)
let compute_skey ks = String.concat_map "_" BslKey.normalize_string ks
let warning_set = WarningClass.Set.create_from_list [
WarningClass.bsl_register ;
]
let warning fmt = OManager.warning ~wclass:WarningClass.bsl_register fmt
let equal_ks ks ks' =
let c = List.make_compare String.compare ks ks' in
c = 0
let pp_ks fmt ks = Format.pp_list "." Format.pp_print_string fmt ks
(*
Note for hackers:
This function is quite verbose, because there are a lot of error cases to detect.
if --check-style is set, warning of the class bsl.register will be set to --warn-error.
For citation, plugins file are no more available, so it makes not any sence to print
citation for types from plugins. For the types of the current session, the citation
is available.
*)
let register_type session ~ks ~ty =
let _ =
#<If:BSL_REGISTER $equals "2">
debug "register-type: ks:[%a] ty:(%a)@\n" (Format.pp_list " ; " (fun f -> Format.fprintf f "%S") ) ks BslTypes.pp ty
#<End>
in
let s_rt_calls = session.s_rt_calls in
let depends_typesmap = BSL.ByPassMap.typesmap session.s_depends.d_bymap in
let skey = compute_skey ks in
let key = BslKey.normalize skey in
let pos = BslTypes.pos ty in
(* rt_call will be an option of rt_call, to know if there is something to collect or not *)
let rt_call =
(* check coherence with --use-plugin *)
match BslKeyMap.find_opt key depends_typesmap with
| Some (_, plugin_ks, plugin_ty) ->
if equal_ks ks plugin_ks
then (
(* checking the type *)
if (BslTypes.compare ~normalize:true ty plugin_ty) <> 0
then (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "%a@\nThis type is already defined in a used plugin: @{<bright>%a@}@\n"
FilePos.pp_pos (BslTypes.pos plugin_ty) BslTypes.pp plugin_ty ;
OManager.error "##extern-type: @{<bright>conflicting type definitions@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
)
else (
warning "@\n%aA used plugin already defines this type.@ You should avoid this kind of practice.@\n##extern-type: @{<bright>type redefinition@} for key '@{<brigth>%a@}'@\n"
FilePos.pp_citation pos BslKey.pp key ;
None (* in this case, we do not redefine the type *)
)
)
else (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "One of the used plugin contains a declaration of@ an extern-type with the same key@ but with a different module-path.@\nThe module-path in your lib is @{<bright>%a@},@ in the plugin the module-path is @{<bright>%a@}.@\n"
pp_ks ks pp_ks plugin_ks
;
OManager.error "##extern-type: @{<bright>module-path mismatch@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
)
| None -> (
(* Check if the type is already defined in an other file of the current session *)
(* It is almost the same erros, but more restrictive *)
match BslKeyMap.find_opt key s_rt_calls with
| Some ( { c_rt_ks = c_rt_ks ; c_rt_ty = c_rt_ty } as rt_call ) ->
let pos = FilePos.merge_pos pos (BslTypes.pos c_rt_ty) in
if equal_ks ks c_rt_ks then (
(* checking the type *)
if (BslTypes.compare ~normalize:true ty c_rt_ty) <> 0
then (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.error "##extern-type: @{<bright>conflicting type definitions@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
);
let c_rt_ty = BslTypes.reset_pos c_rt_ty pos in
Some {
rt_call with
c_rt_ty = c_rt_ty
}
)
else (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "There are 2 extern-type definitions with the same key@ but with a different module-path.@\nThe first module-path is @{<bright>%a@},@ and the second is @{<bright>%a@}.@\n"
pp_ks ks pp_ks c_rt_ks
;
OManager.error "##extern-type: @{<bright>module-path mismatch@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
)
| None ->
(* This is the first time this type is defined, collect it *)
Some { c_rt_ks = ks ; c_rt_ty = ty }
)
in
let session =
match rt_call with
| None -> session
| Some rt_call ->
let s_rt_calls = BslKeyMap.add key rt_call s_rt_calls in
{
session with
s_rt_calls = s_rt_calls
}
in
session
let register_primitive session ~ks ~ty ~ips ?obj:_ () =
let _ =
#<If:BSL_REGISTER $equals "3">
debug "register-primitive: ks:[%a] ty:(%a)@\n" (Format.pp_list "." Format.pp_print_string) ks BslTypes.pp ty
#<End>
in
let s_rp_calls = session.s_rp_calls in
let depends_bymap = session.s_depends.d_bymap in
let skey = compute_skey ks in
let key = BslKey.normalize skey in
let pos = BslTypes.pos ty in
(* rt_call will be an option of rt_call, to know if there is something to collect or not *)
let rp_call =
(* check coherence with --use-plugin *)
match BSL.ByPassMap.find_opt depends_bymap key with
| Some bypass ->
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "@[<2>A primitive with the same key is already defined@ in a used plugin@\n%a@]@\n"
(Format.pp_list "@, " BSL.Implementation.pp) (BSL.ByPass.all_implementations bypass) ;
OManager.error "##register: @{<bright>primitive re-definition@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
| None -> (
match BslKeyMap.find_opt key s_rp_calls with
| Some rp_call -> (
let c_rp_ks = rp_call.c_rp_ks in
let c_rp_ty = rp_call.c_rp_ty in
let c_rp_ips = rp_call.c_rp_ips in
let c_rp_obj = rp_call.c_rp_obj in
let pos = FilePos.merge_pos pos (BslTypes.pos c_rp_ty) in
if equal_ks ks c_rp_ks then (
(* checking the type *)
(* We do not take opa value declarations into account *)
let purged_ty = BslTypes.purge_opavalue ty in
if (BslTypes.compare ~normalize:true purged_ty c_rp_ty) <> 0
then (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.error "##register: @{<bright>conflicting primitive definitions@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
);
(* merge pos in ty. BslTypes.reset_pos, pos is already the merged pos *)
(* TODO: merge type variables names, or keep the one from Ocaml *)
let c_rp_ty = BslTypes.reset_pos c_rp_ty pos in
let c_rp_ips = List.fold_left
(fun c_rp_ips (lang, filename, parsed_t, type_, implementation) ->
(* redefinition in the same language is not allowed *)
match BslLanguageMap.find_opt lang c_rp_ips with
| Some _ -> (
(* When this primitive was registred the first time, its position was merged *)
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "This primitive is already defined in %a@\n" BslLanguage.pp lang;
OManager.error "##register: @{<bright>multiple primitive definitions@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
)
| None ->
let rp_impl = {
c_rpi_filename = filename ;
c_rpi_tags = parsed_t ;
c_rpi_type = type_ ;
c_rpi_implementation = implementation ;
}
in
BslLanguageMap.add lang rp_impl c_rp_ips
) c_rp_ips ips
in
let c_rp_obj =
match c_rp_obj with
| Some _ -> c_rp_obj
| None ->
List.find_map
(fun (ml, _, _, _, imp) -> if BslLanguage.is_ml ml then Some imp else None) ips
in
let rp_call = {
rp_call with
c_rp_ty = c_rp_ty ;
c_rp_ips = c_rp_ips ;
c_rp_obj = c_rp_obj ;
}
in
Some rp_call
)
else (
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.printf "There are 2 primitive definitions with the same key@ but with a different module-path.@\nThe first module-path is @{<bright>%a@},@ and the second is @{<bright>%a@}.@\n"
pp_ks ks pp_ks c_rp_ks
;
OManager.error "##register: @{<bright>module-path mismatch@} for key '@{<brigth>%a@}'@\n" BslKey.pp key
)
)
| None ->
(* This is the first time this primitive is defined, collect it *)
let c_rp_obj = List.find_map
(fun (ml, _, _, _, imp) -> if BslLanguage.is_ml ml then Some imp else None) ips
in
let c_rp_ips = List.fold_left
(fun c_rp_ips (lang, filename, parsed_t, type_, implementation) ->
let rp_impl = {
c_rpi_filename = filename ;
c_rpi_tags = parsed_t ;
c_rpi_type = type_ ;
c_rpi_implementation = implementation ;
}
in
BslLanguageMap.add lang rp_impl c_rp_ips
) BslLanguageMap.empty ips
in
let rp_call = {
c_rp_ks = ks ;
c_rp_ty = BslTypes.purge_opavalue ty ;
c_rp_ips = c_rp_ips ;
c_rp_obj = c_rp_obj ;
}
in
Some rp_call
)
in
let session =
match rp_call with
| None -> session
| Some rp_call ->
let s_rp_calls = BslKeyMap.add key rp_call s_rp_calls in
{
session with
s_rp_calls = s_rp_calls
}
in
session
(*
The finalized_t
*)
type finalized_t = {
f_options : BI.options ;
f_marshal_plugin_t : BMP.t ;
(* loader | plugin *)
f_plugin_up : FBuffer.t ; (* X | X *)
f_ml_dynloader_loader : FBuffer.t ; (* X | *)
f_ml_dynloader_plugin : FBuffer.t ; (* | X *)
f_js_keys : FBuffer.t ;
f_ml_runtime : FBuffer.t option ;
f_ml_runtime_mli : FBuffer.t option ;
f_js_pack : JsPackage.t ;
f_nodejs_pack : JsPackage.t ;
f_opa_code : (filename * contents) list ;
f_opa_interface : (filename * contents) list ;
}
(* Finalize *)
(*
Effective calls, at the end (finalization)
*)
let f_register_types session =
let fold_session _ rt_call session =
let ks = rt_call.c_rt_ks in
let ty = rt_call.c_rt_ty in
let bmp_s = session.s_marshal_plugin_s in
let _side_effect =
try
BMP.unsafe_register_type bmp_s ~ks ~ty ;
BRI.unsafe_register_type ~ks ~ty ;
()
with
| BRI.RegisterError error -> (
(* pos : the pos of ty has merged the pos in all languages *)
let pos = BslTypes.pos ty in
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.error "%a@\n" BRI.pp_error error
)
in
(* complete the buffer of call to BP *)
let s_ml_dynloader_loader = session.s_ml_dynloader_loader in
let s_ml_dynloader_plugin = session.s_ml_dynloader_plugin in
let s_ml_dynloader_loader =
BPI.meta_register_type s_ml_dynloader_loader ~ks ~ty
in
let s_ml_dynloader_plugin =
BPI.meta_register_type s_ml_dynloader_plugin ~ks ~ty
in
{
session with
s_ml_dynloader_loader = s_ml_dynloader_loader ;
s_ml_dynloader_plugin = s_ml_dynloader_plugin ;
}
in
let session = BslKeyMap.fold fold_session session.s_rt_calls session in
session
let f_collecting_rp_ips c_rp_ips =
let fold lang rp_impl acc =
let filename = rp_impl.c_rpi_filename in
let tags = rp_impl.c_rpi_tags in
let type_ = rp_impl.c_rpi_type in
let implementation = rp_impl.c_rpi_implementation in
let item =
lang, filename, tags, type_, implementation
in
item :: acc
in
let ips = BslLanguageMap.fold fold c_rp_ips [] in
ips
let f_register_primitives session =
let fold_session _ rp_call session =
let ks = rp_call.c_rp_ks in
let ty = rp_call.c_rp_ty in
let c_rp_ips = rp_call.c_rp_ips in
let obj = rp_call.c_rp_obj in
(* ips should now be transformed into a list (cf BPI) *)
let ips = f_collecting_rp_ips c_rp_ips in
let bmp_s = session.s_marshal_plugin_s in
let _side_effect =
try
BMP.unsafe_register_primitive bmp_s ~ks ~ty ~ips () ;
BRI.unsafe_register_primitive ~ks ~ty ~ips () ;
()
with
| BRI.RegisterError error -> (
(* pos : the pos of ty has merged the pos in all languages *)
let pos = BslTypes.pos ty in
OManager.printf "%a" FilePos.pp_citation pos ;
OManager.error "%a@\n" BRI.pp_error error
)
in
(* complete the buffer of call to BP *)
let s_ml_dynloader_loader = session.s_ml_dynloader_loader in
let s_ml_dynloader_plugin = session.s_ml_dynloader_plugin in
let s_ml_dynloader_loader =
BPI.meta_register_primitive s_ml_dynloader_loader ~ks ~ty ~ips ?obj () ;
in
let s_ml_dynloader_plugin =
BPI.meta_register_primitive s_ml_dynloader_plugin ~ks ~ty ~ips () ;
in
{
session with
s_ml_dynloader_loader = s_ml_dynloader_loader ;
s_ml_dynloader_plugin = s_ml_dynloader_plugin ;
}
in
let session = BslKeyMap.fold fold_session session.s_rp_calls session in
session
let finalizing_register_calls session =
ignore (BRI.register
~uniq_id:session.s_identification.i_uniq_id
~plugin_name:session.s_identification.i_basename);
let session = f_register_types session in
let session = f_register_primitives session in
session
let f_plugin_up ~conf ~ocaml_env ~javascript_env s =
let s_identification = s.s_identification in
let basename = s_identification.i_basename in
let basename = Option.default "" basename in
let self_module_name = s_identification.i_ml_plugin in
let uniq_id = s_identification.i_uniq_id in
let ml_runtime = s_identification.i_ml_runtime in
let depends = s.s_depends.d_parents in
let js_pack = s.s_js_pack in
let nodejs_pack = s.s_nodejs_pack in
let has_server_code = s.s_has_server_code in
let opa_code = s.s_opa_code in
let buf = FBuffer.create 1024 in
let buf =
BPI.meta_plugin__01
buf
~basename
~self_module_name
~uniq_id
~conf
~ml_runtime
~depends
~js_pack
~nodejs_pack
~has_server_code
~opa_code
~ocaml_env
~javascript_env
in
buf
let finalizing_opa ~final_bymap s =
let s_opa_code =
List.rev_map (BslOpa.preprocess ~final_bymap) s.s_rev_opa_decorated_files in
let s_opa_code =
List.map (fun (f, b) -> (f, FBuffer.contents b)) s_opa_code in
(*
Syntax check, and Type checking.
*)
let s_opa_interface =
let true_means_error, s_opa_interface =
BslOpa.checking_fail ~final_bymap s_opa_code in
if true_means_error && not s.s_options.BI.unsafe_opa then
OManager.error "Process stopped because of errors in the Opa code@\n"
;
s_opa_interface
in
let s_opa_interface =
List.map (fun (f, b) -> (f, FBuffer.contents b)) s_opa_interface in
{ s
with
s_opa_code = s_opa_code ;
s_opa_interface = s_opa_interface ;
}
let make_imperative_dynloader_interface session =
let session = ref session in
let register_type ~ks ~ty =
let s = register_type !session ~ks ~ty in
session := s
in
let register_primitive ~ks ~ty ~ips ?obj () =
let s = register_primitive !session ~ks ~ty ~ips ?obj () in
session := s
in
let dynloader_interface = {
BPI.register_type = register_type ;
BPI.register_primitive = register_primitive ;
}
in session, dynloader_interface
let finalizing_ocaml session =
let options = session.s_options in
let plugins = session.s_depends.d_plugins in
let ml_decorated_files = List.rev session.s_rev_ml_parsed_files in
let session_ref, dynloader_interface =
make_imperative_dynloader_interface session
in
let ocaml_env, s_ml_runtime, s_ml_runtime_mli =
BslOcaml.preprocess ~options ~plugins ~dynloader_interface ml_decorated_files
in
ocaml_env,
{ !session_ref
with
s_ml_runtime ;
s_ml_runtime_mli ;
}
let finalizing_js_code_conf s_js_confs s_rev_js_parsed_files =
let confs = BslJsConf.export s_js_confs in
let map {BslJs. filename; _} =
let index = filename in
match StringMap.find_opt index confs with
| Some conf -> filename, conf
| None ->
(*
Internal error, the list of given js files was not correct
*)
assert false
in
List.map map s_rev_js_parsed_files
let collect_exports bymap nodejs_code =
(* HACK: In compiled NodeJs code, we have to refer to bypasses by
their keys, and not by their compiler representation. This
happens because when the bypass is an alias to an identifier we
don't know if that identifier is plugin-local (in which case
client modules cannot refer to it directly) or a global one (in
which case it cannot be found in the plugin exports). Thus, we
need to export all such bypasses to their compiled
representations using the bsl key as the identifier, since at
this point the compiler representation still makes sense *)
let module BPM = BSL.ByPassMap in
let module I = BSL.Implementation in
let module CF = I.CompiledFunction in
let exports = BPM.fold (fun key bypass exports ->
let nodejs_impl =
BSL.ByPass.compiled_implementation bypass
~lang:BslLanguage.nodejs in
match nodejs_impl with
| Some compiled ->
let rhs = JsCons.Expr.native (CF.compiler_repr compiled) in
let export =
JsCons.Statement.assign
(JsCons.Expr.dot
(JsCons.Expr.native "exports")
(BslKey.to_string key))
rhs in
export :: exports
| None -> exports
) bymap []
in
let exports = Format.to_string JsPrint.pp_min#code exports in
nodejs_code @ [("exports", exports, BslJsConf.default)]
let js_error_after_pp filename contents message =
ignore (File.output "jserror.js" contents);
OManager.error
("Couldn't parse file @{<brigth>%s@} after preprocessing\n"^^
"Take a look on generated file @{<brigth>jserror.js@}\n%!" ^^
"Error: %s")
filename message
let export_to_global_namespace nodejs_code =
(* When not exporting identifiers as modules, we need to export them
globally *)