Coccinelle release 0.2.5-rc6

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

diff --git a/parsing_c/parsing_hacks.mli b/parsing_c/parsing_hacks.mli
index 4689fd0..b5e9337 100644 (file)
--- a/parsing_c/parsing_hacks.mli
+++ b/parsing_c/parsing_hacks.mli
@@ -1,17 +1,15 @@
-open Common 
-
 (* This module tries to detect some cpp idioms so that we can parse as-is
- * files by adjusting or commenting some tokens. Parsing hack style. 
+ * files by adjusting or commenting some tokens. Parsing hack style.
  * Sometime we use some indentation information,
  * sometimes we do some kind of lalr(k) by finding patterns. Often try to
  * work on better token representation, like ifdef-paren-ized, brace-ized,
  * paren-ized, so can do easier pattern matching to more easily match
- * complex cpp idiom pattern (cf token_views_c.ml). 
- * We also try to get more contextual information such as whether the 
+ * complex cpp idiom pattern (cf token_views_c.ml).
+ * We also try to get more contextual information such as whether the
  * token is in a initializer as some common patterns have different
  * use depending on context.
- * 
- * 
+ *
+ *
  * Example of cpp idioms:
  *  - if 0 for commenting stuff (not always code, sometimes just real comments)
  *  - ifdef old version
@@ -25,13 +23,13 @@ open Common
  *  - macro no ptvirg
  *  - macro string, and macro function string taking param and ##
  *  - macro attribute
- * 
+ *
  * Cf the TMacroXxx in parser_c.mly and MacroXxx in ast_c.ml
- * 
+ *
  * Also try to infer typedef.
- * 
- * Also do other stuff involving cpp like expanding some macros, 
- * or try parse well define body by finding the end of define virtual 
+ *
+ * Also do other stuff involving cpp like expanding some macros,
+ * or try parse well define body by finding the end of define virtual
  * end-of-line token. But now most of the code is actually in cpp_token_c.ml
  * It is related to what is in the yacfe configuration file (e.g. standard.h)
  *)
@@ -45,18 +43,38 @@ val regexp_typedef: Str.regexp
 (* can reset this global *)
 val ifdef_paren_cnt: int ref
 
-val filter_cpp_stuff : 
+val filter_cpp_stuff :
   Token_views_c.token_extended list -> Token_views_c.token_extended list
-val insert_virtual_positions: 
+val insert_virtual_positions:
   Parser_c.token list -> Parser_c.token list
 
-val fix_tokens_cpp : 
+(* will among other things interally call cpp_token_c to macro
+ * expand some macros *)
+val fix_tokens_cpp :
   macro_defs:(string, Cpp_token_c.define_def) Hashtbl.t ->
   Parser_c.token list -> Parser_c.token list
 
 (* next stream tokens -> passed stream tokens -> final next token *)
-val lookahead : 
-  pass:int -> 
+val lookahead :
+  pass:int ->
   Parser_c.token list -> Parser_c.token list -> Parser_c.token
 
 
+
+(* ------------------------------------------------------------------------ *)
+(* Parsing hack helpers related to #define or #include *)
+(* ------------------------------------------------------------------------ *)
+
+(* generate virtual end-of-line token, TDefEol, pass the antislash, etc *)
+val fix_tokens_define :
+  Parser_c.token list -> Parser_c.token list
+
+(* called when need to pass some tokens during some error recovery *)
+val drop_until_defeol: Parser_c.token list -> Parser_c.token list
+val comment_until_defeol: Parser_c.token list -> Parser_c.token list
+
+(* generates TIncludeStart and TIncludeFilename tokens *)
+val tokens_include:
+  Ast_c.info * string * string * bool ref ->
+  Parser_c.token * Parser_c.token list
+