Release coccinelle-0.1
[bpt/coccinelle.git] / engine / lib_engine.ml
1 (*
2 * Copyright 2005-2008, Ecole des Mines de Nantes, University of Copenhagen
3 * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller
4 * This file is part of Coccinelle.
5 *
6 * Coccinelle is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, according to version 2 of the License.
9 *
10 * Coccinelle is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with Coccinelle. If not, see <http://www.gnu.org/licenses/>.
17 *
18 * The authors reserve the right to distribute this or future versions of
19 * Coccinelle under other licenses.
20 *)
21
22
23 open Ograph_extended
24
25 (*****************************************************************************)
26 (* the different ctl formula related types *)
27 (*****************************************************************************)
28 type mvar = Ast_cocci.meta_name
29
30 type predicate =
31 InLoop | TrueBranch | FalseBranch
32 | After (* pointer to the code after an if or while *)
33 | FallThrough
34 | Return (* any exit from the current function *)
35 | FunHeader | Top | Exit | ErrorExit | Goto
36 | Paren of Ast_cocci.meta_name
37 | Match of Ast_cocci.rule_elem
38 | Label of Ast_cocci.meta_name
39 | BCLabel of Ast_cocci.meta_name (* parent of break or continue *)
40 | PrefixLabel of Ast_cocci.meta_name
41 | BindGood of Ast_cocci.meta_name (* used to implement \+ *)
42 | BindBad of Ast_cocci.meta_name
43 | FakeBrace
44
45 type ctlcocci = (predicate, Ast_cocci.meta_name) Wrapper_ctl.wrapped_ctl
46
47
48 (*****************************************************************************)
49 (* the different binding types *)
50 (*****************************************************************************)
51 type metavars_binding = Ast_c.metavars_binding
52
53 (* used in ctlcocci_integration *)
54 type metavar_binding_kind2 =
55 | NormalMetaVal of Ast_c.metavar_binding_kind
56 | ParenVal of Ast_cocci.meta_name
57 | LabelVal of int list
58 | GoodVal | BadVal (* used to implement \+ *)
59
60 and metavars_binding2 = (mvar, metavar_binding_kind2) Common.assoc
61
62
63
64 (*****************************************************************************)
65 (* the CTL model related types *)
66 (*****************************************************************************)
67 type label_ctlcocci =
68 predicate ->
69 (nodei *
70 (predicate * (mvar, metavar_binding_kind2) Ast_ctl.generic_substitution))
71 list
72
73 type model = Control_flow_c.cflow * label_ctlcocci * nodei list
74
75 type transformation_info =
76 (nodei * metavars_binding * Ast_cocci.rule_elem) list
77
78
79 (*****************************************************************************)
80 (* comparing binding *)
81 (*****************************************************************************)
82
83 let equal_binding xs ys =
84 List.sort compare xs = List.sort compare ys