unikernel/duniverse/mirage/lib/functoria/engine.mli

@@ -0,0 +1,56 @@
+(*
+ * Copyright (c) 2013-2020 Thomas Gazagnaire <thomas@gazagnaire.org>
+ * Copyright (c) 2013-2020 Anil Madhavapeddy <anil@recoil.org>
+ * Copyright (c) 2015-2020 Gabriel Radanne <drupyog@zoho.com>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *)
+
+(** Functoria engine. *)
+
+val if_keys : Impl.abstract -> Key.Set.t
+(** [if_keys t] is the set of [if] keys in the graph [t]. *)
+
+val keys : Impl.abstract -> Key.Set.t
+(** [keys t] is the set of keys in the graph [t]. *)
+
+val runtime_args : Impl.abstract -> Runtime_arg.Set.t
+(** [runtime_args t] is the set of runtime arguments in the graph [t]. *)
+
+val packages : Impl.abstract -> Package.t list Key.value
+(** [packages t] is the set of packages in the graph [t]. *)
+
+val install : Info.t -> Impl.abstract -> Install.t Key.value
+(** [install i t] is the set of files installed by the graph [t]. *)
+
+val files : Info.t -> Impl.abstract -> Fpath.Set.t
+(** [files i t] is the list of files generated configure-time. *)
+
+val dune : Info.t -> Impl.abstract -> Dune.stanza list
+(** [dune i t] is the list of dune stanzas needed to build the project [t] with
+    the build information [i]. *)
+
+(** {2 Triggering Hooks} *)
+
+type t = Device.Graph.t
+(** The type for key graphs. *)
+
+val configure : Info.t -> t -> unit Action.t
+(** [configure i t] calls all the configuration hooks for each of the
+    implementations appearing in [t], in topological order. Use the build
+    information [i]. *)
+
+val connect : ?init:'a Impl.t list -> Info.t -> t -> unit Action.t
+(** [connect ?init i t] generates the [connect] functions in [main.ml], for each
+    of the implementations appearing [t], in topological order. Use build
+    information [i]. *)