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