adds support for loading plugins in toplevels

Uses virtual libraries to select the proper dynamic linker facility. To load in the toplevel add `dune-site.toplevel` library as the dependency to your toplevel. Signed-off-by: ivg <[email protected]> Signed-off-by: Richard L Ford <[email protected]>
ocaml · Mar 6, 2023 · c5ea567 · c5ea567
1 parent a65ba82
commit c5ea567
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 2 deletions.
diff --git a/otherlibs/site/src/plugins/dune b/otherlibs/site/src/plugins/dune
@@ -6,6 +6,6 @@
   (dune_site
    (plugins)
    (data_module dune_site_plugins_data)))
- (libraries dune-site dune-private-libs.meta_parser dynlink)
+ (libraries dune-site dune-private-libs.meta_parser dune-site.linker)
  (instrumentation
   (backend bisect_ppx)))
diff --git a/otherlibs/site/src/plugins/linker/dune b/otherlibs/site/src/plugins/linker/dune
@@ -0,0 +1,5 @@
+(library
+ (name dune_site_backend)
+ (public_name dune-site.linker)
+ (virtual_modules linker)
+ (default_implementation dune-site.dynlink))
diff --git a/otherlibs/site/src/plugins/linker/dynlink/dune b/otherlibs/site/src/plugins/linker/dynlink/dune
@@ -0,0 +1,5 @@
+(library
+ (name dune_site_dynlink_linker)
+ (public_name dune-site.dynlink)
+ (implements dune-site.linker)
+ (libraries dynlink))
diff --git a/otherlibs/site/src/plugins/linker/dynlink/linker.ml b/otherlibs/site/src/plugins/linker/dynlink/linker.ml
@@ -0,0 +1 @@
+let load = Dynlink.loadfile
diff --git a/otherlibs/site/src/plugins/linker/linker.mli b/otherlibs/site/src/plugins/linker/linker.mli
@@ -0,0 +1 @@
+val load : string -> unit
diff --git a/otherlibs/site/src/plugins/linker/toplevel/dune b/otherlibs/site/src/plugins/linker/toplevel/dune
@@ -0,0 +1,6 @@
+(library
+ (name dune_site_toplevel_linker)
+ (modes byte)
+ (public_name dune-site.toplevel)
+ (implements dune-site.linker)
+ (libraries compiler-libs.toplevel))
diff --git a/otherlibs/site/src/plugins/linker/toplevel/linker.ml b/otherlibs/site/src/plugins/linker/toplevel/linker.ml
@@ -0,0 +1,10 @@
+let load filename =
+  let buf = Buffer.create 16 in
+  let ppf = Format.formatter_of_buffer buf in
+  match Toploop.load_file ppf filename with
+  | true -> ()
+  | false ->
+    Format.pp_print_flush ppf ();
+    failwith
+    @@ Format.asprintf "Failed to load file `%s': %s" filename
+         (Buffer.contents buf)
diff --git a/otherlibs/site/src/plugins/plugins.ml b/otherlibs/site/src/plugins/plugins.ml
@@ -256,7 +256,7 @@ let load_gen ~load_requires dirs name =
     List.iter
       (fun p ->
         let file = Filename.concat directory p in
-        Dynlink.loadfile file)
+        Dune_site_backend.Linker.load file)
       plugins)
 
 let rec load_requires name =