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