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