src/tree.ml

   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 INCLUDE "debug.ml"
   8 INCLUDE "utils.ml"
   9
  10
  11 external init_lib : unit -> unit = "sxsi_cpp_init"
  12
  13 exception CPlusPlusError of string
  14
  15 let () = Callback.register_exception "CPlusPlusError" (CPlusPlusError "")
  16
  17 let () =  init_lib ()
  18
  19 type node = [ `Tree ] Node.t
  20
  21 type tree
  22
  23
  24 external register_tag : tree -> string -> Tag.t = "caml_xml_tree_register_tag"
  25
  26 external tag_name : tree -> Tag.t -> string = "caml_xml_tree_get_tag_name"
  27
  28 let tag t = (); fun s ->
  29   match s with
  30   | "<$>" -> Tag.pcdata
  31   | "<@>" -> Tag.attribute
  32   | "" -> Tag.document_node
  33   | "<@$>" -> Tag.attribute_data
  34   | _ -> register_tag t s
  35
  36 let to_string d = ();
  37   fun t ->
  38     if t == Tag.pcdata then "<$>"
  39     else if t == Tag.attribute_data then "<@$>"
  40     else if t == Tag.attribute then "<@>"
  41     else if t == Tag.nullt then "<!NIL!>"
  42     else tag_name d t
  43
  44 let translate  x = x
  45
  46 let mk_tag_ops t = {
  47   Tag.tag = tag t;
  48   Tag.to_string = to_string t;
  49   Tag.translate = translate
  50 }
  51
  52 module TreeBuilder =
  53 struct
  54   type t
  55   external create : unit -> t = "caml_xml_tree_builder_create"
  56   external open_document : t -> bool -> int -> bool -> int -> unit = "caml_xml_tree_builder_open_document"
  57   external close_document : t -> tree = "caml_xml_tree_builder_close_document"
  58   external open_tag : t -> string -> unit = "caml_xml_tree_builder_new_open_tag"
  59   external close_tag : t -> string -> unit = "caml_xml_tree_builder_new_closing_tag"
  60   external text : t -> string -> unit = "caml_xml_tree_builder_new_text"
  61
  62
  63   let do_text b t =
  64     if Buffer.length t > 0 then begin
  65       open_tag b "<$>";
  66       text b (Buffer.contents t);
  67       close_tag b "<$>";
  68       Buffer.clear t
  69     end
  70
  71   let output_attr b name value =
  72     let atname = "<@>" ^ name in
  73     open_tag b atname;
  74     open_tag b "<@$>";
  75       text b value;
  76       close_tag b "<@$>";
  77       close_tag b atname
  78
  79   let start_element_handler b t tag attr_list =
  80     do_text b t;
  81     open_tag b tag;
  82     match attr_list with
  83         [] -> ()
  84       | l ->
  85         open_tag b "<@>";
  86         List.iter (fun (name, value) -> output_attr b name value) l;
  87           close_tag b "<@>"
  88
  89
  90   let end_element_handler b t tag =
  91     do_text b t;
  92     close_tag b tag
  93
  94   let character_data_handler _b t text =
  95     Buffer.add_string t text
  96
  97   let create_parser () =
  98     let buf = Buffer.create 512 in
  99     let build = create () in
 100     let parser_ = Expat.parser_create ~encoding:None in
 101     let finalize () =
 102       do_text build buf;
 103       close_tag build "";
 104       close_document build
 105     in
 106     Expat.set_start_element_handler parser_ (start_element_handler build buf);
 107     Expat.set_end_element_handler parser_ (end_element_handler build buf);
 108     Expat.set_character_data_handler parser_ (character_data_handler build buf);
 109     open_document build !Options.index_empty_texts !Options.sample_factor
 110       !Options.disable_text_collection !Options.text_index_type;
 111     open_tag build "";
 112     parser_, finalize
 113
 114   let parse_string s =
 115     let parser_, finalizer = create_parser () in
 116     Expat.parse parser_ s;
 117     finalizer ()
 118
 119   let parse_file file =
 120     let in_chan = open_in file in
 121     let buffer = String.create 4096 in
 122     let parser_, finalizer = create_parser () in
 123     let () =
 124       try
 125         while true do
 126           let read = input in_chan buffer 0 4096 in
 127           if read == 0 then raise End_of_file else
 128             Expat.parse_sub parser_ buffer 0 read;
 129           done
 130
 131       with
 132         | End_of_file -> close_in in_chan
 133         | e -> raise e
 134     in
 135       finalizer ()
 136
 137
 138
 139 end
 140
 141
 142
 143
 144 type bit_vector = string
 145
 146 external bool_of_int : int -> bool = "%identity"
 147
 148 let bit_vector_unsafe_get v i =
 149   bool_of_int
 150     (((Char.code (String.unsafe_get v (i lsr 3))) lsr (i land 7)) land 1)
 151
 152 type t = {
 153   doc : tree;
 154   elements: Ptset.Int.t;
 155   attributes: Ptset.Int.t;
 156   attribute_array : Tag.t array;
 157   children : Ptset.Int.t array;
 158   siblings : Ptset.Int.t array;
 159   descendants: Ptset.Int.t array;
 160   followings: Ptset.Int.t array;
 161 }
 162
 163
 164 let tag_operations t = mk_tag_ops t.doc
 165 (*
 166 external parse_xml_uri : string -> int -> bool -> bool -> int -> tree = "caml_call_shredder_uri"
 167 external parse_xml_string :  string -> int -> bool -> bool -> int -> tree = "caml_call_shredder_string"
 168 *)
 169 external tree_print_xml_fast3 : tree -> [`Tree ] Node.t -> Unix.file_descr -> unit = "caml_xml_tree_print"
 170 let print_xml t n fd =
 171   tree_print_xml_fast3 t.doc n fd
 172
 173
 174 external tree_save : tree -> Unix.file_descr -> string -> unit = "caml_xml_tree_save"
 175 external tree_load : Unix.file_descr -> string -> bool -> int -> tree = "caml_xml_tree_load"
 176
 177 external nullt : unit -> 'a Node.t = "caml_xml_tree_nullt"
 178
 179 let nil : [`Tree ] Node.t = Node.nil
 180 let root : [`Tree ] Node.t = Node.null
 181
 182 type unordered_set
 183
 184 external unordered_set_alloc : int -> unordered_set = "caml_unordered_set_alloc"
 185 external unordered_set_length : unordered_set -> int = "caml_unordered_set_length"
 186 external unordered_set_insert : unordered_set -> int -> unit = "caml_unordered_set_set" "noalloc"
 187
 188 module HPtset = Hashtbl.Make(Ptset.Int)
 189
 190 let vector_htbl = HPtset.create MED_H_SIZE
 191
 192 let unordered_set_of_set s =
 193   try
 194     HPtset.find vector_htbl s
 195   with
 196       Not_found ->
 197         let v = unordered_set_alloc (Ptset.Int.cardinal s) in
 198         let _ = Ptset.Int.iter (fun e -> unordered_set_insert v e) s in
 199           HPtset.add vector_htbl s v; v
 200
 201 let ptset_to_vector = unordered_set_of_set
 202
 203 (** tree interface *)
 204
 205 external tree_root : tree -> [`Tree] Node.t = "caml_xml_tree_root"  "noalloc"
 206
 207
 208 external tree_first_child : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_first_child" "noalloc"
 209 let first_child t n = tree_first_child t.doc n
 210
 211 external tree_first_element : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_first_element" "noalloc"
 212 let first_element t n = tree_first_element t.doc n
 213
 214 external tree_tagged_child : tree -> [`Tree] Node.t -> Tag.t -> [`Tree] Node.t = "caml_xml_tree_tagged_child" "noalloc"
 215 let tagged_child t n tag = tree_tagged_child t.doc n tag
 216
 217 external tree_select_child : tree -> [`Tree ] Node.t -> unordered_set -> [`Tree] Node.t = "caml_xml_tree_select_child" "noalloc"
 218 let select_child t n tag_set = tree_select_child t.doc n tag_set
 219
 220 external tree_last_child : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_last_child" "noalloc"
 221 let last_child t n = tree_last_child t.doc n
 222
 223
 224
 225 external tree_next_sibling : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_next_sibling"  "noalloc"
 226 let next_sibling t n = tree_next_sibling t.doc n
 227
 228 external tree_next_element : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_next_element"  "noalloc"
 229 let next_element t n = tree_next_element t.doc n
 230
 231 external tree_next_node_before : tree -> [`Tree] Node.t -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_next_node_before"  "noalloc"
 232 let next_node_before t n ctx = tree_next_node_before t.doc n ctx
 233
 234 external tree_tagged_following_sibling : tree -> [`Tree] Node.t -> Tag.t -> [`Tree] Node.t = "caml_xml_tree_tagged_following_sibling" "noalloc"
 235 let tagged_following_sibling t n tag = tree_tagged_following_sibling t.doc n tag
 236
 237 external tree_select_following_sibling : tree -> [`Tree ] Node.t -> unordered_set -> [`Tree] Node.t = "caml_xml_tree_select_following_sibling" "noalloc"
 238 let select_following_sibling t n tag_set = tree_select_following_sibling t.doc n tag_set
 239
 240 external tree_prev_sibling : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_prev_sibling" "noalloc"
 241 let prev_sibling t n = tree_prev_sibling t.doc n
 242
 243
 244
 245 external tree_tagged_descendant : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_descendant" "noalloc"
 246 let tagged_descendant t n tag = tree_tagged_descendant t.doc n tag
 247
 248 external tree_tagged_next : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_next" "noalloc"
 249 let tagged_next t n tag = tree_tagged_next t.doc n tag
 250
 251 external tree_select_descendant : tree -> [`Tree ] Node.t -> unordered_set -> [`Tree] Node.t = "caml_xml_tree_select_descendant" "noalloc"
 252 let select_descendant t n tag_set = tree_select_descendant t.doc n tag_set
 253
 254 external tree_tagged_following_before : tree -> [`Tree ] Node.t -> Tag.t -> [`Tree ] Node.t -> [`Tree ] Node.t = "caml_xml_tree_tagged_following_before" "noalloc"
 255 let tagged_following_before t n tag ctx = tree_tagged_following_before t.doc n tag ctx
 256
 257 external tree_select_following_before : tree -> [`Tree ] Node.t -> unordered_set -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_select_following_before" "noalloc"
 258 let select_following_before t n tag_set ctx = tree_select_following_before t.doc n tag_set ctx
 259
 260 external tree_parent : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_parent" "noalloc"
 261 let parent t n = tree_parent t.doc n
 262
 263 external tree_binary_parent : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_binary_parent"
 264   "noalloc"
 265 let binary_parent t n = tree_binary_parent t.doc n
 266
 267
 268 external tree_tag : tree -> [`Tree] Node.t -> Tag.t = "caml_xml_tree_tag" "noalloc"
 269 let tag t n = tree_tag t.doc n
 270
 271 external tree_is_first_child : tree -> [ `Tree ] Node.t -> bool = "caml_xml_tree_is_first_child" "noalloc"
 272 let is_first_child t n = tree_is_first_child t.doc n
 273
 274 external tree_is_right_descendant : tree -> [ `Tree ] Node.t -> [`Tree] Node.t -> bool =
 275   "caml_xml_tree_is_right_descendant" "noalloc"
 276
 277 let is_right_descendant t n1 n2 = tree_is_right_descendant t.doc n1 n2
 278 ;;
 279
 280 let node_tags t = Ptset.Int.add Tag.document_node t.descendants.(Tag.document_node)
 281
 282 let attribute_tags t = t.attributes
 283
 284 let element_tags t = t.elements
 285
 286 let tags t tag =
 287   t.children.(tag), t.descendants.(tag), t.siblings.(tag), t.followings.(tag)
 288
 289 open Format
 290 let dump_tag_table t =
 291   eprintf "Child tags:\n%!";
 292   Array.iteri
 293     (fun tag set -> eprintf "%s: %a\n%!"
 294       (Tag.to_string tag) TagSet.print (TagSet.inj_positive set))
 295     t.children;
 296   eprintf "-----------------------------\n%!";
 297   eprintf "Descendant tags:\n%!";
 298   Array.iteri
 299     (fun tag set -> eprintf "%s: %a\n%!"
 300       (Tag.to_string tag) TagSet.print (TagSet.inj_positive set))
 301     t.descendants;
 302   eprintf "-----------------------------\n%!";
 303   eprintf "Sibling tags:\n%!";
 304   Array.iteri
 305     (fun tag set -> eprintf "%s: %a\n%!"
 306       (Tag.to_string tag) TagSet.print (TagSet.inj_positive set))
 307     t.siblings;
 308   eprintf "-----------------------------\n%!";
 309   eprintf "Following tags:\n%!";
 310   Array.iteri
 311     (fun tag set -> eprintf "%s: %a\n%!"
 312       (Tag.to_string tag) TagSet.print (TagSet.inj_positive set))
 313     t.followings;
 314    eprintf "-----------------------------\n%!"
 315
 316
 317 external tree_subtree_tags : tree -> [`Tree] Node.t -> Tag.t -> int = "caml_xml_tree_subtree_tags" "noalloc"
 318 let subtree_tags t n tag = tree_subtree_tags t.doc n tag
 319
 320 external tree_subtree_size : tree -> [`Tree] Node.t -> int = "caml_xml_tree_subtree_size" "noalloc"
 321 let subtree_size t n = tree_subtree_size t.doc n
 322
 323 let subtree_elements t node =
 324   let size = tree_subtree_size t.doc node - 1 in
 325     if size == 0 then 0
 326     else let size = size - (tree_subtree_tags t.doc node Tag.pcdata) in
 327       if size < 2 then size else
 328         let acc = ref size in
 329           for i = 0 to Array.length t.attribute_array - 1 do
 330             acc := !acc - tree_subtree_tags t.doc node t.attribute_array.(i)
 331           done;
 332           !acc
 333
 334 external tree_closing : tree -> [`Tree] Node.t -> [`Tree] Node.t = "caml_xml_tree_closing" "noalloc"
 335 let closing t n = tree_closing t.doc n
 336
 337 external tree_num_tags : tree -> int = "caml_xml_tree_num_tags" "noalloc"
 338 let num_tags t = tree_num_tags t.doc
 339
 340 external tree_size : tree -> int = "caml_xml_tree_size" "noalloc"
 341 let size t = tree_size t.doc
 342
 343
 344 let stats t =
 345   let tree = t.doc in
 346   let rec loop left node acc_d total_d num_leaves =
 347     if node == nil then
 348     (acc_d+total_d,if left then num_leaves+1 else num_leaves)
 349     else
 350     let d,td = loop true (tree_first_child tree node) (acc_d+1) total_d num_leaves in
 351     loop false (tree_next_sibling tree  node) (acc_d)  d td
 352   in
 353   let a,b = loop true root 0 0 0
 354   in
 355   Printf.eprintf "Average depth: %f, number of leaves %i\n%!" ((float_of_int a)/. (float_of_int b)) b
 356 ;;
 357
 358 module TagS =
 359   struct
 360     include Ptset.Make (
 361       struct type t = int
 362              type data = t
 363              external hash : t -> int = "%identity"
 364              external uid : t -> Uid.t = "%identity"
 365              external equal : t -> t -> bool = "%eq"
 366              external make : t -> int = "%identity"
 367              external node : t -> int = "%identity"
 368              external stats : unit -> unit = "%identity"
 369       end
 370     )
 371     let to_ptset s = fold (Ptset.Int.add) s Ptset.Int.empty
 372   end
 373
 374 module TSTSCache =
 375   Hashtbl.Make(struct type t = TagS.t * TagS.t
 376                       let hash (x, y) =
 377                         HASHINT2(Uid.to_int x.TagS.Node.id,
 378                                  Uid.to_int y.TagS.Node.id)
 379                       let equal u v =
 380                         let u1,u2 = u
 381                         and v1,v2 = v in
 382                           u1 == v1 && u2 == v2
 383                end)
 384 module TagTSCache =
 385   Hashtbl.Make(struct type t = Tag.t * TagS.t
 386                       let hash (x, y) =
 387                         HASHINT2(x, Uid.to_int y.TagS.Node.id)
 388                       let equal u v =
 389                         let u1,u2 = u
 390                         and v1,v2 = v in
 391                           u1 == v1 && u2 == v2
 392                end)
 393
 394 let add_cache = TagTSCache.create 1023
 395 let union_cache = TSTSCache.create 1023
 396 let subset_cache = TSTSCache.create 1023
 397
 398 let clear_cache () =
 399   TSTSCache.clear union_cache;
 400   TSTSCache.clear subset_cache;
 401   TagTSCache.clear add_cache
 402
 403 let _subset x y =
 404   (x == y) || (x == TagS.empty) ||
 405     if y == TagS.empty then false
 406     else
 407       let key = (x, y) in
 408         try
 409           TSTSCache.find subset_cache key
 410         with
 411           | Not_found ->
 412               let z = TagS.subset x y in
 413                 TSTSCache.add subset_cache key z; z
 414
 415 let order ((x, y) as z) =
 416   if x.TagS.Node.id <= y.TagS.Node.id then z
 417   else (y, x)
 418
 419 let _union x y =
 420   if _subset x y then y
 421   else if _subset y x then x
 422   else
 423    let key = order (x, y) in
 424      try
 425        TSTSCache.find union_cache key
 426     with
 427       | Not_found ->
 428           let z = TagS.union x y in
 429             TSTSCache.add union_cache key z; z
 430
 431 let _add t s =
 432   let key = (t,s) in
 433     try
 434       TagTSCache.find add_cache key
 435     with
 436       | Not_found ->
 437           let z = TagS.add t s in
 438             TagTSCache.add add_cache key z;z
 439
 440 let child_sibling_labels tree =
 441   let table_c = Array.create (tree_num_tags tree) TagS.empty in
 442   let table_n = Array.copy table_c in
 443   let rec loop node =
 444     if node == nil then TagS.empty
 445     else
 446       let children = loop (tree_first_child tree node) in
 447       let tag = tree_tag tree node in
 448       let () =
 449         let tc = table_c.(tag) in
 450         if _subset children tc then ()
 451         else table_c.(tag) <-  _union tc children
 452       in
 453       let siblings = loop (tree_next_sibling tree node) in
 454       let () =
 455         let tn = table_n.(tag) in
 456           if _subset siblings tn then ()
 457           else table_n.(tag) <- _union tn siblings
 458       in
 459         _add tag siblings
 460   in
 461     ignore (loop root);
 462     table_c, table_n
 463
 464 let descendant_labels tree =
 465   let table_d = Array.create (tree_num_tags tree) TagS.empty in
 466   let rec loop node =
 467     if node == nil then  TagS.empty else
 468       let d1 = loop (tree_first_child tree node) in
 469       let d2 = loop (tree_next_sibling tree node) in
 470       let tag = tree_tag tree node in
 471       let () =
 472         let td = table_d.(tag) in
 473           if _subset d1 td then ()
 474           else table_d.(tag) <- _union td d1;
 475       in
 476         _add tag (_union d1 d2)
 477   in
 478     ignore (loop root);
 479     table_d
 480
 481 let collect_labels tree =
 482   let table_f = Array.create (tree_num_tags tree) TagS.empty in
 483   let table_n = Array.copy table_f in
 484   let table_c = Array.copy table_f in
 485   let table_d = Array.copy table_f in
 486   let rec loop node foll_siblings descendants followings =
 487     if node == nil then foll_siblings, descendants, followings else
 488       let tag = tree_tag tree node in
 489       let () =
 490         let tf = table_f.(tag) in
 491           if _subset followings tf then ()
 492           else table_f.(tag) <- _union tf followings in
 493       let () =
 494         let tn = table_n.(tag) in
 495           if _subset foll_siblings tn then ()
 496           else table_n.(tag) <- _union tn foll_siblings in
 497       let children, n_descendants, n_followings =
 498         loop (tree_last_child tree node) TagS.empty TagS.empty followings
 499       in
 500       let () =
 501         let tc = table_c.(tag) in
 502           if _subset children tc then ()
 503           else table_c.(tag) <- _union tc children
 504       in
 505       let () =
 506         let td = table_d.(tag) in
 507           if _subset n_descendants td then ()
 508           else table_d.(tag) <- _union td n_descendants
 509       in
 510         loop (tree_prev_sibling tree node)
 511           (_add tag foll_siblings)
 512           (_add tag (_union n_descendants descendants))
 513           (_add tag n_followings)
 514   in
 515     ignore (loop root TagS.empty TagS.empty TagS.empty);
 516     table_f, table_n, table_c, table_d
 517
 518
 519 let is_nil t = t == nil
 520 let is_node t = t != nil
 521 let is_root t = t == root
 522
 523 let node_of_t t  =
 524   let _ = Tag.init (mk_tag_ops t) in
 525   let f, n, c, d = time collect_labels t ~msg:"Building tag relationship table" in
 526   let c = Array.map TagS.to_ptset c in
 527   let n = Array.map TagS.to_ptset n in
 528   let f = Array.map TagS.to_ptset f in
 529   let d = Array.map TagS.to_ptset d in
 530   let () = clear_cache () in
 531   let attributes = Ptset.Int.add Tag.attribute d.(Tag.attribute) in
 532   let elements = Ptset.Int.add Tag.document_node
 533     (Ptset.Int.remove Tag.pcdata
 534        (Ptset.Int.diff d.(Tag.document_node) attributes))
 535   in
 536     { doc= t;
 537       attributes = attributes;
 538       attribute_array = Array.of_list (Ptset.Int.elements attributes);
 539       elements = elements;
 540       children = c;
 541       siblings = n;
 542       descendants = d;
 543       followings = f
 544
 545     }
 546
 547
 548 let parse_xml_uri str = node_of_t (TreeBuilder.parse_file str)
 549 let parse_xml_string str = node_of_t (TreeBuilder.parse_string str)
 550
 551 let size t = tree_size t.doc;;
 552
 553 let magic_string = "SXSI_INDEX"
 554 let version_string = "3"
 555
 556 let pos fd =
 557   Unix.lseek fd 0  Unix.SEEK_CUR
 558
 559 let pr_pos fd = Printf.eprintf "At position %i\n%!" (pos fd)
 560
 561 let write fd s =
 562   let sl = String.length s in
 563   let ssl = Printf.sprintf "%020i" sl in
 564     ignore (Unix.write fd ssl 0 20);
 565     ignore (Unix.write fd s 0 (String.length s))
 566
 567 let rec really_read fd buffer start length =
 568   if length <= 0 then () else
 569     match Unix.read fd buffer start length with
 570         0 -> raise End_of_file
 571       | r -> really_read fd buffer (start + r) (length - r);;
 572
 573 let read fd =
 574   let buffer = String.create 20 in
 575   let _ =  really_read fd buffer 0 20 in
 576   let size = int_of_string buffer in
 577   let buffer = String.create size in
 578   let _ =  really_read fd buffer 0 size in
 579     buffer
 580
 581 let save_tag_table channel t =
 582   let t = Array.map (fun s -> Array.of_list (Ptset.Int.elements s)) t in
 583     Marshal.to_channel channel t []
 584
 585 let save t str =
 586   let fd = Unix.openfile str [ Unix.O_WRONLY;Unix.O_TRUNC;Unix.O_CREAT] 0o644 in
 587   let out_c = Unix.out_channel_of_descr fd in
 588   let _ = set_binary_mode_out out_c true in
 589     output_string out_c magic_string;
 590     output_char out_c '\n';
 591     output_string out_c version_string;
 592     output_char out_c '\n';
 593     save_tag_table out_c t.children;
 594     save_tag_table out_c t.siblings;
 595     save_tag_table out_c t.descendants;
 596     save_tag_table out_c t.followings;
 597     (* we need to move the fd to the correct position *)
 598     flush out_c;
 599     ignore (Unix.lseek fd (pos_out out_c) Unix.SEEK_SET);
 600     tree_save t.doc fd str;
 601     close_out out_c
 602 ;;
 603 let load_tag_table channel =
 604   let table : int array array = Marshal.from_channel channel in
 605     Array.map (fun a -> Ptset.Int.from_list (Array.to_list a)) table
 606
 607 let load ?(sample=64) ?(load_text=true) str =
 608   let fd = Unix.openfile str [ Unix.O_RDONLY ] 0o644 in
 609   let in_c = Unix.in_channel_of_descr fd in
 610   let _ = set_binary_mode_in in_c true in
 611   let load_table () =
 612     (let ms = input_line in_c in if ms <> magic_string then failwith "Invalid index file");
 613     (let vs = input_line in_c in if vs <> version_string then failwith "Invalid version file");
 614     let c = load_tag_table in_c in
 615     let s = load_tag_table in_c in
 616     let d = load_tag_table in_c in
 617     let f = load_tag_table in_c in
 618       c,s,d,f
 619   in
 620   let c, s, d, f = time ~msg:"Loading tag table"(load_table) () in
 621   ignore(Unix.lseek fd (pos_in in_c) Unix.SEEK_SET);
 622     let xml_tree = tree_load fd str load_text sample in
 623     let () = Tag.init (Obj.magic xml_tree) in
 624     let attributes = Ptset.Int.add Tag.attribute d.(Tag.attribute) in
 625     let elements = Ptset.Int.add Tag.document_node
 626       (Ptset.Int.remove Tag.pcdata
 627          (Ptset.Int.diff d.(Tag.document_node) attributes))
 628     in
 629     let tree = { doc = xml_tree;
 630                  attributes = attributes;
 631                  attribute_array = Array.of_list (Ptset.Int.elements attributes);
 632                  elements = elements;
 633                  children = c;
 634                  siblings = s;
 635                  descendants = d;
 636                  followings = f
 637              }
 638   in close_in in_c;
 639   tree
 640
 641
 642
 643
 644 let equal a b = a == b
 645
 646 let nts = function
 647     -1 -> "Nil"
 648   | i -> Printf.sprintf "Node (%i)"  i
 649
 650 let dump_node t = nts (Node.to_int t)
 651
 652
 653
 654 type query_result = { bv : bit_vector;
 655                       pos : node array;
 656                     }
 657
 658 external tree_flush : tree -> Unix.file_descr -> unit = "caml_xml_tree_flush"
 659 let flush t fd = tree_flush t.doc fd
 660
 661 external text_prefix : tree -> string -> query_result = "caml_text_collection_prefix_bv"
 662 let text_prefix t s = text_prefix t.doc s
 663
 664 external text_suffix : tree -> string -> query_result = "caml_text_collection_suffix_bv"
 665 let text_suffix t s = text_suffix t.doc s
 666
 667 external text_equals : tree -> string -> query_result = "caml_text_collection_equals_bv"
 668 let text_equals t s = text_equals t.doc s
 669
 670 external text_contains : tree -> string -> query_result = "caml_text_collection_contains_bv"
 671 let text_contains t s = text_contains t.doc s
 672
 673
 674 module Predicate = Hcons.Make (
 675   struct
 676     type _t = t
 677     type t = (_t -> node -> bool) ref
 678     let hash t = Hashtbl.hash t
 679     let equal t1 t2 = t1 == t2
 680 end)
 681
 682 let string_of_query query =
 683     match query with
 684       | `Prefix -> "starts-with"
 685       | `Suffix -> "ends-with"
 686       | `Equals -> "equals"
 687       | `Contains -> "contains"
 688 ;;
 689
 690 let query_fun = function
 691       | `Prefix -> text_prefix
 692       | `Suffix -> text_suffix
 693       | `Equals -> text_equals
 694       | `Contains -> text_contains
 695 ;;
 696
 697 let _pred_cache = Hashtbl.create 17
 698 ;;
 699 let mk_pred query s =
 700   let f = query_fun query in
 701   let memo = ref (fun _ _ -> failwith "Undefined") in
 702   memo := begin fun tree node ->
 703     let results =
 704       try Hashtbl.find _pred_cache (query,s) with
 705           Not_found ->
 706             time ~count:1 ~msg:(Printf.sprintf "Computing text query %s(%s)"
 707                                   (string_of_query query) s)
 708               (f tree) s
 709     in
 710     let bv = results.bv in
 711     memo := begin fun _ n ->
 712       let b =
 713         bit_vector_unsafe_get bv (Node.to_int n)
 714       in
 715       D_TRACE_(Printf.eprintf "Result of memoized call to query %s is %b for node %i\n" s b (Node.to_int n));
 716       b
 717     end;
 718     let b = bit_vector_unsafe_get bv (Node.to_int node) in
 719     D_TRACE_(Printf.eprintf "Result is %b for node %i\n" b (Node.to_int node));
 720     b
 721   end;
 722   Predicate.make memo
 723
 724
 725 let full_text_prefix t s = (text_prefix t s).pos
 726
 727 let full_text_suffix t s = (text_suffix t s).pos
 728
 729 let full_text_equals t s = (text_equals t s).pos
 730
 731 let full_text_contains t s = (text_contains t s).pos
 732
 733 let full_text_query q t s =
 734   let res = (query_fun q) t s in
 735   Hashtbl.replace _pred_cache (q,s) res;
 736   res.pos