Release coccinelle-0.1.2

[bpt/coccinelle.git] / parsing_c / parse_c.mli

diff --git a/parsing_c/parse_c.mli b/parsing_c/parse_c.mli
index ef896b5..2287d7a 100644 (file)
--- a/parsing_c/parse_c.mli
+++ b/parsing_c/parse_c.mli
@@ -1,14 +1,3 @@
-(* Copyright (C) 2002-2008 Yoann Padioleau
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License (GPL)
- * version 2 as published by the Free Software Foundation.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * file license.txt for more details.
- *)
 open Common
 
 (* The main function is parse_c_and_cpp. It uses globals in Lexer_Parser and 
@@ -16,28 +5,29 @@ open Common
  * from a standard.h macro file. Cf also init_defs below.
  *)
 
-(* the token list contains now also the comment-tokens  *)
-type info_item = (string * Parser_c.token list)
-
+(* ---------------------------------------------------------------------- *)
 type program2 = toplevel2 list
-     and toplevel2 = Ast_c.toplevel * info_item
+   and toplevel2 = Ast_c.toplevel * info_item
 
-type parsing_stat = {
-    filename: filename;
-    mutable have_timeout: bool;
-    mutable correct: int;
-    mutable bad: int;
-    mutable commentized: int;
-  } 
+    (* the token list contains now also the comment-tokens *)
+    and info_item = (string * Parser_c.token list)
 
+(* ---------------------------------------------------------------------- *)
 (* This is the main function *)
 val parse_print_error_heuristic:  
-  filename (*cfile*) -> (program2 * parsing_stat)
-val parse_c_and_cpp : (* alias of previous func *)
-  filename (*cfile*) -> (program2 * parsing_stat)
+  filename (*cfile*) -> (program2 * Parsing_stat.parsing_stat)
+(* alias of previous func *)
+val parse_c_and_cpp : 
+  filename (*cfile*) -> (program2 * Parsing_stat.parsing_stat)
 
+(* use some .ast_raw memoized version, and take care if obsolete *)
+val parse_cache:
+  filename (*cfile*) -> (program2 * Parsing_stat.parsing_stat)
+
+
+(* ---------------------------------------------------------------------- *)
 val parse_cpp_define_file : 
-  filename -> (string, Parsing_hacks.define_body) assoc
+  filename -> (string, Parsing_hacks.define_def) assoc
 
 val init_defs : filename -> unit
 
@@ -45,26 +35,36 @@ val init_defs : filename -> unit
 
 
 
-
-val tokens:      filename -> Parser_c.token list
-val tokens_string: string -> Parser_c.token list
+(* ---------------------------------------------------------------------- *)
+(* used also for the standard.h file *)
+val tokens:      ?profile:bool -> filename -> Parser_c.token list
+val tokens_of_string: string -> Parser_c.token list
 
 val parse:                        filename -> Ast_c.program
 val parse_print_error:            filename -> Ast_c.program
 val parse_gen: 
     ((Lexing.lexbuf -> Parser_c.token) -> Lexing.lexbuf -> 'a) -> string -> 'a
 
-(* easy way to build complex Ast elements from simple strings *)
+
+
+(* ---------------------------------------------------------------------- *)
+(* Easy way to build complex Ast elements from simple strings.
+ * Can also be useful when called from the ocaml toplevel to test. 
+ *)
 val type_of_string      : string -> Ast_c.fullType
 val statement_of_string : string -> Ast_c.statement
+(* similar but use parse_c_and_cpp and a /tmp/__cocci.c and extract the part *)
+val cstatement_of_string  : string -> Ast_c.statement
+val cexpression_of_string : string -> Ast_c.expression
+
 
 
-(* use some .ast_raw memoized version, and take care if obsolete *)
-val parse_cache:
-  filename (*cfile*) -> (program2 * parsing_stat)
 
+(* ---------------------------------------------------------------------- *)
+(* a few helpers *)
+val program_of_program2 : program2 -> Ast_c.program
+val with_program2: (Ast_c.program -> Ast_c.program) -> program2 -> program2
 
-val print_parsing_stat_list: parsing_stat list -> unit
 val print_commentized       : Parser_c.token list -> unit