tree.mli

   1 (******************************************************************************)
   2 (*  SXSI : XPath evaluator                                                    *)
   3 (*  Kim Nguyen (Kim.Nguyen@nicta.com.au)                                      *)
   4 (*  Copyright NICTA 2008                                                      *)
   5 (*  Distributed under the terms of the LGPL (see LICENCE)                     *)
   6 (******************************************************************************)
   7 module type BINARY =
   8 sig
   9   type node_content
  10   type string_content
  11   type descr = Nil| Node of node_content | String of string_content
  12   type t
  13   val parse_xml_uri : string -> t
  14   val parse_xml_string : string -> t
  15   val save : t -> string -> unit
  16   val load : ?sample:int -> string -> t
  17   val tag_pool : t -> Tag.pool
  18   val string : t -> string
  19   val descr : t -> descr
  20   val is_node : t -> bool
  21   val left : t -> t
  22   val right : t -> t
  23   val first_child : t -> t
  24   val next_sibling : t -> t
  25   val parent : t -> t
  26   val id : t -> int
  27   val tag : t -> Tag.t
  28   val print_xml_fast : out_channel -> t -> unit
  29   val compare : t -> t -> int
  30   val equal : t -> t -> bool
  31   module DocIdSet :
  32   sig
  33     include Set.S
  34   end with type elt = string_content
  35   val string_below : t -> string_content -> bool
  36   val contains : t -> string -> DocIdSet.t
  37   val contains_old : t -> string -> bool
  38   val dump : t -> unit
  39   val get_string : t -> string_content -> string
  40   val has_tagged_desc : t -> Tag.t -> bool
  41   val has_tagged_foll : t -> Tag.t -> bool
  42   val tagged_desc : t -> Tag.t -> t
  43   val tagged_foll : t -> Tag.t -> t
  44   val tagged_next : t -> Tag.t -> t
  45   val subtree_tags : t -> Tag.t -> int
  46 end
  47
  48 module Binary : BINARY
  49
  50 IFDEF DEBUG
  51 THEN
  52 module DEBUGTREE : sig
  53   include BINARY
  54   val print_stats : Format.formatter -> unit
  55 end
  56 ENDIF