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