cocci.mli

   1 (*
   2  * Copyright 2005-2010, Ecole des Mines de Nantes, University of Copenhagen
   3  * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
   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 Common
  24
  25 (* full_engine takes (coccifile, isofile) and cfiles in parameters and
  26  * returns a list associating to the input cfiles, and maybe header
  27  * files that was also required to be modified, the files containing the
  28  * result (in general files in /tmp).
  29  * pre_engine does the compilation of the SmPL code and runs any initially
  30  * scripts
  31  * post_engine runs any finally scripts
  32  *
  33  * This function uses memoisation internally, which is useful when
  34  * using -dir to not redo twice the same work. So take care!
  35  *)
  36 type cocci_info
  37 val pre_engine : (filename * filename) -> cocci_info
  38 val full_engine :
  39   cocci_info -> filename list -> (filename * filename option) list
  40 val post_engine : cocci_info -> unit
  41
  42 (* because of the #include "toto.c" and also because we may associate the
  43  * same C file to multiple drivers because they share code, we can
  44  * modify multiple times the same file when use -dir. This check
  45  * remove duplicates and check that the modification are consistent
  46  * among the different drivers.
  47  *)
  48 val check_duplicate_modif :
  49  (filename * filename option) list -> (filename * filename option) list
  50
  51 (* provides memoization *)
  52 val sp_of_file :
  53   filename (* coccifile *)  -> filename option (* isofile *) ->
  54   Ast_cocci.metavar list list * Ast_cocci.rule list *
  55       Ast_cocci.meta_name list list list *
  56       Ast_cocci.meta_name list list list *
  57       (Ast_cocci.meta_name list list list (*used after list*) *
  58          (*fresh used after list*)
  59          Ast_cocci.meta_name list list list *
  60          (*fresh used after list seeds*)
  61          Ast_cocci.meta_name list list list) *
  62       Ast_cocci.meta_name list list list *
  63       string list list *
  64       string list option
  65