cocci.mli

   1 (*
   2  * Copyright 2012, INRIA
   3  * Julia Lawall, Gilles Muller
   4  * Copyright 2010-2011, INRIA, University of Copenhagen
   5  * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
   6  * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
   7  * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
   8  * This file is part of Coccinelle.
   9  *
  10  * Coccinelle is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation, according to version 2 of the License.
  13  *
  14  * Coccinelle is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * The authors reserve the right to distribute this or future versions of
  23  * Coccinelle under other licenses.
  24  *)
  25
  26
  27 # 0 "./cocci.mli"
  28 (*
  29  * Copyright 2012, INRIA
  30  * Julia Lawall, Gilles Muller
  31  * Copyright 2010-2011, INRIA, University of Copenhagen
  32  * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
  33  * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
  34  * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
  35  * This file is part of Coccinelle.
  36  *
  37  * Coccinelle is free software: you can redistribute it and/or modify
  38  * it under the terms of the GNU General Public License as published by
  39  * the Free Software Foundation, according to version 2 of the License.
  40  *
  41  * Coccinelle is distributed in the hope that it will be useful,
  42  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  43  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  44  * GNU General Public License for more details.
  45  *
  46  * You should have received a copy of the GNU General Public License
  47  * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
  48  *
  49  * The authors reserve the right to distribute this or future versions of
  50  * Coccinelle under other licenses.
  51  *)
  52
  53
  54 # 0 "./cocci.mli"
  55 open Common
  56
  57 (* full_engine takes (coccifile, isofile) and cfiles in parameters and
  58  * returns a list associating to the input cfiles, and maybe header
  59  * files that was also required to be modified, the files containing the
  60  * result (in general files in /tmp).
  61  * pre_engine does the compilation of the SmPL code and runs any initially
  62  * scripts
  63  * post_engine runs any finally scripts
  64  *
  65  * This function uses memoisation internally, which is useful when
  66  * using -dir to not redo twice the same work. So take care!
  67  *)
  68 type cocci_info
  69 val pre_engine : (filename * filename) -> cocci_info
  70 val full_engine :
  71   cocci_info -> filename list -> (filename * filename option) list
  72 val post_engine : cocci_info -> unit
  73
  74 (* because of the #include "toto.c" and also because we may associate the
  75  * same C file to multiple drivers because they share code, we can
  76  * modify multiple times the same file when use -dir. This check
  77  * remove duplicates and check that the modification are consistent
  78  * among the different drivers.
  79  *)
  80 val check_duplicate_modif :
  81  (filename * filename option) list -> (filename * filename option) list
  82
  83 (* provides memoization *)
  84 val sp_of_file :
  85   filename (* coccifile *)  -> filename option (* isofile *) ->
  86   Ast_cocci.metavar list list * Ast_cocci.rule list *
  87       Ast_cocci.meta_name list list list *
  88       Ast_cocci.meta_name list list list *
  89       (Ast_cocci.meta_name list list list (*used after list*) *
  90          (*fresh used after list*)
  91          Ast_cocci.meta_name list list list *
  92          (*fresh used after list seeds*)
  93          Ast_cocci.meta_name list list list) *
  94       Ast_cocci.meta_name list list list *
  95       (string list option (*grep tokens*) *
  96          string list option (*glimpse tokens*) *
  97          Get_constants2.combine option)
  98
  99 val normalize_path : string -> string