Coccinelle release 1.0.0-rc3
[bpt/coccinelle.git] / parsing_cocci / check_meta.ml
index 28da910..ba64535 100644 (file)
@@ -1,23 +1,25 @@
 (*
-* Copyright 2005-2008, Ecole des Mines de Nantes, University of Copenhagen
-* Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller
-* This file is part of Coccinelle.
-* 
-* Coccinelle is free software: you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation, according to version 2 of the License.
-* 
-* Coccinelle 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
-* GNU General Public License for more details.
-* 
-* You should have received a copy of the GNU General Public License
-* along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
-* 
-* The authors reserve the right to distribute this or future versions of
-* Coccinelle under other licenses.
-*)
+ * Copyright 2010, INRIA, University of Copenhagen
+ * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
+ * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
+ * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
+ * This file is part of Coccinelle.
+ *
+ * Coccinelle is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, according to version 2 of the License.
+ *
+ * Coccinelle 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
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * The authors reserve the right to distribute this or future versions of
+ * Coccinelle under other licenses.
+ *)
 
 
 (* For minus fragment, checks that all of the identifier metavariables that
@@ -28,13 +30,14 @@ fresh are used.  What is the issue about error variables? (don't remember) *)
 module Ast0 = Ast0_cocci
 module Ast = Ast_cocci
 module V0 = Visitor_ast0
+module VT0 = Visitor_ast0_types
 
 (* all fresh identifiers *)
-let fresh_table = (Hashtbl.create(50) : ((string * string), unit) Hashtbl.t)
+let fresh_table = (Hashtbl.create(50) : (Ast.meta_name, unit) Hashtbl.t)
 
 let warning s = Printf.fprintf stderr "warning: %s\n" s
 
-let promote name = (name,(),Ast0.default_info(),(),None)
+let promote name = (name,(),Ast0.default_info(),(),None,-1)
 
 (* --------------------------------------------------------------------- *)
 
@@ -44,8 +47,8 @@ let find_loop table name =
     | x::xs -> (try Hashtbl.find x name with Not_found -> loop xs) in
   loop table
 
-let check_table table minus (name,_,info,_,_) =
-  let rl = info.Ast0.line_start in
+let check_table table minus (name,_,info,_,_,_) =
+  let rl = info.Ast0.pos_info.Ast0.line_start in
   if minus
   then
     (try (find_loop table name) := true
@@ -80,19 +83,21 @@ type context = ID | FIELD | FN | GLOBAL
 let is_ifdef name =
   String.length name > 2 && String.uppercase name = name
 
-let ident context old_metas table minus i =
+let rec ident context old_metas table minus i =
   match Ast0.unwrap i with
-    Ast0.Id((name,_,info,_,_) : string Ast0.mcode) ->
-      let rl = info.Ast0.line_start in
+    Ast0.Id((name,_,info,_,_,_) : string Ast0.mcode) ->
+      let rl = info.Ast0.pos_info.Ast0.line_start in
+      let is_plus i =
+       match Ast0.get_mcodekind i with Ast0.PLUS _ -> true | _ -> false in
       let err =
        if List.exists (function x -> x = name) old_metas
-           && (minus || Ast0.get_mcodekind i = Ast0.PLUS)
+           && (minus || is_plus i)
        then
          begin
            warning
              (Printf.sprintf
                 "line %d: %s, previously declared as a metavariable, is used as an identifier" rl name);
-             true
+           true
          end
        else false in
       (match context with
@@ -102,12 +107,26 @@ let ident context old_metas table minus i =
            warning
              (Printf.sprintf "line %d: should %s be a metavariable?" rl name)
       | _ -> ())
-  | Ast0.MetaId(name,_,_) -> check_table table minus name
+  | Ast0.MetaId(name,_,seedval,_) ->
+      check_table table minus name;
+      seed table minus seedval
   | Ast0.MetaFunc(name,_,_) -> check_table table minus name
   | Ast0.MetaLocalFunc(name,_,_) -> check_table table minus name
+  | Ast0.DisjId(_,id_list,_,_) ->
+      List.iter (ident context old_metas table minus) id_list
   | Ast0.OptIdent(_) | Ast0.UniqueIdent(_) ->
       failwith "unexpected code"
 
+and seed table minus = function
+    Ast.NoVal -> ()
+  | Ast.StringSeed _ -> ()
+  | Ast.ListSeed elems ->
+      List.iter
+       (function
+           Ast.SeedString _ -> ()
+         | Ast.SeedId name -> check_table table minus (promote name))
+       elems
+       
 (* --------------------------------------------------------------------- *)
 (* Expression *)
 
@@ -160,13 +179,13 @@ let rec expression context old_metas table minus e =
       check_table table minus name
   | Ast0.MetaExpr(name,_,_,_,_) | Ast0.MetaErr(name,_,_) ->
       check_table table minus name
-  | Ast0.MetaExprList(name,None,_) ->
-      check_table table minus name
-  | Ast0.MetaExprList(name,Some lenname,_) ->
+  | Ast0.MetaExprList(name,Ast0.MetaListLen lenname,_) ->
       check_table table minus name;
       check_table table minus lenname
+  | Ast0.MetaExprList(name,_,_) ->
+      check_table table minus name
   | Ast0.DisjExpr(_,exps,_,_) ->
-      List.iter (expression ID old_metas table minus) exps
+      List.iter (expression context old_metas table minus) exps
   | Ast0.NestExpr(_,exp_dots,_,w,_) ->
       dots (expression ID old_metas table minus) exp_dots;
       get_opt (expression ID old_metas table minus) w
@@ -175,8 +194,11 @@ let rec expression context old_metas table minus e =
   | _ -> () (* no metavariable subterms *)
 
 and get_type_name = function
-    Type_cocci.ConstVol(_,ty) | Type_cocci.Pointer(ty)
+    Type_cocci.ConstVol(_,ty) | Type_cocci.SignedT(_,Some ty)
+  | Type_cocci.Pointer(ty)
   | Type_cocci.FunctionPointer(ty) | Type_cocci.Array(ty) -> get_type_name ty
+  | Type_cocci.EnumName(Type_cocci.MV(nm,_,_)) -> Some nm
+  | Type_cocci.StructUnionName(_,Type_cocci.MV(nm,_,_)) -> Some nm
   | Type_cocci.MetaType(nm,_,_) -> Some nm
   | _ -> None
 
@@ -186,6 +208,8 @@ and get_type_name = function
 and typeC old_metas table minus t =
   match Ast0.unwrap t with
     Ast0.ConstVol(cv,ty) -> typeC old_metas table minus ty
+  | Ast0.Signed(sgn,ty) ->
+      get_opt (typeC old_metas table minus) ty
   | Ast0.Pointer(ty,star) -> typeC old_metas table minus ty
   | Ast0.FunctionPointer(ty,lp1,star,rp1,lp2,params,rp2) ->
       typeC old_metas table minus ty;
@@ -200,6 +224,10 @@ and typeC old_metas table minus t =
       check_table table minus name
   | Ast0.DisjType(_,types,_,_) ->
       List.iter (typeC old_metas table minus) types
+  | Ast0.EnumName(en,Some id) -> ident GLOBAL old_metas table minus id
+  | Ast0.EnumDef(ty,lb,ids,rb) ->
+      typeC old_metas table minus ty;
+      dots (expression GLOBAL old_metas table minus) ids
   | Ast0.StructUnionName(su,Some id) -> ident GLOBAL old_metas table minus id
   | Ast0.StructUnionDef(ty,lb,decls,rb) ->
       typeC old_metas table minus ty;
@@ -215,7 +243,14 @@ and typeC old_metas table minus t =
 
 and declaration context old_metas table minus d =
   match Ast0.unwrap d with
-    Ast0.Init(stg,ty,id,eq,ini,sem) ->
+    Ast0.MetaDecl(name,_) | Ast0.MetaField(name,_) ->
+      check_table table minus name
+  | Ast0.MetaFieldList(name,Ast0.MetaListLen lenname,_) ->
+      check_table table minus name;
+      check_table table minus lenname
+  | Ast0.MetaFieldList(name,_,_) ->
+      check_table table minus name
+  | Ast0.Init(stg,ty,id,eq,ini,sem) ->
       (match Ast0.unwrap ini with
        Ast0.InitExpr exp ->
          typeC old_metas table minus ty;
@@ -233,7 +268,7 @@ and declaration context old_metas table minus d =
   | Ast0.UnInit(stg,ty,id,sem) ->
       typeC old_metas table minus ty; ident context old_metas table minus id
   | Ast0.MacroDecl(name,lp,args,rp,sem) ->
-      ident ID old_metas table minus name;
+      ident GLOBAL old_metas table minus name;
       dots (expression ID old_metas table minus) args
   | Ast0.TyDecl(ty,sem) -> typeC old_metas table minus ty
   | Ast0.Typedef(stg,ty,id,sem) ->
@@ -251,27 +286,36 @@ and declaration context old_metas table minus d =
 
 and initialiser old_metas table minus ini =
   match Ast0.unwrap ini with
-    Ast0.InitExpr(exp) -> expression ID old_metas table minus exp
-  | Ast0.InitList(lb,initlist,rb) ->
+    Ast0.MetaInit(name,_) ->
+      check_table table minus name
+  | Ast0.MetaInitList(name,Ast0.MetaListLen lenname,_) ->
+      check_table table minus name;
+      check_table table minus lenname
+  | Ast0.MetaInitList(name,_,_) ->
+      check_table table minus name
+  | Ast0.InitExpr(exp) -> expression ID old_metas table minus exp
+  | Ast0.InitList(lb,initlist,rb,ordered) ->
       dots (initialiser old_metas table minus) initlist
-  | Ast0.InitGccDotName(dot,name,eq,ini) ->
-      ident FIELD old_metas table minus name;
+  | Ast0.InitGccExt(designators,eq,ini) ->
+      List.iter (designator old_metas table minus) designators;
       initialiser old_metas table minus ini
   | Ast0.InitGccName(name,eq,ini) ->
       ident FIELD old_metas table minus name;
       initialiser old_metas table minus ini
-  | Ast0.InitGccIndex(lb,exp,rb,eq,ini) ->
-      expression ID old_metas table minus exp;
-      initialiser old_metas table minus ini
-  | Ast0.InitGccRange(lb,exp1,dots,exp2,rb,eq,ini) ->
-      expression ID old_metas table minus exp1;
-      expression ID old_metas table minus exp2;
-      initialiser old_metas table minus ini
   | Ast0.Idots(_,Some x) -> initialiser old_metas table minus x
   | Ast0.OptIni(_) | Ast0.UniqueIni(_) ->
       failwith "unexpected code"
   | _ -> () (* no metavariable subterms *)
 
+and designator old_metas table minus = function
+    Ast0.DesignatorField(dot,id) ->
+      ident FIELD old_metas table minus id
+  | Ast0.DesignatorIndex(lb,exp,rb) ->
+      expression ID old_metas table minus exp
+  | Ast0.DesignatorRange(lb,min,dots,max,rb) ->
+      expression ID old_metas table minus min;
+      expression ID old_metas table minus max
+
 and initialiser_list old_metas table minus =
   dots (initialiser old_metas table minus)
 
@@ -285,11 +329,11 @@ and parameterTypeDef old_metas table minus param =
       typeC old_metas table minus ty
   | Ast0.MetaParam(name,_) ->
       check_table table minus name
-  | Ast0.MetaParamList(name,None,_) ->
-      check_table table minus name
-  | Ast0.MetaParamList(name,Some lenname,_) ->
+  | Ast0.MetaParamList(name,Ast0.MetaListLen lenname,_) ->
       check_table table minus name;
       check_table table minus lenname
+  | Ast0.MetaParamList(name,_,_) ->
+      check_table table minus name
   | _ -> () (* no metavariable subterms *)
 
 and parameter_list old_metas table minus =
@@ -302,7 +346,8 @@ and statement old_metas table minus s =
   match Ast0.unwrap s with
     Ast0.Decl(_,decl) -> declaration ID old_metas table minus decl
   | Ast0.Seq(lbrace,body,rbrace) -> dots (statement old_metas table minus) body
-  | Ast0.ExprStatement(exp,sem) -> expression ID old_metas table minus exp
+  | Ast0.ExprStatement(exp,sem) ->
+      get_opt (expression ID old_metas table minus) exp
   | Ast0.IfThen(iff,lp,exp,rp,branch,_) ->
       expression ID old_metas table minus exp;
       statement old_metas table minus branch
@@ -322,11 +367,12 @@ and statement old_metas table minus s =
       get_opt (expression ID old_metas table minus) exp3;
       statement old_metas table minus body
   | Ast0.Iterator(nm,lp,args,rp,body,_) ->
-      ident ID old_metas table minus nm;
+      ident GLOBAL old_metas table minus nm;
       dots (expression ID old_metas table minus) args;
       statement old_metas table minus body
-  | Ast0.Switch(switch,lp,exp,rp,lb,cases,rb) ->
+  | Ast0.Switch(switch,lp,exp,rp,lb,decls,cases,rb) ->
       expression ID old_metas table minus exp;
+      dots (statement old_metas table minus) decls;
       dots (case_line old_metas table minus) cases
   | Ast0.ReturnExpr(ret,exp,sem) -> expression ID old_metas table minus exp
   | Ast0.MetaStmt(name,_) ->     check_table table minus name
@@ -334,46 +380,71 @@ and statement old_metas table minus s =
   | Ast0.Exp(exp) -> expression ID old_metas table minus exp
   | Ast0.TopExp(exp) -> expression ID old_metas table minus exp
   | Ast0.Ty(ty) -> typeC old_metas table minus ty
+  | Ast0.TopInit(init) -> initialiser old_metas table minus init
   | Ast0.Disj(_,rule_elem_dots_list,_,_) ->
       List.iter (dots (statement old_metas table minus)) rule_elem_dots_list
   | Ast0.Nest(_,rule_elem_dots,_,w,_) ->
       dots (statement old_metas table minus) rule_elem_dots;
       List.iter (whencode (dots (statement old_metas table minus))
-                  (statement old_metas table minus))
+                  (statement old_metas table minus)
+                  (expression ID old_metas table minus))
        w
   | Ast0.Dots(_,x) | Ast0.Circles(_,x) | Ast0.Stars(_,x) ->
       List.iter
        (whencode (dots (statement old_metas table minus))
-          (statement old_metas table minus)) x
+          (statement old_metas table minus)
+          (expression ID old_metas table minus)) x
   | Ast0.FunDecl(_,fi,name,lp,params,rp,lbrace,body,rbrace) ->
       ident FN old_metas table minus name;
       List.iter (fninfo old_metas table minus) fi;
       parameter_list old_metas table minus params;
       dots (statement old_metas table minus) body
   | Ast0.Include(inc,s) -> () (* no metavariables possible *)
-  | Ast0.Define(def,id,_,body) ->
+  | Ast0.Undef(def,id) ->
+      ident GLOBAL old_metas table minus id
+  | Ast0.Define(def,id,params,body) ->
       ident GLOBAL old_metas table minus id;
+      define_parameters old_metas table minus params;
       dots (statement old_metas table minus) body
+  | Ast0.Label(i,_) -> ident ID old_metas table minus i
   | Ast0.Goto(_,i,_) -> ident ID old_metas table minus i
   | _ -> () (* no metavariable subterms *)
 
+and define_param old_metas table minus p =
+  match Ast0.unwrap p with
+    Ast0.DParam(id) -> ident GLOBAL old_metas table minus id
+  | Ast0.DPComma(_) | Ast0.DPdots(_) | Ast0.DPcircles(_) ->
+      () (* no metavariable subterms *)
+  | Ast0.OptDParam(dp)    -> define_param old_metas table minus dp
+  | Ast0.UniqueDParam(dp) -> define_param old_metas table minus dp
+
+and define_parameters old_metas table minus x =
+  match Ast0.unwrap x with
+    Ast0.NoParams -> ()
+  | Ast0.DParams(lp,dp,rp) -> dots (define_param old_metas table minus) dp
+
 and fninfo old_metas table minus = function
     Ast0.FStorage(stg) -> ()
   | Ast0.FType(ty) -> typeC old_metas table minus ty
   | Ast0.FInline(inline) -> ()
   | Ast0.FAttr(attr) -> ()
 
-and whencode notfn alwaysfn = function
+and whencode notfn alwaysfn expression = function
     Ast0.WhenNot a -> notfn a
   | Ast0.WhenAlways a -> alwaysfn a
   | Ast0.WhenModifier(_) -> ()
+  | Ast0.WhenNotTrue a -> expression a
+  | Ast0.WhenNotFalse a -> expression a
 
 and case_line old_metas table minus c =
   match Ast0.unwrap c with
     Ast0.Default(def,colon,code) ->
       dots (statement old_metas table minus) code
   | Ast0.Case(case,exp,colon,code) ->
+      expression GLOBAL old_metas table minus exp;
       dots (statement old_metas table minus) code
+  | Ast0.DisjCase(_,case_lines,_,_) ->
+      List.iter (case_line old_metas table minus) case_lines
   | Ast0.OptCase(case) -> failwith "unexpected code"
 
 (* --------------------------------------------------------------------- *)
@@ -381,8 +452,9 @@ and case_line old_metas table minus c =
 
 let top_level old_metas table minus t =
   match Ast0.unwrap t with
-    Ast0.DECL(stmt) -> statement old_metas table minus stmt
-  | Ast0.CODE(stmt_dots) -> dots (statement old_metas table minus) stmt_dots
+    Ast0.NONDECL(stmt) -> statement old_metas table minus stmt
+  | Ast0.CODE(stmt_dots) | Ast0.TOPCODE(stmt_dots) ->
+      dots (statement old_metas table minus) stmt_dots
   | Ast0.ERRORWORDS(exps) ->
       List.iter (expression FN old_metas table minus) exps
   | _ -> () (* no metavariables possible *)
@@ -394,30 +466,28 @@ let rule old_metas table minus rules =
 
 let positions table rules =
   let mcode x =
-    match Ast0.get_pos x with
-      Ast0.MetaPos(name,constraints,_) ->
+    List.iter
+      (function Ast0.MetaPos(name,constraints,_) ->
        let pos = Ast0.unwrap_mcode name in
-       (find_loop table pos) := true
-    | _ -> () in
+       (find_loop table pos) := true)
+      (Ast0.get_pos x) in
   let option_default = () in
   let bind x y = () in
   let donothing r k e = k e in
   let fn =
-    V0.combiner bind option_default
+    V0.flat_combiner bind option_default
       mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
-      mcode
       donothing donothing donothing donothing donothing donothing
       donothing donothing donothing donothing donothing donothing donothing
       donothing donothing in
 
-  List.iter fn.V0.combiner_top_level rules
+  List.iter fn.VT0.combiner_rec_top_level rules
 
 let dup_positions rules =
   let mcode x =
-    match Ast0.get_pos x with
-      Ast0.MetaPos(name,constraints,_) ->
-       let pos = Ast0.unwrap_mcode name in [pos]
-    | _ -> [] in
+    List.map
+      (function Ast0.MetaPos(name,constraints,_) -> Ast0.unwrap_mcode name)
+      (Ast0.get_pos x) in
   let option_default = [] in
   let bind x y = x@y in
 
@@ -429,35 +499,34 @@ let dup_positions rules =
     match Ast0.unwrap e with
       Ast0.DisjExpr(_,explist,_,_) ->
        List.fold_left Common.union_set option_default
-         (List.map r.V0.combiner_expression explist)
+         (List.map r.VT0.combiner_rec_expression explist)
     | _ -> k e in
 
   let typeC r k e = (* not sure relevent because "only after iso" *)
     match Ast0.unwrap e with
       Ast0.DisjType(_,types,_,_) ->
        List.fold_left Common.union_set option_default
-         (List.map r.V0.combiner_typeC types)
+         (List.map r.VT0.combiner_rec_typeC types)
     | _ -> k e in
 
   let declaration r k e =
     match Ast0.unwrap e with
       Ast0.DisjDecl(_,decls,_,_) ->
        List.fold_left Common.union_set option_default
-         (List.map r.V0.combiner_declaration decls)
+         (List.map r.VT0.combiner_rec_declaration decls)
     | _ -> k e in
 
   let statement r k e =
     match Ast0.unwrap e with
       Ast0.Disj(_,stmts,_,_) ->
        List.fold_left Common.union_set option_default
-         (List.map r.V0.combiner_statement_dots stmts)
+         (List.map r.VT0.combiner_rec_statement_dots stmts)
     | _ -> k e in
 
   let donothing r k e = k e in
   let fn =
-    V0.combiner bind option_default
+    V0.flat_combiner bind option_default
       mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
-      mcode
       donothing donothing donothing donothing donothing donothing
       donothing expression typeC donothing donothing declaration statement
       donothing donothing in
@@ -465,11 +534,12 @@ let dup_positions rules =
   let res =
     List.sort compare
       (List.fold_left Common.union_set option_default
-        (List.map fn.V0.combiner_top_level rules)) in
+        (List.map fn.VT0.combiner_rec_top_level rules)) in
   let rec loop = function
       [] | [_] -> ()
     | ((rule,name) as x)::y::_ when x = y ->
-       failwith (Printf.sprintf "duplicate use of %s.%s" rule name)
+       failwith
+         (Printf.sprintf "duplicate use of %s.%s" rule name)
     | _::xs -> loop xs in
   loop res
 
@@ -478,7 +548,7 @@ let dup_positions rules =
 let make_table l =
   let table =
     (Hashtbl.create(List.length l) :
-       ((string * string), bool ref) Hashtbl.t) in
+       (Ast.meta_name, bool ref) Hashtbl.t) in
   List.iter
     (function x -> Hashtbl.add table (Ast.get_meta_name x) (ref false)) l;
   table
@@ -522,7 +592,7 @@ let check_meta rname old_metas inherited_metavars metavars minus plus =
   dup_positions minus;
   check_all_marked rname "metavariable" other_table "in the - or context code";
   rule old_metas [iother_table;fresh_table;err_table] false plus;
-  check_all_marked rname "fresh identifier metavariable" iother_table
+  check_all_marked rname "inherited metavariable" iother_table
     "in the -, +, or context code";
   check_all_marked rname "metavariable" fresh_table "in the + code";
   check_all_marked rname "error metavariable" err_table ""