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