jsoo-top-wrapped

toplevel/lib/js_of_ocaml_toplevel.ml

@@ -18,3 +18,5 @@
  *)
 
 module JsooTop = JsooTop
+module JsooTopWrapped = JsooTopWrapped
+module JsooTopIntf = JsooTopIntf

toplevel/lib/jsooTopIntf.ml

@@ -0,0 +1,107 @@
+(* Js_of_ocaml library
+ * http://www.ocsigen.org/js_of_ocaml/
+ * Copyright (C) 2016 OCamlPro
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Library General Public License as published by
+ * the Free Software Foundation, with linking exception;
+ * either version 2.1 of the License, or (at your option) any later version.
+ *
+ * This program 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 Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *)
+
+module type Wrapped = sig
+  type toplevel
+
+  type 'a result
+
+  type output
+
+  val check : toplevel -> ?setenv:bool -> string -> unit result
+  (** Parse and typecheck a given source code
+
+      @param setenv should the resulting environment replace the current
+                    environment ?
+
+      @return [Success ()] in case of success and [Error err]
+              where [err] contains the error message otherwise.
+
+  *)
+
+  val execute :
+       toplevel
+    -> ?ppf_code:output
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> string
+    -> bool result
+  (** Execute a given source code. The evaluation stops after the first
+      toplevel phrase (as terminated by ";;") that fails to compile or
+      for which the evaluation raises an uncaught exception.
+
+      @param ppf_code a formatter were the source code will be printed
+             before its execution. The printing might be interleaved
+             with call to "pp_answer" when a line finishes by ";;".
+
+      @param ppf_answer a formatter were the compiler outputs will be
+             printed.
+
+      @param print_outcome should the toplevel print the computed
+             values and their types ?
+
+      @return [Error err] when parsing or typechecking failed, where
+              [err] contains the error message. It returns [Success true]
+              when the code evaluation finished without uncaught
+              exception, and [Success false] otherwise.
+  *)
+
+  val use_string :
+       toplevel
+    -> ?filename:string
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> string
+    -> bool result
+  (** Execute a given source code. The code is parsed and
+      typechecked all at once before to start the evalution.
+
+      @param filename a faked filename which will be used in error messages
+
+      @param ppf_answer see {!val:execute}.
+
+      @param print_outcome see {!val:execute}.
+
+      @return as {!val:execute}.
+
+  *)
+
+  val use_mod_string :
+       toplevel
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> modname:string
+    -> ?sig_code:string
+    -> string
+    -> bool result
+  (** Wrap a given source code into a module and bind it with a given name.
+
+      @param print_outcome see {!val:execute}.
+
+      @param ppf_answer see {!val:execute}.
+
+      @param modname the module name, it must start with a capital
+             character.
+
+      @param sig_code source code for the module signature.
+
+      @return as {!val:execute}.
+
+  *)
+end

toplevel/lib/jsooTopIntf.mli

@@ -0,0 +1,107 @@
+(* Js_of_ocaml library
+ * http://www.ocsigen.org/js_of_ocaml/
+ * Copyright (C) 2016 OCamlPro
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Library General Public License as published by
+ * the Free Software Foundation, with linking exception;
+ * either version 2.1 of the License, or (at your option) any later version.
+ *
+ * This program 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 Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *)
+
+module type Wrapped = sig
+  type toplevel
+
+  type 'a result
+
+  type output
+
+  val check : toplevel -> ?setenv:bool -> string -> unit result
+  (** Parse and typecheck a given source code
+
+      @param setenv should the resulting environment replace the current
+                    environment ?
+
+      @return [Success ()] in case of success and [Error err]
+              where [err] contains the error message otherwise.
+
+  *)
+
+  val execute :
+       toplevel
+    -> ?ppf_code:output
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> string
+    -> bool result
+  (** Execute a given source code. The evaluation stops after the first
+      toplevel phrase (as terminated by ";;") that fails to compile or
+      for which the evaluation raises an uncaught exception.
+
+      @param ppf_code a formatter were the source code will be printed
+             before its execution. The printing might be interleaved
+             with call to "pp_answer" when a line finishes by ";;".
+
+      @param ppf_answer a formatter were the compiler outputs will be
+             printed.
+
+      @param print_outcome should the toplevel print the computed
+             values and their types ?
+
+      @return [Error err] when parsing or typechecking failed, where
+              [err] contains the error message. It returns [Success true]
+              when the code evaluation finished without uncaught
+              exception, and [Success false] otherwise.
+  *)
+
+  val use_string :
+       toplevel
+    -> ?filename:string
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> string
+    -> bool result
+  (** Execute a given source code. The code is parsed and
+      typechecked all at once before to start the evalution.
+
+      @param filename a faked filename which will be used in error messages
+
+      @param ppf_answer see {!val:execute}.
+
+      @param print_outcome see {!val:execute}.
+
+      @return as {!val:execute}.
+
+  *)
+
+  val use_mod_string :
+       toplevel
+    -> ?print_outcome:bool
+    -> ppf_answer:output
+    -> modname:string
+    -> ?sig_code:string
+    -> string
+    -> bool result
+  (** Wrap a given source code into a module and bind it with a given name.
+
+      @param print_outcome see {!val:execute}.
+
+      @param ppf_answer see {!val:execute}.
+
+      @param modname the module name, it must start with a capital
+             character.
+
+      @param sig_code source code for the module signature.
+
+      @return as {!val:execute}.
+
+  *)
+end