engine/lib_engine.ml

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