cocci.mli

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