Add serialization functions
[SXSI/xpathcomp.git] / 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 left : t -> t
21   val right : t -> t
22   val parent : t -> t
23   val id : t -> int
24   val tag : t -> Tag.t
25   val print_xml_fast : out_channel -> t -> unit
26   val compare : t -> t -> int
27   val equal : t -> t -> bool
28   module DocIdSet : Set.S with type elt = string_content
29   val string_below : t -> string_content -> bool
30   val contains : t -> string -> DocIdSet.t
31   val contains_old : t -> string -> bool
32   val dump : t -> unit 
33 end
34
35 module Binary : BINARY
36
37 IFDEF DEBUG
38 THEN
39 module DEBUGTREE : sig
40   include BINARY
41   val print_stats : Format.formatter -> unit
42 end
43 ENDIF