@tellahq/rescript 10.1.4-republish-2 → 10.1.4-republish-3

package/lib/ocaml/node_fs.ml

@@ -0,0 +1,153 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser 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. *)
+
+(**
+  Node FS API
+*)
+
+(**
+  Most fs functions let you omit the callback argument. If you do, a default
+  callback is used that rethrows errors. To get a trace to the original call
+  site, set the `NODE_DEBUG` environment variable:
+*)
+external readdirSync : string -> string array  = "readdirSync" [@@bs.module "fs"]
+
+external renameSync : string -> string -> unit = "renameSync" [@@bs.module "fs"]
+
+type fd = private int
+
+type path = string
+(**
+  The relative path to a filename can be used. Remember, however, that this path
+  will be relative to `process.cwd()`.
+*)
+
+module Watch = struct
+  type t
+  type config
+  external config :
+    ?persistent: bool ->
+    ?recursive: bool ->
+    ?encoding: Js_string.t ->
+    unit -> config =
+    "" [@@bs.obj]
+
+  external watch :
+    string ->
+    ?config:config ->
+    unit ->
+    t = "watch"
+  [@@bs.module "fs"]
+  (**
+    there is no need to accept listener, since we return a `watcher`
+    back it can register event listener there .
+    Currently we introduce a type `string_buffer`, for the
+    `filename`, it will be `Buffer` when the encoding is `utf8.
+    This is dependent type which can be tracked by GADT in some way,
+    but to make things simple, let's just introduce an or type
+  *)
+
+
+  external on_ :
+    t ->
+    ([
+      `change of (string (*eventType*) -> Node.string_buffer (* filename *) -> unit  [@bs])
+    | `error of (unit -> unit [@bs])
+    ] [@bs.string]
+    ) ->
+    t = "on"
+    [@@bs.send]
+  external close :  t -> unit = "close" [@@bs.send]
+end
+
+external ftruncateSync : fd -> int -> unit = "ftruncateSync" [@@bs.module "fs"]
+
+external truncateSync : string -> int -> unit = "truncateSync" [@@bs.module "fs"]
+
+external chownSync : string -> uid:int -> gid:int -> unit = "chownSync" [@@bs.module "fs"]
+
+external fchownSync : fd -> uid:int -> gid:int -> unit = "fchownSync" [@@bs.module "fs"]
+
+external readlinkSync : string -> string  = "readlinkSync" [@@bs.module "fs"]
+
+external unlinkSync : string -> unit  = "unlinkSync" [@@bs.module "fs"]
+
+external rmdirSync : string -> unit = "rmdirSync"  [@@bs.module "fs"]
+
+(* TODO: `flags` support *)
+external openSync :
+  path ->
+  (
+    [ `Read [@bs.as "r"]
+    | `Read_write [@bs.as "r+"]
+    | `Read_write_sync [@bs.as "rs+"]
+    | `Write [@bs.as "w"]
+    | `Write_fail_if_exists [@bs.as "wx"]
+    | `Write_read [@bs.as "w+"]
+    | `Write_read_fail_if_exists [@bs.as "wx+"]
+    | `Append [@bs.as "a"]
+    | `Append_fail_if_exists [@bs.as "ax"]
+    | `Append_read [@bs.as "a+"]
+    | `Append_read_fail_if_exists [@bs.as "ax+"]
+    ] [@bs.string]) ->
+  unit = "openSync"  [@@bs.module "fs"]
+
+type encoding =
+  [
+    `hex
+  | `utf8
+  | `ascii
+  | `latin1
+  | `base64
+  | `ucs2
+  | `base64
+  | `binary
+  | `utf16le ]
+external readFileSync :
+  string ->
+  encoding ->
+  string = "readFileSync"
+[@@bs.val] [@@bs.module "fs"]
+
+external readFileAsUtf8Sync :
+  string -> (_[@bs.as "utf8"]) ->
+  string = "readFileSync"
+[@@bs.val] [@@bs.module "fs"]
+
+external existsSync : string -> bool = "existsSync"
+[@@bs.val] [@@bs.module "fs"]
+
+external writeFileSync :
+  string ->
+  string ->
+  encoding ->
+  unit = "writeFileSync"
+[@@bs.val] [@@bs.module "fs"]
+
+external writeFileAsUtf8Sync :
+  string ->
+  string ->
+  (_[@bs.as "utf8"]) ->
+  unit = "writeFileSync"
+[@@bs.val] [@@bs.module "fs"]

package/lib/ocaml/node_module.ml

@@ -0,0 +1,29 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a 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 Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser 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. *)
+
+(** Node Module API *)
+
+external module_ :
+  < __cache : Node.node_module Js_dict.t  > 
+    = "module" [@@bs.val]

package/lib/ocaml/node_path.ml

@@ -0,0 +1,71 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a 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 Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser 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. *)
+
+(** Node Path API *)
+
+external basename : string -> string = "basename" [@@bs.module "path"]
+external basename_ext : string -> string -> string  =
+  "basename" [@@bs.module "path"]
+
+external delimiter : string = "delimiter" [@@bs.module "path"]
+
+external dirname : string -> string = "dirname" [@@bs.module "path"]
+
+external dirname_ext : string -> string -> string = "dirname" [@@bs.module "path"]
+
+type pathObject =
+  <
+    dir : string ;
+    root : string ;
+    base : string ;
+    name : string ;
+    ext : string          
+  >   
+  
+external format : pathObject -> string = "format" [@@bs.module "path"]
+
+external isAbsolute : string -> bool = "isAbsolute" [@@bs.module "path"]
+
+(* TODO: improve after we support [@bs.rest] calling convention  *)
+external join2 : string -> string -> string = "join" [@@bs.module "path"]
+
+external join : string array -> string = "join" 
+[@@bs.module "path"]  [@@bs.splice]
+   
+external normalize : string -> string = "normalize" [@@bs.module "path"]
+
+(* TODO: check if there is an exception raised *)
+external parse : string -> pathObject = "parse" [@@bs.module "path"]
+
+(* TODO: provide bindings to `path.posix`*)
+
+external relative : from:string -> to_:string -> unit -> string =
+  "relative" [@@bs.module "path"]
+
+(* TODO: improve after rest calling convention *)
+external resolve : string -> string -> string = "resolve" [@@bs.module "path"]
+
+external sep : string = "sep" [@@bs.module "path"]
+
+(* TODO: provides `path.win32` *)

package/lib/ocaml/node_process.ml

@@ -0,0 +1,59 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser 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. *)
+
+(** Node Process API *)
+
+type t =
+  < argv : string array;
+    arch : string ;
+    abort : unit -> unit [@bs.meth];
+    chdir : string -> unit [@bs.meth];
+    cwd : unit -> string [@bs.meth];
+    disconnect : unit -> unit [@bs.meth];
+    platform : string;
+    env : string Js_dict.t; (* ocamldep sucks which can not map `Js.Dic.t` to `Js_dict.t`*)
+  >
+
+external process : t = "process" [@@bs.module]
+external argv : string array = "argv" [@@bs.module "process"]
+external exit : int -> 'a = "exit" [@@bs.module "process"]
+external cwd : unit -> string = "cwd" [@@bs.module "process"]
+
+(**
+  The process.uptime() method returns the number of seconds
+  the current Node.js process has been running.)
+*)
+external uptime : t -> unit -> float = "uptime" [@@bs.send]
+
+let putEnvVar key (var : string) =
+  Js_dict.set process##env key var
+(**
+  Note that
+  `process.env.X = undefined` will result in
+  `process.env.X = "undefined"`
+  The only sane way to do it is using `delete`
+*)
+
+let deleteEnvVar   s  =
+  Js_dict.unsafeDeleteKey process##env s  [@bs]

package/lib/ocaml/node_process.mli

@@ -0,0 +1,48 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser 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. *)
+
+
+type t =
+  < argv : string array;
+    arch : string ;
+    abort : unit -> unit [@bs.meth];
+    chdir : string -> unit [@bs.meth];
+    cwd : unit -> string [@bs.meth];
+    disconnect : unit -> unit [@bs.meth];
+    platform : string;
+    env : string Js_dict.t; (* ocamldep sucks which can not map `Js.Dic.t` to `Js_dict.t`*)
+  >
+(* FIXME : use record *)
+
+external process : t = "process" [@@bs.module]
+external argv : string array = "argv" [@@bs.module "process"]
+external exit : int -> 'a = "exit" [@@bs.module "process"]
+external cwd : unit -> string = "cwd" [@@bs.module "process"]
+
+(** The process.uptime() method returns the number of seconds
+    the current Node.js process has been running.) *)
+external uptime : t -> unit -> float = "uptime" [@@bs.send]
+
+val putEnvVar : string -> string -> unit
+val deleteEnvVar : string -> unit

package/lib/ocaml/obj.ml

@@ -0,0 +1,29 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                                 OCaml                                  *)
+(*                                                                        *)
+(*             Xavier Leroy, projet Cristal, INRIA Rocquencourt           *)
+(*                                                                        *)
+(*   Copyright 1996 Institut National de Recherche en Informatique et     *)
+(*     en Automatique.                                                    *)
+(*                                                                        *)
+(*   All rights reserved.  This file is distributed under the terms of    *)
+(*   the GNU Lesser General Public License version 2.1, with the          *)
+(*   special exception on linking described in the file LICENSE.          *)
+(*                                                                        *)
+(**************************************************************************)
+
+(* Operations on internal representations of values *)
+
+type t
+
+external repr : 'a -> t = "%identity"
+external obj : t -> 'a = "%identity"
+external magic : 'a -> 'b = "%identity"
+external is_int : t -> bool = "%obj_is_int"
+let [@inline always] is_block a = not (is_int a)
+external tag : t -> int = "?obj_tag"
+external size : t -> int = "#obj_length"
+external field : t -> int -> t = "%obj_field"
+external set_field : t -> int -> t -> unit = "%obj_set_field" 
+external dup : t -> t = "?obj_dup"

package/lib/ocaml/obj.mli

@@ -0,0 +1,62 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                                 OCaml                                  *)
+(*                                                                        *)
+(*             Xavier Leroy, projet Cristal, INRIA Rocquencourt           *)
+(*                                                                        *)
+(*   Copyright 1996 Institut National de Recherche en Informatique et     *)
+(*     en Automatique.                                                    *)
+(*                                                                        *)
+(*   All rights reserved.  This file is distributed under the terms of    *)
+(*   the GNU Lesser General Public License version 2.1, with the          *)
+(*   special exception on linking described in the file LICENSE.          *)
+(*                                                                        *)
+(**************************************************************************)
+
+(** Operations on internal representations of values.
+
+   Not for the casual user.
+*)
+
+type t
+
+external repr : 'a -> t = "%identity"
+external obj : t -> 'a = "%identity"
+external magic : 'a -> 'b = "%identity"
+val [@inline always] is_block : t -> bool
+
+external tag : t -> int = "?obj_tag"
+external size : t -> int = "#obj_length"
+
+  (**
+     Computes the total size (in words, including the headers) of all
+     heap blocks accessible from the argument.  Statically
+     allocated blocks are excluded.
+
+     @Since 4.04
+  *)
+
+external field : t -> int -> t = "%obj_field"
+
+(** When using flambda:
+
+    [set_field] MUST NOT be called on immutable blocks.  (Blocks allocated
+    in C stubs, or with [new_block] below, are always considered mutable.)
+
+    The same goes for [set_double_field] and [set_tag].  However, for
+    [set_tag], in the case of immutable blocks where the middle-end optimizers
+    never see code that discriminates on their tag (for example records), the
+    operation should be safe.  Such uses are nonetheless discouraged.
+
+    For experts only:
+    [set_field] et al can be made safe by first wrapping the block in
+    {!Sys.opaque_identity}, so any information about its contents will not
+    be propagated.
+*)
+external set_field : t -> int -> t -> unit = "%obj_set_field"
+external dup : t -> t = "?obj_dup"
+
+
+
+
+