src/ata.ml

   1 (***********************************************************************)
   2 (*                                                                     *)
   3 (*                               TAToo                                 *)
   4 (*                                                                     *)
   5 (*                     Kim Nguyen, LRI UMR8623                         *)
   6 (*                   Université Paris-Sud & CNRS                       *)
   7 (*                                                                     *)
   8 (*  Copyright 2010-2013 Université Paris-Sud and Centre National de la *)
   9 (*  Recherche Scientifique. All rights reserved.  This file is         *)
  10 (*  distributed under the terms of the GNU Lesser General Public       *)
  11 (*  License, with the special exception on linking described in file   *)
  12 (*  ../LICENSE.                                                        *)
  13 (*                                                                     *)
  14 (***********************************************************************)
  15
  16 INCLUDE "utils.ml"
  17 open Format
  18 open Misc
  19 type move = [ `First_child
  20             | `Next_sibling
  21             | `Parent
  22             | `Previous_sibling
  23             | `Stay ]
  24
  25 type predicate = Move of move * State.t
  26                  | Is_first_child
  27                  | Is_next_sibling
  28                  | Is of Tree.NodeKind.t
  29                  | Has_first_child
  30                  | Has_next_sibling
  31
  32 module Atom =
  33 struct
  34
  35   module Node =
  36   struct
  37     type t = predicate
  38     let equal n1 n2 = n1 = n2
  39     let hash n = Hashtbl.hash n
  40   end
  41
  42   include Hcons.Make(Node)
  43
  44   let print ppf a =
  45     match a.node with
  46     | Move (m, q) -> begin
  47       match m with
  48         `First_child -> fprintf ppf "%s" Pretty.down_arrow
  49       | `Next_sibling -> fprintf ppf "%s" Pretty.right_arrow
  50       | `Parent -> fprintf ppf "%s" Pretty.up_arrow
  51       | `Previous_sibling -> fprintf ppf "%s" Pretty.left_arrow
  52       | `Stay -> fprintf ppf "%s" Pretty.bullet
  53     end;
  54         fprintf ppf "%a" State.print q
  55     | Is_first_child -> fprintf ppf "%s?" Pretty.up_arrow
  56     | Is_next_sibling -> fprintf ppf "%s?" Pretty.left_arrow
  57     | Is k -> fprintf ppf "is-%a?" Tree.NodeKind.print k
  58     | Has_first_child -> fprintf ppf "%s?" Pretty.down_arrow
  59     | Has_next_sibling -> fprintf ppf "%s?" Pretty.right_arrow
  60
  61 end
  62
  63
  64 module Formula =
  65 struct
  66   include Boolean.Make(Atom)
  67   open Tree.NodeKind
  68   let mk_atom a = atom_ (Atom.make a)
  69   let is k = mk_atom (Is k)
  70
  71   let has_first_child = mk_atom Has_first_child
  72
  73   let has_next_sibling = mk_atom Has_next_sibling
  74
  75   let is_first_child = mk_atom Is_first_child
  76
  77   let is_next_sibling = mk_atom Is_next_sibling
  78
  79   let is_attribute = mk_atom (Is Attribute)
  80
  81   let is_element = mk_atom (Is Element)
  82
  83   let is_processing_instruction = mk_atom (Is ProcessingInstruction)
  84
  85   let is_comment = mk_atom (Is Comment)
  86
  87   let mk_move m q = mk_atom (Move(m,q))
  88   let first_child q =
  89     and_
  90       (mk_move `First_child q)
  91       has_first_child
  92
  93   let next_sibling q =
  94   and_
  95     (mk_move `Next_sibling q)
  96     has_next_sibling
  97
  98   let parent q =
  99   and_
 100     (mk_move `Parent  q)
 101     is_first_child
 102
 103   let previous_sibling q =
 104   and_
 105     (mk_move `Previous_sibling q)
 106     is_next_sibling
 107
 108   let stay q = mk_move `Stay q
 109
 110   let get_states phi =
 111     fold (fun phi acc ->
 112       match expr phi with
 113       | Boolean.Atom ({ Atom.node = Move(_,q) ; _ }, _) ->  StateSet.add q acc
 114       | _ -> acc
 115     ) phi StateSet.empty
 116
 117 end
 118
 119 module Transition =
 120   struct
 121     include Hcons.Make (struct
 122   type t = State.t * QNameSet.t * Formula.t
 123   let equal (a, b, c) (d, e, f) =
 124     a == d && b == e && c == f
 125   let hash (a, b, c) =
 126     HASHINT4 (PRIME1, a, ((QNameSet.uid b) :> int), ((Formula.uid c) :> int))
 127 end)
 128     let print ppf t =
 129       let q, l, f = t.node in
 130       fprintf ppf "%a, %a %s %a"
 131         State.print q
 132         QNameSet.print l
 133         Pretty.double_right_arrow
 134         Formula.print f
 135   end
 136
 137
 138 module TransList : sig
 139   include Hlist.S with type elt = Transition.t
 140   val print : Format.formatter -> ?sep:string -> t -> unit
 141 end =
 142   struct
 143     include Hlist.Make(Transition)
 144     let print ppf ?(sep="\n") l =
 145       iter (fun t ->
 146         let q, lab, f = Transition.node t in
 147         fprintf ppf "%a, %a -> %a%s" State.print q QNameSet.print lab Formula.print f sep) l
 148   end
 149
 150
 151
 152 type t = {
 153   id : Uid.t;
 154   mutable states : StateSet.t;
 155   mutable starting_states : StateSet.t;
 156   mutable selecting_states: StateSet.t;
 157   transitions: (State.t, (QNameSet.t*Formula.t) list) Hashtbl.t;
 158 }
 159
 160 let uid t = t.id
 161
 162 let get_states a = a.states
 163 let get_starting_states a = a.starting_states
 164 let get_selecting_states a = a.selecting_states
 165
 166
 167 let _pr_buff = Buffer.create 50
 168 let _str_fmt = formatter_of_buffer _pr_buff
 169 let _flush_str_fmt () = pp_print_flush _str_fmt ();
 170   let s = Buffer.contents _pr_buff in
 171   Buffer.clear _pr_buff; s
 172
 173 let print fmt a =
 174   let _ = _flush_str_fmt() in
 175   fprintf fmt
 176     "Internal UID: %i@\n\
 177      States: %a@\n\
 178      Starting states: %a@\n\
 179      Selection states: %a@\n\
 180      Alternating transitions:@\n"
 181     (a.id :> int)
 182     StateSet.print a.states
 183     StateSet.print a.starting_states
 184     StateSet.print a.selecting_states;
 185   let trs =
 186     Hashtbl.fold
 187       (fun q t acc -> List.fold_left (fun acc (s , f) -> (q,s,f)::acc) acc t)
 188       a.transitions
 189       []
 190   in
 191   let sorted_trs = List.stable_sort (fun (q1, s1, _) (q2, s2, _) ->
 192     let c = State.compare q1 q2 in - (if c == 0 then QNameSet.compare s1 s2 else c))
 193     trs
 194   in
 195   let _ = _flush_str_fmt () in
 196   let strs_strings, max_pre, max_all = List.fold_left (fun (accl, accp, acca) (q, s, f) ->
 197     let s1 = State.print _str_fmt q; _flush_str_fmt () in
 198     let s2 = QNameSet.print _str_fmt s;  _flush_str_fmt () in
 199     let s3 = Formula.print _str_fmt f;  _flush_str_fmt () in
 200     let pre = Pretty.length s1 + Pretty.length s2 in
 201     let all = Pretty.length s3 in
 202     ( (q, s1, s2, s3) :: accl, max accp pre, max acca all)
 203   ) ([], 0, 0) sorted_trs
 204   in
 205   let line = Pretty.line (max_all + max_pre + 6) in
 206   let prev_q = ref State.dummy in
 207   fprintf fmt "%s@\n" line;
 208   List.iter (fun (q, s1, s2, s3) ->
 209     if !prev_q != q && !prev_q != State.dummy then fprintf fmt "%s@\n"  line;
 210     prev_q := q;
 211     fprintf fmt "%s, %s" s1 s2;
 212     fprintf fmt "%s" (Pretty.padding (max_pre - Pretty.length s1 - Pretty.length s2));
 213     fprintf fmt " %s  %s@\n" Pretty.right_arrow s3;
 214   ) strs_strings;
 215   fprintf fmt "%s@\n" line
 216
 217
 218 let get_trans a tag states =
 219   StateSet.fold (fun q acc0 ->
 220     try
 221       let trs = Hashtbl.find a.transitions q in
 222       List.fold_left (fun acc1 (labs, phi) ->
 223         if QNameSet.mem tag labs then
 224           TransList.cons (Transition.make (q, labs, phi)) acc1
 225         else acc1) acc0 trs
 226     with Not_found -> acc0
 227   ) states TransList.nil
 228
 229
 230 let get_form a tag q =
 231   try
 232     let trs = Hashtbl.find a.transitions q in
 233     List.fold_left (fun aphi (labs, phi) ->
 234       if QNameSet.mem tag labs then Formula.or_ aphi phi else aphi
 235     ) Formula.false_ trs
 236   with
 237     Not_found -> Formula.false_
 238
 239 (*
 240   [complete transitions a] ensures that for each state q
 241   and each symbols s in the alphabet, a transition q, s exists.
 242   (adding q, s -> F when necessary).
 243 *)
 244
 245 let complete_transitions a =
 246   StateSet.iter (fun q ->
 247     if StateSet.mem q a.starting_states then ()
 248     else
 249       let qtrans = Hashtbl.find a.transitions q in
 250       let rem =
 251         List.fold_left (fun rem (labels, _) ->
 252           QNameSet.diff rem labels) QNameSet.any qtrans
 253       in
 254       let nqtrans =
 255         if QNameSet.is_empty rem then qtrans
 256         else
 257           (rem, Formula.false_) :: qtrans
 258       in
 259       Hashtbl.replace a.transitions q nqtrans
 260   ) a.states
 261
 262 (* [cleanup_states] remove states that do not lead to a
 263    selecting states *)
 264
 265 let cleanup_states a =
 266   let memo = ref StateSet.empty in
 267   let rec loop q =
 268     if not (StateSet.mem q !memo) then begin
 269       memo := StateSet.add q !memo;
 270       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
 271       List.iter (fun (_, phi) ->
 272         StateSet.iter loop (Formula.get_states phi)) trs
 273     end
 274   in
 275   StateSet.iter loop a.selecting_states;
 276   let unused = StateSet.diff a.states !memo in
 277   StateSet.iter (fun q -> Hashtbl.remove a.transitions q) unused;
 278   a.states <- !memo
 279
 280 (* [normalize_negations a] removes negative atoms in the formula
 281    complementing the sub-automaton in the negative states.
 282    [TODO check the meaning of negative upward arrows]
 283 *)
 284
 285 let normalize_negations auto =
 286   let memo_state = Hashtbl.create 17 in
 287   let todo = Queue.create () in
 288   let rec flip b f =
 289     match Formula.expr f with
 290       Boolean.True | Boolean.False -> if b then f else Formula.not_ f
 291     | Boolean.Or(f1, f2) -> (if b then Formula.or_ else Formula.and_)(flip b f1) (flip b f2)
 292     | Boolean.And(f1, f2) -> (if b then Formula.and_ else Formula.or_)(flip b f1) (flip b f2)
 293     | Boolean.Atom(a, b') -> begin
 294       match a.Atom.node with
 295       | Move (m,  q) ->
 296           if b == b' then begin
 297           (* a appears positively, either no negation or double negation *)
 298             if not (Hashtbl.mem memo_state (q,b)) then Queue.add (q,true) todo;
 299             Formula.mk_atom (Move(m, q))
 300           end else begin
 301         (* need to reverse the atom
 302            either we have a positive state deep below a negation
 303            or we have a negative state in a positive formula
 304            b' = sign of the state
 305            b = sign of the enclosing formula
 306         *)
 307             let not_q =
 308               try
 309             (* does the inverted state of q exist ? *)
 310                 Hashtbl.find memo_state (q, false)
 311               with
 312                 Not_found ->
 313               (* create a new state and add it to the todo queue *)
 314                   let nq = State.make () in
 315                   auto.states <- StateSet.add nq auto.states;
 316                   Hashtbl.add memo_state (q, false) nq;
 317                   Queue.add (q, false) todo; nq
 318             in
 319             Formula.mk_atom (Move (m,not_q))
 320           end
 321       | _ -> if b then f else Formula.not_ f
 322     end
 323   in
 324   (* states that are not reachable from a selection stat are not interesting *)
 325   StateSet.iter (fun q -> Queue.add (q, true) todo) auto.selecting_states;
 326
 327   while not (Queue.is_empty todo) do
 328     let (q, b) as key = Queue.pop todo in
 329     let q' =
 330       try
 331         Hashtbl.find memo_state key
 332       with
 333         Not_found ->
 334           let nq = if b then q else
 335               let nq = State.make () in
 336               auto.states <- StateSet.add nq auto.states;
 337               nq
 338           in
 339           Hashtbl.add memo_state key nq; nq
 340     in
 341     let trans = try Hashtbl.find auto.transitions q with Not_found -> [] in
 342     let trans' = List.map (fun (lab, f) -> lab, flip b f) trans in
 343     Hashtbl.replace auto.transitions q' trans';
 344   done;
 345   cleanup_states auto
 346
 347
 348
 349
 350
 351 module Builder =
 352   struct
 353     type auto = t
 354     type t = auto
 355     let next = Uid.make_maker ()
 356
 357     let make () =
 358       let auto =
 359         {
 360           id = next ();
 361           states = StateSet.empty;
 362           starting_states = StateSet.empty;
 363           selecting_states = StateSet.empty;
 364           transitions = Hashtbl.create MED_H_SIZE;
 365         }
 366       in
 367       (*
 368       at_exit (fun () ->
 369         let n4 = ref 0 in
 370         let n2 = ref 0 in
 371         Cache.N2.iteri (fun _ _ _ b -> if b then incr n2) auto.cache2;
 372         Cache.N4.iteri (fun _ _ _ _ _ b -> if b then incr n4) auto.cache4;
 373         Logger.msg `STATS "automaton %i, cache2: %i entries, cache6: %i entries"
 374           (auto.id :> int) !n2 !n4;
 375         let c2l, c2u = Cache.N2.stats auto.cache2 in
 376         let c4l, c4u = Cache.N4.stats auto.cache4 in
 377         Logger.msg `STATS
 378           "cache2: length: %i, used: %i, occupation: %f"
 379           c2l c2u (float c2u /. float c2l);
 380         Logger.msg `STATS
 381           "cache4: length: %i, used: %i, occupation: %f"
 382           c4l c4u (float c4u /. float c4l)
 383
 384       ); *)
 385       auto
 386
 387     let add_state a ?(starting=false) ?(selecting=false) q =
 388       a.states <- StateSet.add q a.states;
 389       if starting then a.starting_states <- StateSet.add q a.starting_states;
 390       if selecting then a.selecting_states <- StateSet.add q a.selecting_states
 391
 392     let add_trans a q s f =
 393       if not (StateSet.mem q a.states) then add_state a q;
 394       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
 395       let cup, ntrs =
 396         List.fold_left (fun (acup, atrs) (labs, phi) ->
 397           let lab1 = QNameSet.inter labs s in
 398           let lab2 = QNameSet.diff labs s in
 399           let tr1 =
 400             if QNameSet.is_empty lab1 then []
 401             else [ (lab1, Formula.or_ phi f) ]
 402           in
 403           let tr2 =
 404             if QNameSet.is_empty lab2 then []
 405             else [ (lab2, Formula.or_ phi f) ]
 406           in
 407           (QNameSet.union acup labs, tr1@ tr2 @ atrs)
 408         ) (QNameSet.empty, []) trs
 409       in
 410       let rem = QNameSet.diff s cup in
 411       let ntrs = if QNameSet.is_empty rem then ntrs
 412         else (rem, f) :: ntrs
 413       in
 414       Hashtbl.replace a.transitions q ntrs
 415
 416     let finalize a =
 417       complete_transitions a;
 418       normalize_negations a;
 419       a
 420   end
 421
 422
 423 let map_set f s =
 424   StateSet.fold (fun q a -> StateSet.add (f q) a) s StateSet.empty
 425
 426 let map_hash fk fv h =
 427   let h' = Hashtbl.create (Hashtbl.length h) in
 428   let () = Hashtbl.iter (fun k v -> Hashtbl.add h' (fk k) (fv v)) h in
 429   h'
 430
 431 let rec map_form f phi =
 432   match Formula.expr phi with
 433   | Boolean.Or(phi1, phi2) -> Formula.or_ (map_form f phi1) (map_form f phi2)
 434   | Boolean.And(phi1, phi2) -> Formula.and_ (map_form f phi1) (map_form f phi2)
 435   | Boolean.Atom({ Atom.node = Move(m,q); _}, b) ->
 436       let a = Formula.mk_atom (Move (m,f q)) in
 437       if b then a else Formula.not_ a
 438   | _ -> phi
 439
 440 let rename_states mapper a =
 441   let rename q = try Hashtbl.find mapper q with Not_found -> q in
 442   { Builder.make () with
 443     states = map_set rename a.states;
 444     starting_states = map_set rename a.starting_states;
 445     selecting_states = map_set rename a.selecting_states;
 446     transitions =
 447       map_hash
 448         rename
 449         (fun l ->
 450           (List.map (fun (labels, form) -> (labels, map_form rename form)) l))
 451         a.transitions;
 452   }
 453
 454 let copy a =
 455   let mapper = Hashtbl.create MED_H_SIZE in
 456   let () =
 457     StateSet.iter (fun q -> Hashtbl.add mapper q (State.make())) a.states
 458   in
 459   rename_states mapper a
 460
 461
 462 let concat a1 a2 =
 463   let a1 = copy a1 in
 464   let a2 = copy a2 in
 465   let link_phi =
 466     StateSet.fold
 467       (fun q phi -> Formula.(or_ (stay q) phi))
 468       a1.selecting_states Formula.false_
 469   in
 470   Hashtbl.iter (fun q trs -> Hashtbl.add a1.transitions q trs)
 471     a2.transitions;
 472   StateSet.iter
 473     (fun q ->
 474       Hashtbl.replace a1.transitions q [(QNameSet.any, link_phi)])
 475     a2.starting_states;
 476   { a1 with
 477     states = StateSet.union a1.states a2.states;
 478     selecting_states = a2.selecting_states;
 479     transitions = a1.transitions;
 480   }
 481
 482 let merge a1 a2 =
 483   let a1 = copy a1 in
 484   let a2 = copy a2 in
 485   { a1 with
 486     states = StateSet.union a1.states a2.states;
 487     selecting_states = StateSet.union a1.selecting_states a2.selecting_states;
 488     starting_states = StateSet.union a1.starting_states a2.starting_states;
 489     transitions =
 490       let () =
 491         Hashtbl.iter (fun k v -> Hashtbl.add a1.transitions k v) a2.transitions
 492       in
 493       a1.transitions
 494   }