c045aaff0560fbb67b647163cfeb9fcc7c94322d
[tatoo.git] / 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 module Move =
26   struct
27     type t = move
28     type 'a table = 'a array
29     let idx = function
30       | `First_child -> 0
31       | `Next_sibling -> 1
32       | `Parent -> 2
33       | `Previous_sibling -> 3
34       | `Stay -> 4
35     let ridx = function
36       | 0 -> `First_child
37       | 1 -> `Next_sibling
38       | 2 -> `Parent
39       | 3 -> `Previous_sibling
40       | 4 -> `Stay
41       | _ -> assert false
42
43     let create_table a = Array.make 5 a
44     let get m k = m.(idx k)
45     let set m k v = m.(idx k) <- v
46     let iter f m = Array.iteri (fun i v -> f (ridx i) v) m
47     let fold f m acc =
48       let acc = ref acc in
49       iter (fun i v -> acc := f i v !acc) m;
50       !acc
51     let for_all p m =
52       try
53         iter (fun i v -> if not (p i v) then raise Exit) m;
54         true
55       with
56         Exit -> false
57     let for_all2 p m1 m2 =
58       try
59         for i = 0 to 4 do
60           let v1 = m1.(i)
61           and v2 = m2.(i) in
62           if not (p (ridx i) v1 v2) then raise Exit
63         done;
64         true
65       with
66         Exit -> false
67
68     let exists p m =
69       try
70         iter (fun i v -> if p i v then raise Exit) m;
71         false
72       with
73         Exit -> true
74     let print ppf m =
75       match m with
76         `First_child -> fprintf ppf "%s" Pretty.down_arrow
77       | `Next_sibling -> fprintf ppf "%s" Pretty.right_arrow
78       | `Parent -> fprintf ppf "%s" Pretty.up_arrow
79       | `Previous_sibling -> fprintf ppf "%s" Pretty.left_arrow
80       | `Stay -> fprintf ppf "%s" Pretty.bullet
81
82     let print_table pr_e ppf m =
83       iter (fun i v -> fprintf ppf "%a: %a" print i pr_e v;
84         if (idx i) < 4 then fprintf ppf ", ") m
85   end
86
87 type predicate = Move of move * State.t
88                  | Is_first_child
89                  | Is_next_sibling
90                  | Is of Tree.NodeKind.t
91                  | Has_first_child
92                  | Has_next_sibling
93
94 module Atom =
95 struct
96
97   module Node =
98   struct
99     type t = predicate
100     let equal n1 n2 = n1 = n2
101     let hash n = Hashtbl.hash n
102   end
103
104   include Hcons.Make(Node)
105
106   let print ppf a =
107     match a.node with
108     | Move (m, q) ->
109       fprintf ppf "%a%a" Move.print m State.print q
110     | Is_first_child -> fprintf ppf "%s?" Pretty.up_arrow
111     | Is_next_sibling -> fprintf ppf "%s?" Pretty.left_arrow
112     | Is k -> fprintf ppf "is-%a?" Tree.NodeKind.print k
113     | Has_first_child -> fprintf ppf "%s?" Pretty.down_arrow
114     | Has_next_sibling -> fprintf ppf "%s?" Pretty.right_arrow
115
116 end
117
118
119 module Formula =
120 struct
121   include Boolean.Make(Atom)
122   open Tree.NodeKind
123   let mk_atom a = atom_ (Atom.make a)
124   let is k = mk_atom (Is k)
125
126   let has_first_child = mk_atom Has_first_child
127
128   let has_next_sibling = mk_atom Has_next_sibling
129
130   let is_first_child = mk_atom Is_first_child
131
132   let is_next_sibling = mk_atom Is_next_sibling
133
134   let is_attribute = mk_atom (Is Attribute)
135
136   let is_element = mk_atom (Is Element)
137
138   let is_processing_instruction = mk_atom (Is ProcessingInstruction)
139
140   let is_comment = mk_atom (Is Comment)
141
142   let mk_move m q = mk_atom (Move(m,q))
143   let first_child q =
144     and_
145       (mk_move `First_child q)
146       has_first_child
147
148   let next_sibling q =
149   and_
150     (mk_move `Next_sibling q)
151     has_next_sibling
152
153   let parent q =
154   and_
155     (mk_move `Parent  q)
156     is_first_child
157
158   let previous_sibling q =
159   and_
160     (mk_move `Previous_sibling q)
161     is_next_sibling
162
163   let stay q = mk_move `Stay q
164
165   let get_states_by_move phi =
166     let table = Move.create_table StateSet.empty in
167     iter (fun phi ->
168       match expr phi with
169       | Boolean.Atom ({ Atom.node = Move(v,q) ; _ }, _) ->
170         let s = Move.get table v in
171         Move.set table v (StateSet.add q s)
172       | _ -> ()
173     ) phi;
174     table
175   let get_states phi =
176     let table = get_states_by_move phi in
177     Move.fold (fun _ s acc -> StateSet.union s acc) table StateSet.empty
178
179 end
180
181 module Transition =
182   struct
183     include Hcons.Make (struct
184   type t = State.t * QNameSet.t * Formula.t
185   let equal (a, b, c) (d, e, f) =
186     a == d && b == e && c == f
187   let hash ((a, b, c) : t) =
188     HASHINT4 (PRIME1, ((a) :> int), ((QNameSet.uid b) :> int), ((Formula.uid c) :> int))
189 end)
190     let print ppf t =
191       let q, l, f = t.node in
192       fprintf ppf "%a, %a %s %a"
193         State.print q
194         QNameSet.print l
195         Pretty.left_arrow
196         Formula.print f
197   end
198
199
200 module TransList : sig
201   include Hlist.S with type elt = Transition.t
202   val print : ?sep:string -> Format.formatter -> t -> unit
203 end =
204   struct
205     include Hlist.Make(Transition)
206     let print ?(sep="\n") ppf l =
207       iter (fun t ->
208           fprintf ppf "%a%s" Transition.print t sep) l
209   end
210
211
212
213 type t = {
214   id : Uid.t;
215   mutable states : StateSet.t;
216   mutable starting_states : StateSet.t;
217   mutable selecting_states: StateSet.t;
218   transitions: (State.t, (QNameSet.t*Formula.t) list) Hashtbl.t;
219   mutable ranked_states : StateSet.t array
220 }
221
222 let uid t = t.id
223
224 let get_states a = a.states
225 let get_starting_states a = a.starting_states
226 let get_selecting_states a = a.selecting_states
227 let get_states_by_rank a = a.ranked_states
228 let get_max_rank a = Array.length a.ranked_states - 1
229
230 let _pr_buff = Buffer.create 50
231 let _str_fmt = formatter_of_buffer _pr_buff
232 let _flush_str_fmt () = pp_print_flush _str_fmt ();
233   let s = Buffer.contents _pr_buff in
234   Buffer.clear _pr_buff; s
235
236 let print fmt a =
237   let _ = _flush_str_fmt() in
238   fprintf fmt
239     "Internal UID: %i@\n\
240      States: %a@\n\
241      Number of states: %i@\n\
242      Starting states: %a@\n\
243      Selection states: %a@\n\
244      Ranked states: %a@\n\
245      Alternating transitions:@\n"
246     (a.id :> int)
247     StateSet.print a.states
248     (StateSet.cardinal a.states)
249     StateSet.print a.starting_states
250     StateSet.print a.selecting_states
251     (let r = ref 0 in Pretty.print_array ~sep:", " (fun ppf s ->
252       fprintf ppf "%i:%a" !r StateSet.print s; incr r)) a.ranked_states;
253   let trs =
254     Hashtbl.fold
255       (fun q t acc -> List.fold_left (fun acc (s , f) -> (q,s,f)::acc) acc t)
256       a.transitions
257       []
258   in
259   let sorted_trs = List.stable_sort (fun (q1, s1, _) (q2, s2, _) ->
260     let c = State.compare q2 q1 in if c == 0 then QNameSet.compare s2 s1 else c)
261     trs
262   in
263   let _ = _flush_str_fmt () in
264   let strs_strings, max_pre, max_all =
265     List.fold_left (fun (accl, accp, acca) (q, s, f) ->
266       let s1 = State.print _str_fmt q; _flush_str_fmt () in
267       let s2 = QNameSet.print _str_fmt s;  _flush_str_fmt () in
268       let s3 = Formula.print _str_fmt f;  _flush_str_fmt () in
269       let pre = Pretty.length s1 + Pretty.length s2 in
270       let all = Pretty.length s3 in
271       ( (q, s1, s2, s3) :: accl, max accp pre, max acca all)
272     ) ([], 0, 0) sorted_trs
273   in
274   let line = Pretty.line (max_all + max_pre + 6) in
275   let prev_q = ref State.dummy_state in
276   fprintf fmt "%s@\n" line;
277   List.iter (fun (q, s1, s2, s3) ->
278     if !prev_q != q && !prev_q != State.dummy_state then fprintf fmt "%s@\n"  line;
279     prev_q := q;
280     fprintf fmt "%s, %s" s1 s2;
281     fprintf fmt "%s"
282       (Pretty.padding (max_pre - Pretty.length s1 - Pretty.length s2));
283     fprintf fmt " %s  %s@\n" Pretty.left_arrow s3;
284   ) strs_strings;
285   fprintf fmt "%s@\n" line
286
287
288 let get_trans a tag states =
289   StateSet.fold (fun q acc0 ->
290     try
291       let trs = Hashtbl.find a.transitions q in
292       List.fold_left (fun acc1 (labs, phi) ->
293         if QNameSet.mem tag labs then
294           TransList.cons (Transition.make (q, labs, phi)) acc1
295         else acc1) acc0 trs
296     with Not_found -> acc0
297   ) states TransList.nil
298
299
300 let get_form a tag q =
301   try
302     let trs = Hashtbl.find a.transitions q in
303     List.fold_left (fun aphi (labs, phi) ->
304       if QNameSet.mem tag labs then Formula.or_ aphi phi else aphi
305     ) Formula.false_ trs
306   with
307     Not_found -> Formula.false_
308
309 (*
310   [complete transitions a] ensures that for each state q
311   and each symbols s in the alphabet, a transition q, s exists.
312   (adding q, s -> F when necessary).
313 *)
314
315 let complete_transitions a =
316   StateSet.iter (fun q ->
317     if StateSet.mem q a.starting_states then ()
318     else
319       let qtrans = Hashtbl.find a.transitions q in
320       let rem =
321         List.fold_left (fun rem (labels, _) ->
322           QNameSet.diff rem labels) QNameSet.any qtrans
323       in
324       let nqtrans =
325         if QNameSet.is_empty rem then qtrans
326         else
327           (rem, Formula.false_) :: qtrans
328       in
329       Hashtbl.replace a.transitions q nqtrans
330   ) a.states
331
332 (* [cleanup_states] remove states that do not lead to a
333    selecting states *)
334
335 let cleanup_states a =
336   let memo = ref StateSet.empty in
337   let rec loop q =
338     if not (StateSet.mem q !memo) then begin
339       memo := StateSet.add q !memo;
340       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
341       List.iter (fun (_, phi) ->
342         StateSet.iter loop (Formula.get_states phi)) trs
343     end
344   in
345   StateSet.iter loop a.selecting_states;
346   let unused = StateSet.diff a.states !memo in
347   StateSet.iter (fun q -> Hashtbl.remove a.transitions q) unused;
348   a.states <- !memo
349
350 (* [normalize_negations a] removes negative atoms in the formula
351    complementing the sub-automaton in the negative states.
352    [TODO check the meaning of negative upward arrows]
353 *)
354
355 let normalize_negations auto =
356   let memo_state = Hashtbl.create 17 in
357   let todo = Queue.create () in
358   let rec flip b f =
359     match Formula.expr f with
360       Boolean.True | Boolean.False -> if b then f else Formula.not_ f
361     | Boolean.Or(f1, f2) ->
362       (if b then Formula.or_ else Formula.and_)(flip b f1) (flip b f2)
363     | Boolean.And(f1, f2) ->
364       (if b then Formula.and_ else Formula.or_)(flip b f1) (flip b f2)
365     | Boolean.Atom(a, b') -> begin
366       match a.Atom.node with
367       | Move (m,  q) ->
368           if b == b' then begin
369           (* a appears positively, either no negation or double negation *)
370             if not (Hashtbl.mem memo_state (q,b)) then Queue.add (q,true) todo;
371             Formula.mk_atom (Move(m, q))
372           end else begin
373         (* need to reverse the atom
374            either we have a positive state deep below a negation
375            or we have a negative state in a positive formula
376            b' = sign of the state
377            b = sign of the enclosing formula
378         *)
379             let not_q =
380               try
381             (* does the inverted state of q exist ? *)
382                 Hashtbl.find memo_state (q, false)
383               with
384                 Not_found ->
385               (* create a new state and add it to the todo queue *)
386                   let nq = State.next () in
387                   auto.states <- StateSet.add nq auto.states;
388                   Hashtbl.add memo_state (q, false) nq;
389                   Queue.add (q, false) todo; nq
390             in
391             Formula.mk_atom (Move (m,not_q))
392           end
393       | _ -> if b then f else Formula.not_ f
394     end
395   in
396   (* states that are not reachable from a selection stat are not interesting *)
397   StateSet.iter (fun q -> Queue.add (q, true) todo) auto.selecting_states;
398
399   while not (Queue.is_empty todo) do
400     let (q, b) as key = Queue.pop todo in
401     if not (StateSet.mem q auto.starting_states) then
402       let q' =
403         try
404           Hashtbl.find memo_state key
405         with
406           Not_found ->
407             let nq = if b then q else
408                 let nq = State.next () in
409                 auto.states <- StateSet.add nq auto.states;
410                 nq
411             in
412             Hashtbl.add memo_state key nq; nq
413       in
414       let trans = try Hashtbl.find auto.transitions q with Not_found -> [] in
415       let trans' = List.map (fun (lab, f) -> lab, flip b f) trans in
416       Hashtbl.replace auto.transitions q' trans';
417   done;
418   cleanup_states auto
419
420 (* [compute_dependencies auto] returns a hash table storing for each
421    states [q] a Move.table containing the set of states on which [q]
422    depends (loosely). [q] depends on [q'] if there is a transition
423    [q, {...} -> phi], where [q'] occurs in [phi].
424 *)
425 let compute_dependencies auto =
426   let edges = Hashtbl.create 17 in
427   StateSet.iter
428     (fun q -> Hashtbl.add edges q (Move.create_table StateSet.empty))
429     auto.starting_states;
430   Hashtbl.iter (fun q trans ->
431     let moves = try Hashtbl.find edges q with Not_found ->
432       let m = Move.create_table StateSet.empty in
433       Hashtbl.add edges q m;
434       m
435     in
436     List.iter (fun (_, phi) ->
437       let m_phi = Formula.get_states_by_move phi in
438       Move.iter (fun m set ->
439         Move.set moves m (StateSet.union set (Move.get moves m)))
440         m_phi) trans) auto.transitions;
441
442   edges
443
444 let state_prerequisites dir auto q =
445   Hashtbl.fold (fun q' trans acc ->
446     List.fold_left (fun acc (_, phi) ->
447       let m_phi = Formula.get_states_by_move phi in
448       if StateSet.mem q (Move.get m_phi dir)
449       then StateSet.add q' acc else acc)
450       acc trans) auto.transitions StateSet.empty
451
452 let compute_rank auto =
453   let dependencies = compute_dependencies auto in
454   let upward = [ `Stay ; `Parent ; `Previous_sibling ] in
455   let downward = [ `Stay; `First_child; `Next_sibling ] in
456   let swap dir = if dir == upward then downward else upward in
457   let is_satisfied dir q t =
458     Move.for_all (fun d set ->
459       if List.mem d dir then
460         StateSet.(is_empty (remove q set))
461       else StateSet.is_empty set) t
462   in
463   let update_dependencies dir initacc =
464     let rec loop acc =
465       let new_acc =
466         Hashtbl.fold (fun q deps acc ->
467           let to_remove = StateSet.union acc initacc in
468           List.iter
469             (fun m ->
470               Move.set deps m (StateSet.diff (Move.get deps m) to_remove)
471             )
472             dir;
473           if is_satisfied dir q deps then StateSet.add q acc else acc
474         ) dependencies acc
475       in
476       if acc == new_acc then new_acc else loop new_acc
477     in
478     let satisfied = loop StateSet.empty in
479     StateSet.iter (fun q ->
480       Hashtbl.remove dependencies q) satisfied;
481     satisfied
482   in
483   let current_states = ref StateSet.empty in
484   let rank_list = ref [] in
485   let rank = ref 0 in
486   let current_dir = ref upward in
487   let detect_cycle = ref 0 in
488   while Hashtbl.length dependencies != 0 do
489     let new_sat = update_dependencies !current_dir !current_states in
490     if StateSet.is_empty new_sat then incr detect_cycle;
491     if !detect_cycle > 2 then assert false;
492     rank_list := (!rank, new_sat) :: !rank_list;
493     rank := !rank + 1;
494     current_dir := swap !current_dir;
495     current_states := StateSet.union new_sat !current_states;
496   done;
497   let by_rank = Hashtbl.create 17 in
498   List.iter (fun (r,s) ->
499     let set = try Hashtbl.find by_rank r with Not_found -> StateSet.empty in
500     Hashtbl.replace by_rank r (StateSet.union s set)) !rank_list;
501   auto.ranked_states <-
502     Array.init (Hashtbl.length by_rank) (fun i -> Hashtbl.find by_rank i)
503
504
505 module Builder =
506   struct
507     type auto = t
508     type t = auto
509     let next = Uid.make_maker ()
510
511     let make () =
512       let auto =
513         {
514           id = next ();
515           states = StateSet.empty;
516           starting_states = StateSet.empty;
517           selecting_states = StateSet.empty;
518           transitions = Hashtbl.create MED_H_SIZE;
519           ranked_states = [| |]
520         }
521       in
522       auto
523
524     let add_state a ?(starting=false) ?(selecting=false) q =
525       a.states <- StateSet.add q a.states;
526       if starting then a.starting_states <- StateSet.add q a.starting_states;
527       if selecting then a.selecting_states <- StateSet.add q a.selecting_states
528
529     let add_trans a q s f =
530       if not (StateSet.mem q a.states) then add_state a q;
531       let trs = try Hashtbl.find a.transitions q with Not_found -> [] in
532       let cup, ntrs =
533         List.fold_left (fun (acup, atrs) (labs, phi) ->
534           let lab1 = QNameSet.inter labs s in
535           let lab2 = QNameSet.diff labs s in
536           let tr1 =
537             if QNameSet.is_empty lab1 then []
538             else [ (lab1, Formula.or_ phi f) ]
539           in
540           let tr2 =
541             if QNameSet.is_empty lab2 then []
542             else [ (lab2, Formula.or_ phi f) ]
543           in
544           (QNameSet.union acup labs, tr1@ tr2 @ atrs)
545         ) (QNameSet.empty, []) trs
546       in
547       let rem = QNameSet.diff s cup in
548       let ntrs = if QNameSet.is_empty rem then ntrs
549         else (rem, f) :: ntrs
550       in
551       Hashtbl.replace a.transitions q ntrs
552
553     let finalize a =
554       complete_transitions a;
555       normalize_negations a;
556       compute_rank a;
557       a
558   end
559
560
561 let map_set f s =
562   StateSet.fold (fun q a -> StateSet.add (f q) a) s StateSet.empty
563
564 let map_hash fk fv h =
565   let h' = Hashtbl.create (Hashtbl.length h) in
566   let () = Hashtbl.iter (fun k v -> Hashtbl.add h' (fk k) (fv v)) h in
567   h'
568
569 let rec map_form f phi =
570   match Formula.expr phi with
571   | Boolean.Or(phi1, phi2) -> Formula.or_ (map_form f phi1) (map_form f phi2)
572   | Boolean.And(phi1, phi2) -> Formula.and_ (map_form f phi1) (map_form f phi2)
573   | Boolean.Atom({ Atom.node = Move(m,q); _}, b) ->
574       let a = Formula.mk_atom (Move (m,f q)) in
575       if b then a else Formula.not_ a
576   | _ -> phi
577
578 let rename_states mapper a =
579   let rename q = try Hashtbl.find mapper q with Not_found -> q in
580   { Builder.make () with
581     states = map_set rename a.states;
582     starting_states = map_set rename a.starting_states;
583     selecting_states = map_set rename a.selecting_states;
584     transitions =
585       map_hash
586         rename
587         (fun l ->
588           (List.map (fun (labels, form) -> (labels, map_form rename form)) l))
589         a.transitions;
590     ranked_states = Array.map (map_set rename) a.ranked_states
591   }
592
593 let copy a =
594   let mapper = Hashtbl.create MED_H_SIZE in
595   let () =
596     StateSet.iter (fun q -> Hashtbl.add mapper q (State.next())) a.states
597   in
598   rename_states mapper a
599
600
601 let concat a1 a2 =
602   let a1 = copy a1 in
603   let a2 = copy a2 in
604   let link_phi =
605     StateSet.fold
606       (fun q phi -> Formula.(or_ (stay q) phi))
607       a1.selecting_states Formula.false_
608   in
609   Hashtbl.iter (fun q trs -> Hashtbl.add a1.transitions q trs)
610     a2.transitions;
611   StateSet.iter
612     (fun q ->
613       Hashtbl.replace a1.transitions q [(QNameSet.any, link_phi)])
614     a2.starting_states;
615   let a = { a1 with
616     states = StateSet.union a1.states a2.states;
617     selecting_states = a2.selecting_states;
618     transitions = a1.transitions;
619   }
620   in compute_rank a; a
621
622 let merge a1 a2 =
623   let a1 = copy a1 in
624   let a2 = copy a2 in
625   let a = { a1 with
626     states = StateSet.union a1.states a2.states;
627     selecting_states = StateSet.union a1.selecting_states a2.selecting_states;
628     starting_states = StateSet.union a1.starting_states a2.starting_states;
629     transitions =
630       let () =
631         Hashtbl.iter (fun k v -> Hashtbl.add a1.transitions k v) a2.transitions
632       in
633       a1.transitions
634   } in
635   compute_rank a ; a
636
637
638 let link a1 a2 q link_phi =
639   let a = { a1 with
640     states = StateSet.union a1.states a2.states;
641     selecting_states = StateSet.singleton q;
642     starting_states = StateSet.union a1.starting_states a2.starting_states;
643     transitions =
644       let () =
645         Hashtbl.iter (fun k v -> Hashtbl.add a1.transitions k v) a2.transitions
646       in
647       Hashtbl.add a1.transitions q [(QNameSet.any, link_phi)];
648       a1.transitions
649   }
650   in
651   compute_rank a; a
652
653 let union a1 a2 =
654   let a1 = copy a1 in
655   let a2 = copy a2 in
656   let q = State.next () in
657   let link_phi =
658     StateSet.fold
659       (fun q phi -> Formula.(or_ (stay q) phi))
660       (StateSet.union a1.selecting_states a2.selecting_states)
661       Formula.false_
662   in
663   link a1 a2 q link_phi
664
665 let inter a1 a2 =
666   let a1 = copy a1 in
667   let a2 = copy a2 in
668   let q = State.next () in
669   let link_phi =
670     StateSet.fold
671       (fun q phi -> Formula.(and_ (stay q) phi))
672       (StateSet.union a1.selecting_states a2.selecting_states)
673       Formula.true_
674   in
675   link a1 a2 q link_phi
676
677 let neg a =
678   let a = copy a in
679   let q = State.next () in
680   let link_phi =
681     StateSet.fold
682       (fun q phi -> Formula.(and_ (not_(stay q)) phi))
683       a.selecting_states
684       Formula.true_
685   in
686   let () = Hashtbl.add a.transitions q [(QNameSet.any, link_phi)] in
687   let a =
688     { a with
689       selecting_states = StateSet.singleton q;
690     }
691   in
692   normalize_negations a; compute_rank a; a
693
694 let diff a1 a2 = inter a1 (neg a2)