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

package/lib/ocaml/belt_Id.mli

@@ -0,0 +1,171 @@
+
+(* Copyright (C) 2017 Authors of ReScript
+ *
+ * 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. *)
+
+
+(**
+  [`Belt.Id`]()
+
+  Provide utiliites to create identified comparators or hashes for
+  data structures used below.
+
+  It create a unique identifer per module of functions so that different data structures with slightly different
+  comparison functions won't mix.
+*)
+
+
+
+type ('a, 'id) hash
+(**
+  `('a, 'id) hash`
+
+  Its runtime represenation is a `hash` function, but signed with a
+  type parameter, so that different hash functions type mismatch
+*)
+
+type ('a, 'id) eq
+(**
+  `('a, 'id) eq`
+
+  Its runtime represenation is an `eq` function, but signed with a
+  type parameter, so that different hash functions type mismatch
+*)
+
+type ('a, 'id) cmp
+(**
+  `('a,'id) cmp`
+
+  Its runtime representation is a `cmp` function, but signed with a
+  type parameter, so that different hash functions type mismatch
+*)
+
+module type Comparable = sig
+  type identity
+  type t
+  val cmp: (t, identity) cmp
+end
+
+type ('key, 'id) comparable =
+  (module Comparable with type t = 'key and type identity = 'id)
+(**
+  `('key, 'id) cmparable` is a module of functions, here it only includes `cmp`.
+
+  Unlike normal functions, when created, it comes with a unique identity (guaranteed
+  by the type system).
+
+  It can be created using function [`comparableU`]() or [`comparable`]().
+
+  The idea of a unique identity when created is that it makes sure two sets would type
+  mismatch if they use different comparison function
+*)
+
+module MakeComparableU :
+  functor (M : sig
+             type t
+             val cmp : t -> t -> int [@bs]
+           end) ->
+    Comparable with type t = M.t
+
+module MakeComparable :
+  functor (M : sig
+             type t
+             val cmp : t -> t -> int
+           end) ->
+    Comparable with type t = M.t
+
+val comparableU:
+  cmp:('a -> 'a -> int [@bs]) ->
+  (module Comparable with type t = 'a)
+
+(**
+  ```
+  module C = (
+    val Belt.Id.comparable ~cmp:(compare : int -> int -> int)
+  )
+  let m = Belt.Set.make(module C)
+  ```
+
+  Note that the name of C can not be ignored
+*)
+val comparable:
+  cmp:('a -> 'a -> int) ->
+  (module Comparable with type t = 'a)
+
+
+module type Hashable = sig
+  type identity
+  type t
+  val hash : (t, identity) hash
+  val eq : (t, identity) eq
+end
+
+type ('key, 'id) hashable =
+  (module Hashable with type t = 'key and type identity = 'id)
+(**
+  `('key, 'id) hashable` is a module of functions, here it only includes `hash`, `eq`.
+
+  Unlike normal functions, when created, it comes with a unique identity (guaranteed
+  by the type system).
+
+  It can be created using function [`hashableU`]() or [`hashable`]().
+
+  The idea of a unique identity when created is that it makes sure two hash sets would type
+  mismatch if they use different comparison function
+*)
+
+module MakeHashableU :
+  functor (M : sig
+             type t
+             val hash : t -> int [@bs]
+             val eq : t -> t -> bool [@bs]
+           end) ->
+    Hashable with type t = M.t
+
+module MakeHashable :
+  functor (M : sig
+             type t
+             val hash : t -> int
+             val eq : t -> t -> bool
+           end) ->
+    Hashable with type t = M.t
+
+val hashableU :
+  hash:('a -> int [@bs]) ->
+  eq:('a -> 'a -> bool [@bs]) ->
+  (module Hashable with type t = 'a)
+
+
+val hashable :
+  hash:('a -> int) ->
+  eq:('a -> 'a -> bool ) ->
+  (module Hashable with type t = 'a)
+
+
+
+
+(**/**)
+external getHashInternal : ('a,'id) hash -> ('a -> int [@bs]) = "%identity"
+external getEqInternal : ('a, 'id) eq -> ('a -> 'a -> bool [@bs]) = "%identity"
+external getCmpInternal : ('a,'id) cmp -> ('a -> 'a -> int [@bs]) = "%identity"
+(**/**)

package/lib/ocaml/belt_Int.ml

@@ -0,0 +1,50 @@
+(* Copyright (C) 2017 Hongbo Zhang, Authors of ReScript
+ *
+ * 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. *)
+
+(** [`Belt.Int`]()
+    Utililites for Int
+*)
+
+external isNaN : int -> bool = "isNaN" [@@bs.val]
+
+external toFloat: int -> float = "%identity"
+
+external fromFloat: float -> int = "%intoffloat"
+
+external fromString: string -> (_ [@bs.as 10]) -> int = "parseInt" [@@bs.val]
+
+let fromString i =
+  match fromString i with
+  | i when isNaN i -> None
+  | i -> Some i
+
+external toString: int -> string = "String" [@@bs.val]
+
+external ( + ) : int -> int -> int = "%addint"
+
+external ( - ) : int -> int -> int = "%subint"
+
+external ( * ) : int -> int -> int = "%mulint"
+
+external ( / ) : int -> int -> int = "%divint"

package/lib/ocaml/belt_Int.mli

@@ -0,0 +1,103 @@
+(* Copyright (C) 2017 Authors of ReScript
+ *
+ * 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. *)
+
+(**
+  This module includes convenience methods for handling `int` types.
+*)
+
+(**
+  Converts a given `int` to a `float`.
+
+  ```res example
+  Js.log(Belt.Int.toFloat(1) === 1.0) /* true */
+  ```
+*)
+external toFloat: int -> float = "%identity"
+
+(**
+  Converts a given `float` to an `int`.
+
+  ```res example
+  Js.log(Belt.Int.fromFloat(1.0) === 1) /* true */
+  ```
+*)
+external fromFloat: float -> int = "%intoffloat"
+
+(**
+  Converts a given `string` to an `int`. Returns `Some(int)` when the input is a number, `None` otherwise.
+
+  ```res example
+  Js.log(Belt.Int.fromString("1") === Some(1)) /* true */
+  ```
+*)
+val fromString: string -> int option
+
+(**
+  Converts a given `int` to a `string`. Uses the JavaScript `String` constructor under the hood.
+
+  ```res example
+  Js.log(Belt.Int.toString(1) === "1") /* true */
+  ```
+*)
+external toString: int -> string = "String" [@@bs.val]
+
+(**
+  Addition of two `int` values. Same as the addition from `Pervasives`.
+
+  ```res example
+  open Belt.Int
+  Js.log(2 + 2 === 4) /* true */
+  ```
+*)
+external ( + ) : int -> int -> int = "%addint"
+
+(**
+  Subtraction of two `int` values. Same as the subtraction from `Pervasives`.
+
+  ```res example
+  open Belt.Int
+  Js.log(2 - 1 === 1) /* true */
+  ```
+*)
+external ( - ) : int -> int -> int = "%subint"
+
+(**
+  Multiplication of two `int` values. Same as the multiplication from `Pervasives`.
+
+  ```res example
+  open Belt.Int
+  Js.log(2 * 2 === 4) /* true */
+  ```
+*)
+external ( * ) : int -> int -> int = "%mulint"
+
+(**
+  Division of two `int` values. Same as the division from `Pervasives`.
+
+  ```res example
+  open Belt.Int
+  Js.log(4 / 2 === 2); /* true */
+  ```
+*)
+external ( / ) : int -> int -> int = "%divint"