(** Fast lookup tables for Unicode.  Accessible by constant time. *)
(* Copyright (C) 2002, 2003 Yamagata Yoriyuki. distributed with LGPL *)

(* This library 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 2 of *)
(* the License, or (at your option) any later version. *)

(* As a special exception to the GNU Library General Public License, you *)
(* may link, statically or dynamically, a "work that uses this library" *)
(* with a publicly distributed version of this library to produce an *)
(* executable file containing portions of this library, and distribute *)
(* that executable file under terms of your choice, without any of the *)
(* additional requirements listed in clause 6 of the GNU Library General *)
(* Public License. By "a publicly distributed version of this library", *)
(* we mean either the unmodified Library as distributed by the authors, *)
(* or a modified version of this library that is distributed under the *)
(* conditions defined in clause 3 of the GNU Library General Public *)
(* License. This exception does not however invalidate any other reasons *)
(* why the executable file might be covered by the GNU Library General *)
(* Public License . *)

(* This library 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 library; if not, write to the Free Software *)
(* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *)
(* USA *)

(* You can contact the authour by sending email to *)
(* yoriyuki.y@gmail.com *)

(** Fast lookup tables.  Accessible by constant time. *)
type 'a tbl

type 'a t = 'a tbl

val get : 'a tbl -> UChar.t -> 'a

module type Type = sig
  type elt
  type t = elt tbl

  val get : elt tbl -> UChar.t -> elt

  (** [of_map def m] creates the table which has the same value to [m].
      The table returns [def] for the characters for which [m] is undefined. *)
  val of_map : elt -> elt UMap.t -> t
end

(** Equality and hash are necessary for table generation. *)
module Make : functor (H : Hashtbl.HashedType) -> Type with type elt = H.t

(** Tables for boolean values. *)
module Bool : sig
  type t

  val get : t -> UChar.t -> bool
  val of_set : USet.t -> t
end

(** Tables for small (< 256, >=0) integers *)
module Bits : sig
  type t

  val of_map : int -> int UMap.t -> t
  val get : t -> UChar.t -> int
end

(** Tables for integers.  If integers are not span the whole 31-bit or
    63-bit values, [Bytes.t] is more space efficient than [int tbl]. *)
module Bytes : sig
  type t

  val of_map : int -> int UMap.t -> t
  val get : t -> UChar.t -> int
end

(** Tables for bytes. *)
module Char : sig
  type t

  val of_map : char -> char UMap.t -> t
  val get : t -> UChar.t -> char
end
