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