@tellahq/rescript 10.1.0-alpha.2 → 10.1.4-republish-2

package/lib/ocaml/string.mli

@@ -1,286 +0,0 @@
-(**************************************************************************)
-(*                                                                        *)
-(*                                 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.          *)
-(*                                                                        *)
-(**************************************************************************)
-
-(** String operations.
-
-  A string is an immutable data structure that contains a
-  fixed-length sequence of (single-byte) characters. Each character
-  can be accessed in constant time through its index.
-
-  Given a string [s] of length [l], we can access each of the [l]
-  characters of [s] via its index in the sequence. Indexes start at
-  [0], and we will call an index valid in [s] if it falls within the
-  range [[0...l-1]] (inclusive). A position is the point between two
-  characters or at the beginning or end of the string.  We call a
-  position valid in [s] if it falls within the range [[0...l]]
-  (inclusive). Note that the character at index [n] is between
-  positions [n] and [n+1].
-
-  Two parameters [start] and [len] are said to designate a valid
-  substring of [s] if [len >= 0] and [start] and [start+len] are
-  valid positions in [s].
-
-  OCaml strings used to be modifiable in place, for instance via the
-  {!String.set} and {!String.blit} functions described below. This
-  usage is deprecated and only possible when the compiler is put in
-  "unsafe-string" mode by giving the [-unsafe-string] command-line
-  option (which is currently the default for reasons of backward
-  compatibility). This is done by making the types [string] and
-  [bytes] (see module {!Bytes}) interchangeable so that functions
-  expecting byte sequences can also accept strings as arguments and
-  modify them.
-
-  All new code should avoid this feature and be compiled with the
-  [-safe-string] command-line option to enforce the separation between
-  the types [string] and [bytes].
-
- *)
-
-external length : string -> int = "%string_length"
-(** Return the length (number of characters) of the given string. *)
-
-external get : string -> int -> char = "%string_safe_get"
-(** [String.get s n] returns the character at index [n] in string [s].
-   You can also write [s.[n]] instead of [String.get s n].
-
-   Raise [Invalid_argument] if [n] not a valid index in [s]. *)
-
-
-
-
-val make : int -> char -> string
-(** [String.make n c] returns a fresh string of length [n],
-   filled with the character [c].
-
-   Raise [Invalid_argument] if [n < 0] or [n > ]{!Sys.max_string_length}. *)
-
-val init : int -> (int -> char) -> string
-(** [String.init n f] returns a string of length [n], with character
-    [i] initialized to the result of [f i] (called in increasing
-    index order).
-
-    Raise [Invalid_argument] if [n < 0] or [n > ]{!Sys.max_string_length}.
-
-    @since 4.02.0
-*)
-
-
-val sub : string -> int -> int -> string
-(** [String.sub s start len] returns a fresh string of length [len],
-   containing the substring of [s] that starts at position [start] and
-   has length [len].
-
-   Raise [Invalid_argument] if [start] and [len] do not
-   designate a valid substring of [s]. *)
-
-
-
-val blit : string -> int -> bytes -> int -> int -> unit
-(** Same as {!Bytes.blit_string}. *)
-
-val concat : string -> string list -> string
-(** [String.concat sep sl] concatenates the list of strings [sl],
-    inserting the separator string [sep] between each.
-
-    Raise [Invalid_argument] if the result is longer than
-    {!Sys.max_string_length} bytes. *)
-
-val iter : (char -> unit) -> string -> unit
-(** [String.iter f s] applies function [f] in turn to all
-   the characters of [s].  It is equivalent to
-   [f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ()]. *)
-
-val iteri : (int -> char -> unit) -> string -> unit
-(** Same as {!String.iter}, but the
-   function is applied to the index of the element as first argument
-   (counting from 0), and the character itself as second argument.
-   @since 4.00.0 *)
-
-val map : (char -> char) -> string -> string
-(** [String.map f s] applies function [f] in turn to all the
-    characters of [s] (in increasing index order) and stores the
-    results in a new string that is returned.
-    @since 4.00.0 *)
-
-val mapi : (int -> char -> char) -> string -> string
-(** [String.mapi f s] calls [f] with each character of [s] and its
-    index (in increasing index order) and stores the results in a new
-    string that is returned.
-    @since 4.02.0 *)
-
-val trim : string -> string
-(** Return a copy of the argument, without leading and trailing
-   whitespace.  The characters regarded as whitespace are: [' '],
-   ['\012'], ['\n'], ['\r'], and ['\t'].  If there is neither leading nor
-   trailing whitespace character in the argument, return the original
-   string itself, not a copy.
-   @since 4.00.0 *)
-
-val escaped : string -> string
-(** Return a copy of the argument, with special characters
-    represented by escape sequences, following the lexical
-    conventions of OCaml.
-    All characters outside the ASCII printable range (32..126) are
-    escaped, as well as backslash and double-quote.
-
-    If there is no special character in the argument that needs
-    escaping, return the original string itself, not a copy.
-
-    Raise [Invalid_argument] if the result is longer than
-    {!Sys.max_string_length} bytes.
-
-    The function {!Scanf.unescaped} is a left inverse of [escaped],
-    i.e. [Scanf.unescaped (escaped s) = s] for any string [s] (unless
-    [escape s] fails). *)
-
-val index : string -> char -> int
-(** [String.index s c] returns the index of the first
-   occurrence of character [c] in string [s].
-
-   Raise [Not_found] if [c] does not occur in [s]. *)
-
-val index_opt: string -> char -> int option
-(** [String.index_opt s c] returns the index of the first
-    occurrence of character [c] in string [s], or
-    [None] if [c] does not occur in [s].
-    @since 4.05 *)
-
-val rindex : string -> char -> int
-(** [String.rindex s c] returns the index of the last
-   occurrence of character [c] in string [s].
-
-   Raise [Not_found] if [c] does not occur in [s]. *)
-
-val rindex_opt: string -> char -> int option
-(** [String.rindex_opt s c] returns the index of the last occurrence
-    of character [c] in string [s], or [None] if [c] does not occur in
-    [s].
-    @since 4.05 *)
-
-val index_from : string -> int -> char -> int
-(** [String.index_from s i c] returns the index of the
-   first occurrence of character [c] in string [s] after position [i].
-   [String.index s c] is equivalent to [String.index_from s 0 c].
-
-   Raise [Invalid_argument] if [i] is not a valid position in [s].
-   Raise [Not_found] if [c] does not occur in [s] after position [i]. *)
-
-val index_from_opt: string -> int -> char -> int option
-(** [String.index_from_opt s i c] returns the index of the
-    first occurrence of character [c] in string [s] after position [i]
-    or [None] if [c] does not occur in [s] after position [i].
-
-    [String.index_opt s c] is equivalent to [String.index_from_opt s 0 c].
-    Raise [Invalid_argument] if [i] is not a valid position in [s].
-
-    @since 4.05
-*)
-
-val rindex_from : string -> int -> char -> int
-(** [String.rindex_from s i c] returns the index of the
-   last occurrence of character [c] in string [s] before position [i+1].
-   [String.rindex s c] is equivalent to
-   [String.rindex_from s (String.length s - 1) c].
-
-   Raise [Invalid_argument] if [i+1] is not a valid position in [s].
-   Raise [Not_found] if [c] does not occur in [s] before position [i+1]. *)
-
-val rindex_from_opt: string -> int -> char -> int option
-(** [String.rindex_from_opt s i c] returns the index of the
-   last occurrence of character [c] in string [s] before position [i+1]
-   or [None] if [c] does not occur in [s] before position [i+1].
-
-   [String.rindex_opt s c] is equivalent to
-   [String.rindex_from_opt s (String.length s - 1) c].
-
-   Raise [Invalid_argument] if [i+1] is not a valid position in [s].
-
-    @since 4.05
-*)
-
-val contains : string -> char -> bool
-(** [String.contains s c] tests if character [c]
-   appears in the string [s]. *)
-
-val contains_from : string -> int -> char -> bool
-(** [String.contains_from s start c] tests if character [c]
-   appears in [s] after position [start].
-   [String.contains s c] is equivalent to
-   [String.contains_from s 0 c].
-
-   Raise [Invalid_argument] if [start] is not a valid position in [s]. *)
-
-val rcontains_from : string -> int -> char -> bool
-(** [String.rcontains_from s stop c] tests if character [c]
-   appears in [s] before position [stop+1].
-
-   Raise [Invalid_argument] if [stop < 0] or [stop+1] is not a valid
-   position in [s]. *)
-
-
-val uppercase_ascii : string -> string
-(** Return a copy of the argument, with all lowercase letters
-   translated to uppercase, using the US-ASCII character set.
-   @since 4.03.0 *)
-
-val lowercase_ascii : string -> string
-(** Return a copy of the argument, with all uppercase letters
-   translated to lowercase, using the US-ASCII character set.
-   @since 4.03.0 *)
-
-val capitalize_ascii : string -> string
-(** Return a copy of the argument, with the first character set to uppercase,
-   using the US-ASCII character set.
-   @since 4.03.0 *)
-
-val uncapitalize_ascii : string -> string
-(** Return a copy of the argument, with the first character set to lowercase,
-   using the US-ASCII character set.
-   @since 4.03.0 *)
-
-type t = string
-(** An alias for the type of strings. *)
-
-val compare: t -> t -> int
-(** The comparison function for strings, with the same specification as
-    {!Pervasives.compare}.  Along with the type [t], this function [compare]
-    allows the module [String] to be passed as argument to the functors
-    {!Set.Make} and {!Map.Make}. *)
-
-val equal: t -> t -> bool
-(** The equal function for strings.
-    @since 4.03.0 *)
-
-val split_on_char: char -> string -> string list
-(** [String.split_on_char sep s] returns the list of all (possibly empty)
-    substrings of [s] that are delimited by the [sep] character.
-
-    The function's output is specified by the following invariants:
-
-    - The list is not empty.
-    - Concatenating its elements using [sep] as a separator returns a
-      string equal to the input ([String.concat (String.make 1 sep)
-      (String.split_on_char sep s) = s]).
-    - No string in the result contains the [sep] character.
-
-    @since 4.04.0
-*)
-
-(**/**)
-
-(* The following is for system use only. Do not call directly. *)
-
-external unsafe_get : string -> int -> char = "%string_unsafe_get"
-

package/lib/ocaml/stringLabels.ml

@@ -1,190 +0,0 @@
-(**************************************************************************)
-(*                                                                        *)
-(*                                 OCaml                                  *)
-(*                                                                        *)
-(*           Damien Doligez, projet Gallium, INRIA Rocquencourt           *)
-(*                                                                        *)
-(*   Copyright 2014 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.          *)
-(*                                                                        *)
-(**************************************************************************)
-
-(* String operations, based on byte sequence operations *)
-
-(* WARNING: Some functions in this file are duplicated in bytes.ml for
-   efficiency reasons. When you modify the one in this file you need to
-   modify its duplicate in bytes.ml.
-   These functions have a "duplicated" comment above their definition.
-*)
-
-external length : string -> int = "%string_length"
-external get : string -> int -> char = "%string_safe_get"
-external unsafe_get : string -> int -> char = "%string_unsafe_get"
-
-module B = Bytes
-
-let bts = B.unsafe_to_string
-let bos = B.unsafe_of_string
-
-external make : int -> char -> string = "?string_repeat"  
-
-let init n ~f =
-  B.init n f |> bts
-let sub s ~pos:ofs ~len =
-  B.sub (bos s) ofs len |> bts
-let blit ~src ~src_pos ~dst ~dst_pos ~len =
-  B.blit_string src src_pos dst dst_pos len 
-
-
-
-external%private join : string array -> string -> string = "join" [@@send]
-
-let concat ~(sep : string) (xs : string list) =
-  xs |. Belt_List.toArray |. join sep
-
-(* duplicated in bytes.ml *)
-let iter ~f s =
-  for i = 0 to length s - 1 do f (unsafe_get s i) done
-
-(* duplicated in bytes.ml *)
-let iteri ~f s =
-  for i = 0 to length s - 1 do f i (unsafe_get s i) done
-
-let map ~f s =
-  B.map f (bos s) |> bts
-let mapi ~f s =
-  B.mapi f (bos s) |> bts
-
-(* Beware: we cannot use B.trim or B.escape because they always make a
-   copy, but String.mli spells out some cases where we are not allowed
-   to make a copy. *)
-
-let is_space = function
-  | ' ' | '\012' | '\n' | '\r' | '\t' -> true
-  | _ -> false
-
-let trim s =
-  if s = "" then s
-  else if is_space (unsafe_get s 0) || is_space (unsafe_get s (length s - 1))
-  then bts (B.trim (bos s))
-  else s
-
-let escaped s =
-  let rec needs_escape i =
-    if i >= length s then false else
-      match unsafe_get s i with
-      | '\"' | '\\' | '\n' | '\t' | '\r' | '\b' -> true
-      | ' ' .. '~' -> needs_escape (i+1)
-      | _ -> true
-  in
-  if needs_escape 0 then
-    bts (B.escaped (bos s))
-  else
-    s
-
-(* duplicated in bytes.ml *)
-let rec index_rec s lim i c =
-  if i >= lim then raise Not_found else
-  if unsafe_get s i = c then i else index_rec s lim (i + 1) c
-
-(* duplicated in bytes.ml *)
-let index s c = index_rec s (length s) 0 c
-
-(* duplicated in bytes.ml *)
-let rec index_rec_opt s lim i c =
-  if i >= lim then None else
-  if unsafe_get s i = c then Some i else index_rec_opt s lim (i + 1) c
-
-(* duplicated in bytes.ml *)
-let index_opt s c = index_rec_opt s (length s) 0 c
-
-(* duplicated in bytes.ml *)
-let index_from s i c =
-  let l = length s in
-  if i < 0 || i > l then invalid_arg "String.index_from / Bytes.index_from" else
-    index_rec s l i c
-
-(* duplicated in bytes.ml *)
-let index_from_opt s i c =
-  let l = length s in
-  if i < 0 || i > l then invalid_arg "String.index_from_opt / Bytes.index_from_opt" else
-    index_rec_opt s l i c
-
-(* duplicated in bytes.ml *)
-let rec rindex_rec s i c =
-  if i < 0 then raise Not_found else
-  if unsafe_get s i = c then i else rindex_rec s (i - 1) c
-
-(* duplicated in bytes.ml *)
-let rindex s c = rindex_rec s (length s - 1) c
-
-(* duplicated in bytes.ml *)
-let rindex_from s i c =
-  if i < -1 || i >= length s then
-    invalid_arg "String.rindex_from / Bytes.rindex_from"
-  else
-    rindex_rec s i c
-
-(* duplicated in bytes.ml *)
-let rec rindex_rec_opt s i c =
-  if i < 0 then None else
-  if unsafe_get s i = c then Some i else rindex_rec_opt s (i - 1) c
-
-(* duplicated in bytes.ml *)
-let rindex_opt s c = rindex_rec_opt s (length s - 1) c
-
-(* duplicated in bytes.ml *)
-let rindex_from_opt s i c =
-  if i < -1 || i >= length s then
-    invalid_arg "String.rindex_from_opt / Bytes.rindex_from_opt"
-  else
-    rindex_rec_opt s i c
-
-(* duplicated in bytes.ml *)
-let contains_from s i c =
-  let l = length s in
-  if i < 0 || i > l then
-    invalid_arg "String.contains_from / Bytes.contains_from"
-  else
-    try ignore (index_rec s l i c); true with Not_found -> false
-
-(* duplicated in bytes.ml *)
-let contains s c = contains_from s 0 c
-
-(* duplicated in bytes.ml *)
-let rcontains_from s i c =
-  if i < 0 || i >= length s then
-    invalid_arg "String.rcontains_from / Bytes.rcontains_from"
-  else
-    try ignore (rindex_rec s i c); true with Not_found -> false
-
-let uppercase_ascii s =
-  B.uppercase_ascii (bos s) |> bts
-let lowercase_ascii s =
-  B.lowercase_ascii (bos s) |> bts
-let capitalize_ascii s =
-  B.capitalize_ascii (bos s) |> bts
-let uncapitalize_ascii s =
-  B.uncapitalize_ascii (bos s) |> bts
-
-type t = string
-
-let compare (x: t) (y: t) = Pervasives.compare x y
-let equal : string -> string -> bool = fun a b -> a = b
-
-let split_on_char ~sep s =
-  let r = ref [] in
-  let j = ref (length s) in
-  for i = length s - 1 downto 0 do
-    if unsafe_get s i = sep then begin
-      r := sub s ~pos:(i + 1) ~len:(!j - i - 1) :: !r;
-      j := i
-    end
-  done;
-  sub s ~pos:0 ~len:!j :: !r
-
-