bs_string.ml

(* 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. *)

(** *)

(** TODO: check with {!String.of_char} 
    it's quite common that we have
    {[ Bs_string.of_char x.[0] ]}
    It would be nice to generate code as below    
    {[ x[0]
    ]}
*)

(*ATT: this relies on we encode `char' as int *)
external of_char : char -> string = "String.fromCharCode" 
[@@bs.val] 
external toUpperCase : string -> string = "toUpperCase" [@@bs.send] 
external of_int : int -> base:int -> string = "toString" [@@bs.send]
external of_nativeint : nativeint -> base:int -> string = "toString" [@@bs.send]
external slice : string -> int -> int -> string = "slice" 
    [@@bs.send]
external slice_rest : string -> int -> string = "slice" 
    [@@bs.send]
external index_of : string -> string -> int = "indexOf"
    [@@bs.send]
external append : string -> string -> string = "#string_append"
external of_small_int_array : int array -> string = "#string_of_small_int_array"
external of_small_int32_array : int32 array -> string = "#string_of_small_int_array"
external lastIndexOf : string -> string -> int = "lastIndexOf"
[@@bs.send]    
external of_any : 'a -> string = "String"
[@@bs.val]


(***********************)
(* replaced primitives *)
external length : string -> int = "%string_length"
external get : string -> int -> char = "%string_safe_get"
external create : int -> bytes = "caml_create_string"
external unsafe_get : string -> int -> char = "%string_unsafe_get"
external unsafe_set : bytes -> int -> char -> unit = "%bytes_unsafe_set"
external unsafe_blit : string -> int ->  bytes -> int -> int -> unit
  = "caml_blit_string" "noalloc"
external unsafe_fill : bytes -> int -> int -> char -> unit
  = "caml_fill_string" "noalloc"