parsing_c/unparse_cocci.ml

   1 (*
   2  * Copyright (C) 2010, University of Copenhagen DIKU and INRIA.
   3  * Copyright (C) 2006, 2007 Julia Lawall
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License (GPL)
   7  * version 2 as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * file license.txt for more details.
  13  *
  14  * This file was part of Coccinelle.
  15  *)
  16 open Common
  17
  18 (*****************************************************************************)
  19 (* mostly a copy paste of parsing_cocci/pretty_print_cocci.ml
  20  * todo?: try to factorize ?
  21  *)
  22 (*****************************************************************************)
  23
  24 module Ast = Ast_cocci
  25
  26 let term s = Ast.unwrap_mcode s
  27
  28 (* or perhaps can have in plus, for instance a Disj, but those Disj must be
  29  *  handled by interactive tool (by proposing alternatives)
  30  *)
  31 exception CantBeInPlus
  32
  33 (*****************************************************************************)
  34
  35 type pos = Before | After | InPlace
  36 type nlhint = StartBox | EndBox | SpaceOrNewline of string ref
  37
  38 let unknown = -1
  39
  40 let rec do_all
  41     (env, pr, pr_celem, pr_cspace, pr_space, pr_arity, pr_barrier,
  42      indent, unindent)
  43     generating xxs before =
  44
  45 (* Just to be able to copy paste the code from pretty_print_cocci.ml. *)
  46 let print_string s line lcol =
  47   let rcol = if lcol = unknown then unknown else lcol + (String.length s) in
  48   pr s line lcol rcol None in
  49 let print_string_with_hint hint s line lcol =
  50   let rcol = if lcol = unknown then unknown else lcol + (String.length s) in
  51   pr s line lcol rcol (Some hint) in
  52 let print_text s = pr s unknown unknown unknown None in
  53 let close_box _ = () in
  54 let force_newline _ = print_text "\n" in
  55
  56 let start_block () = force_newline(); indent() in
  57 let end_block () = unindent true; force_newline () in
  58 let print_string_box s = print_string s in
  59
  60 let print_option = Common.do_option in
  61 let print_option_prespace fn = function
  62     None -> ()
  63   | Some x -> pr_space(); fn x in
  64 let print_option_space fn = function
  65     None -> ()
  66   | Some x -> fn x; pr_space() in
  67 let print_between = Common.print_between in
  68
  69 let outdent _ = () (* should go to leftmost col, does nothing now *) in
  70
  71 let pretty_print_c =
  72   Pretty_print_c.mk_pretty_printers pr_celem pr_cspace
  73     force_newline indent outdent (function _ -> unindent true) in
  74
  75 (* --------------------------------------------------------------------- *)
  76 (* Only for make_hrule, print plus code, unbound metavariables *)
  77
  78 (* avoid polyvariance problems *)
  79 let anything : (Ast.anything -> unit) ref = ref (function _ -> ()) in
  80
  81 let rec print_anything = function
  82     [] -> ()
  83   | stream ->
  84       start_block();
  85       print_between force_newline print_anything_list stream;
  86       end_block()
  87
  88 and print_anything_list = function
  89     [] -> ()
  90   | [x] -> !anything x
  91   | bef::((aft::_) as rest) ->
  92       !anything bef;
  93       let space =
  94         (match bef with
  95           Ast.Rule_elemTag(_) | Ast.AssignOpTag(_) | Ast.BinaryOpTag(_)
  96         | Ast.ArithOpTag(_) | Ast.LogicalOpTag(_)
  97         | Ast.Token("if",_) | Ast.Token("while",_) -> true | _ -> false) or
  98         (match aft with
  99           Ast.Rule_elemTag(_) | Ast.AssignOpTag(_) | Ast.BinaryOpTag(_)
 100         | Ast.ArithOpTag(_) | Ast.LogicalOpTag(_) | Ast.Token("{",_) -> true
 101         | _ -> false) in
 102       if space then pr_space ();
 103       print_anything_list rest in
 104
 105 let print_around printer term = function
 106     Ast.NOTHING -> printer term
 107   | Ast.BEFORE(bef,_) -> print_anything bef; printer term
 108   | Ast.AFTER(aft,_) -> printer term; print_anything aft
 109   | Ast.BEFOREAFTER(bef,aft,_) ->
 110       print_anything bef; printer term; print_anything aft in
 111
 112 let print_string_befaft fn fn1 x info =
 113   let print ln col =
 114     function Ast.Noindent s | Ast.Indent s -> print_string s ln col in
 115   List.iter
 116     (function (s,ln,col) -> fn1(); print ln col s; force_newline())
 117     info.Ast.strbef;
 118   fn x;
 119   List.iter
 120     (function (s,ln,col) -> force_newline(); fn1(); print ln col s)
 121     info.Ast.straft in
 122 let print_meta (r,x) = print_text x in
 123
 124 let print_pos = function
 125     Ast.MetaPos(name,_,_,_,_) ->
 126       let name = Ast.unwrap_mcode name in
 127       print_text "@"; print_meta name
 128   | _ -> () in
 129
 130 (* --------------------------------------------------------------------- *)
 131
 132 let mcode fn (s,info,mc,pos) =
 133   let line = info.Ast.line in
 134   let lcol = info.Ast.column in
 135   match (generating,mc) with
 136     (false,_) ->
 137     (* printing for transformation *)
 138     (* Here we don't care about the annotation on s. *)
 139       let print_comments lb comments =
 140         List.fold_left
 141           (function line_before ->
 142             function (str,line,col) ->
 143               match line_before with
 144                 None ->
 145                   let str =
 146                     match str with
 147                       Ast.Noindent s -> unindent false; s
 148                     | Ast.Indent s -> s in
 149                   print_string str line col; Some line
 150               | Some lb when line =|= lb ->
 151                   let str = match str with Ast.Noindent s | Ast.Indent s -> s in
 152                   print_string str line col; Some line
 153               | _ ->
 154                   force_newline();
 155                   (* not super elegant to put side-effecting unindent in a let
 156                      expression... *)
 157                   let str =
 158                     match str with
 159                       Ast.Noindent s -> unindent false; s
 160                     | Ast.Indent s -> s in
 161                   print_string str line col; Some line)
 162           lb comments in
 163       let line_before = print_comments None info.Ast.strbef in
 164       (match line_before with
 165         None -> ()
 166       | Some lb when lb =|= info.Ast.line -> ()
 167       | _ -> force_newline());
 168       fn s line lcol;
 169       let _ = print_comments (Some info.Ast.line) info.Ast.straft in
 170       (* newline after a pragma
 171          should really store parsed versions of the strings, but make a cheap
 172          effort here
 173          print_comments takes care of interior newlines *)
 174       ()
 175       (* printing for rule generation *)
 176   | (true, Ast.MINUS(_,_,_,plus_stream)) ->
 177       force_newline();
 178       print_text "- ";
 179       fn s line lcol; print_pos pos;
 180       print_anything plus_stream
 181   | (true, Ast.CONTEXT(_,plus_streams)) ->
 182       let fn s = force_newline(); fn s line lcol; print_pos pos in
 183       print_around fn s plus_streams
 184   | (true,Ast.PLUS Ast.ONE) ->
 185       let fn s =
 186         force_newline(); print_text "+ "; fn s line lcol; print_pos pos in
 187       print_string_befaft fn (function _ -> print_text "+ ") s info
 188   | (true,Ast.PLUS Ast.MANY) ->
 189       let fn s =
 190         force_newline(); print_text "++ "; fn s line lcol; print_pos pos in
 191       print_string_befaft fn (function _ -> print_text "++ ") s info
 192 in
 193
 194
 195 (* --------------------------------------------------------------------- *)
 196
 197 let handle_metavar name fn =
 198   let ((_,b) as s,info,mc,pos) = name in
 199   let line = info.Ast.line in
 200   let lcol = info.Ast.column in
 201   match Common.optionise (fun () -> List.assoc s env) with
 202     None ->
 203       let name_string (_,s) = s in
 204       if generating
 205       then
 206         mcode (function _ -> print_string (name_string s)) name
 207       else
 208         failwith
 209           (Printf.sprintf "SP line %d: Not found a value in env for: %s"
 210              line (name_string s))
 211   | Some e  ->
 212       pr_barrier line lcol;
 213       (if generating
 214       then
 215         (* call mcode to preserve the -+ annotation *)
 216         mcode (fun _ _ _ -> fn e) name
 217       else fn e);
 218       let rcol =
 219         if lcol = unknown then unknown else lcol + (String.length b) in
 220       pr_barrier line rcol
 221 in
 222 (* --------------------------------------------------------------------- *)
 223 let dots between fn d =
 224   match Ast.unwrap d with
 225     Ast.DOTS(l) -> print_between between fn l
 226   | Ast.CIRCLES(l) -> print_between between fn l
 227   | Ast.STARS(l) -> print_between between fn l
 228 in
 229
 230 let nest_dots starter ender fn f d =
 231   mcode print_string starter;
 232   f(); start_block();
 233   (match Ast.unwrap d with
 234     Ast.DOTS(l)    -> print_between force_newline fn l
 235   | Ast.CIRCLES(l) -> print_between force_newline fn l
 236   | Ast.STARS(l)   -> print_between force_newline fn l);
 237   end_block();
 238   mcode print_string ender
 239 in
 240
 241 (* --------------------------------------------------------------------- *)
 242 (* Identifier *)
 243
 244 let rec ident i =
 245   match Ast.unwrap i with
 246       Ast.Id(name) -> mcode print_string name
 247     | Ast.MetaId(name,_,_,_) ->
 248         handle_metavar name (function
 249                                | (Ast_c.MetaIdVal (id,_)) -> print_text id
 250                                | _ -> raise Impossible
 251                             )
 252     | Ast.MetaFunc(name,_,_,_) ->
 253         handle_metavar name (function
 254                                | (Ast_c.MetaFuncVal id) -> print_text id
 255                                | _ -> raise Impossible
 256                             )
 257     | Ast.MetaLocalFunc(name,_,_,_) ->
 258         handle_metavar name (function
 259                                | (Ast_c.MetaLocalFuncVal id) -> print_text id
 260                                | _ -> raise Impossible
 261                             )
 262
 263     | Ast.OptIdent(_) | Ast.UniqueIdent(_) ->
 264         raise CantBeInPlus
 265
 266 in
 267
 268 (* --------------------------------------------------------------------- *)
 269 (* Expression *)
 270
 271 let print_disj_list fn l =
 272   print_text "\n(\n";
 273   print_between (function _ -> print_text "\n|\n") fn l;
 274   print_text "\n)\n" in
 275
 276 let rec expression e =
 277   match Ast.unwrap e with
 278     Ast.Ident(id) -> ident id
 279   | Ast.Constant(const) -> mcode constant const
 280   | Ast.FunCall(fn,lp,args,rp) ->
 281       expression fn; mcode (print_string_with_hint StartBox) lp;
 282       dots (function _ -> ()) arg_expression args;
 283       mcode (print_string_with_hint EndBox) rp
 284   | Ast.Assignment(left,op,right,_) ->
 285       expression left; pr_space(); mcode assignOp op;
 286       pr_space(); expression right
 287   | Ast.CondExpr(exp1,why,exp2,colon,exp3) ->
 288       expression exp1; pr_space(); mcode print_string why;
 289       print_option (function e -> pr_space(); expression e) exp2;
 290       pr_space(); mcode print_string colon; expression exp3
 291   | Ast.Postfix(exp,op) -> expression exp; mcode fixOp op
 292   | Ast.Infix(exp,op) -> mcode fixOp op; expression exp
 293   | Ast.Unary(exp,op) -> mcode unaryOp op; expression exp
 294   | Ast.Binary(left,op,right) ->
 295       expression left; pr_space(); mcode binaryOp op; pr_space();
 296       expression right
 297   | Ast.Nested(left,op,right) -> failwith "nested only in minus code"
 298   | Ast.Paren(lp,exp,rp) ->
 299       mcode print_string_box lp; expression exp; close_box();
 300       mcode print_string rp
 301   | Ast.ArrayAccess(exp1,lb,exp2,rb) ->
 302       expression exp1; mcode print_string_box lb; expression exp2; close_box();
 303       mcode print_string rb
 304   | Ast.RecordAccess(exp,pt,field) ->
 305       expression exp; mcode print_string pt; ident field
 306   | Ast.RecordPtAccess(exp,ar,field) ->
 307       expression exp; mcode print_string ar; ident field
 308   | Ast.Cast(lp,ty,rp,exp) ->
 309       mcode print_string_box lp; fullType ty; close_box();
 310       mcode print_string rp; expression exp
 311   | Ast.SizeOfExpr(sizeof,exp) ->
 312       mcode print_string sizeof; expression exp
 313   | Ast.SizeOfType(sizeof,lp,ty,rp) ->
 314       mcode print_string sizeof;
 315       mcode print_string_box lp; fullType ty; close_box();
 316       mcode print_string rp
 317   | Ast.TypeExp(ty) -> fullType ty
 318
 319   | Ast.MetaErr(name,_,_,_) ->
 320       failwith "metaErr not handled"
 321
 322   | Ast.MetaExpr (name,_,_,_typedontcare,_formdontcare,_) ->
 323       handle_metavar name  (function
 324         | Ast_c.MetaExprVal (exp,_) ->
 325             pretty_print_c.Pretty_print_c.expression exp
 326         | _ -> raise Impossible
 327       )
 328
 329   | Ast.MetaExprList (name,_,_,_) ->
 330       handle_metavar name  (function
 331         | Ast_c.MetaExprListVal args ->
 332             pretty_print_c.Pretty_print_c.arg_list args
 333         | _ -> raise Impossible
 334       )
 335
 336   | Ast.EComma(cm) -> mcode print_string cm
 337
 338   | Ast.DisjExpr(exp_list) ->
 339       if generating
 340       then print_disj_list expression exp_list
 341       else raise CantBeInPlus
 342   | Ast.NestExpr(starter,expr_dots,ender,Some whencode,multi)
 343     when generating ->
 344       nest_dots starter ender expression
 345         (function _ -> print_text "   when != "; expression whencode)
 346         expr_dots
 347   | Ast.NestExpr(starter,expr_dots,ender,None,multi) when generating ->
 348       nest_dots starter ender expression (function _ -> ()) expr_dots
 349   | Ast.NestExpr _ -> raise CantBeInPlus
 350   | Ast.Edots(dots,Some whencode)
 351   | Ast.Ecircles(dots,Some whencode)
 352   | Ast.Estars(dots,Some whencode) ->
 353       if generating
 354       then
 355         (mcode print_string dots;
 356          print_text "   when != ";
 357          expression whencode)
 358       else raise CantBeInPlus
 359   | Ast.Edots(dots,None)
 360   | Ast.Ecircles(dots,None)
 361   | Ast.Estars(dots,None) ->
 362       if generating
 363       then mcode print_string dots
 364       else raise CantBeInPlus
 365
 366   | Ast.OptExp(exp) | Ast.UniqueExp(exp) ->
 367       raise CantBeInPlus
 368
 369 and arg_expression e =
 370   match Ast.unwrap e with
 371     Ast.EComma(cm) ->
 372       (* space is only used by add_newline, and only if not using SMPL
 373          spacing.  pr_cspace uses a " " in unparse_c.ml.  Not so nice... *)
 374       mcode (print_string_with_hint (SpaceOrNewline (ref " ")))  cm
 375   | _ -> expression e
 376
 377 and  unaryOp = function
 378     Ast.GetRef -> print_string "&"
 379   | Ast.DeRef -> print_string "*"
 380   | Ast.UnPlus -> print_string "+"
 381   | Ast.UnMinus -> print_string "-"
 382   | Ast.Tilde -> print_string "~"
 383   | Ast.Not -> print_string "!"
 384
 385 and  assignOp = function
 386     Ast.SimpleAssign -> print_string "="
 387   | Ast.OpAssign(aop) ->
 388       (function line -> function lcol ->
 389         arithOp aop line lcol; print_string "=" line lcol)
 390
 391 and  fixOp = function
 392     Ast.Dec -> print_string "--"
 393   | Ast.Inc -> print_string "++"
 394
 395 and  binaryOp = function
 396     Ast.Arith(aop) -> arithOp aop
 397   | Ast.Logical(lop) -> logicalOp lop
 398
 399 and  arithOp = function
 400     Ast.Plus -> print_string "+"
 401   | Ast.Minus -> print_string "-"
 402   | Ast.Mul -> print_string "*"
 403   | Ast.Div -> print_string "/"
 404   | Ast.Mod -> print_string "%"
 405   | Ast.DecLeft -> print_string "<<"
 406   | Ast.DecRight -> print_string ">>"
 407   | Ast.And -> print_string "&"
 408   | Ast.Or -> print_string "|"
 409   | Ast.Xor -> print_string "^"
 410
 411 and  logicalOp = function
 412     Ast.Inf -> print_string "<"
 413   | Ast.Sup -> print_string ">"
 414   | Ast.InfEq -> print_string "<="
 415   | Ast.SupEq -> print_string ">="
 416   | Ast.Eq -> print_string "=="
 417   | Ast.NotEq -> print_string "!="
 418   | Ast.AndLog -> print_string "&&"
 419   | Ast.OrLog -> print_string "||"
 420
 421 and constant = function
 422     Ast.String(s) -> print_string ("\""^s^"\"")
 423   | Ast.Char(s) -> print_string ("\'"^s^"\'")
 424   | Ast.Int(s) -> print_string s
 425   | Ast.Float(s) -> print_string s
 426
 427 (* --------------------------------------------------------------------- *)
 428 (* Types *)
 429
 430
 431 and fullType ft =
 432   match Ast.unwrap ft with
 433     Ast.Type(cv,ty) -> print_option_space (mcode const_vol) cv; typeC ty
 434   | Ast.DisjType _ -> failwith "can't be in plus"
 435   | Ast.OptType(_) | Ast.UniqueType(_) ->
 436       raise CantBeInPlus
 437
 438 and print_function_pointer (ty,lp1,star,rp1,lp2,params,rp2) fn =
 439   fullType ty; mcode print_string lp1; mcode print_string star; fn();
 440   mcode print_string rp1; mcode print_string lp1;
 441   parameter_list params; mcode print_string rp2
 442
 443 and print_function_type (ty,lp1,params,rp1) fn =
 444   print_option fullType ty; fn(); mcode print_string lp1;
 445   parameter_list params; mcode print_string rp1
 446
 447 and typeC ty =
 448   match Ast.unwrap ty with
 449     Ast.BaseType(ty,strings) ->
 450       print_between pr_space (mcode print_string) strings
 451   | Ast.SignedT(sgn,ty) -> mcode sign sgn; print_option_prespace typeC ty
 452   | Ast.Pointer(ty,star) -> fullType ty; ft_space ty; mcode print_string star
 453   | Ast.FunctionPointer(ty,lp1,star,rp1,lp2,params,rp2) ->
 454       print_function_pointer (ty,lp1,star,rp1,lp2,params,rp2)
 455         (function _ -> ())
 456   | Ast.FunctionType (am,ty,lp1,params,rp1) ->
 457       print_function_type (ty,lp1,params,rp1) (function _ -> ())
 458   | Ast.Array(ty,lb,size,rb) ->
 459       fullType ty; mcode print_string lb; print_option expression size;
 460       mcode print_string rb
 461   | Ast.EnumName(kind,name) -> mcode print_string kind; pr_space();
 462       ident name
 463   | Ast.StructUnionName(kind,name) ->
 464       mcode structUnion kind; print_option_prespace ident name
 465   | Ast.StructUnionDef(ty,lb,decls,rb) ->
 466       fullType ty; ft_space ty;
 467       mcode print_string lb;
 468       dots force_newline declaration decls;
 469       mcode print_string rb
 470   | Ast.TypeName(name)-> mcode print_string name
 471   | Ast.MetaType(name,_,_) ->
 472       handle_metavar name  (function
 473           Ast_c.MetaTypeVal exp ->
 474             pretty_print_c.Pretty_print_c.ty exp
 475         | _ -> raise Impossible)
 476
 477 and baseType = function
 478     Ast.VoidType -> print_string "void"
 479   | Ast.CharType -> print_string "char"
 480   | Ast.ShortType -> print_string "short"
 481   | Ast.IntType -> print_string "int"
 482   | Ast.DoubleType -> print_string "double"
 483   | Ast.FloatType -> print_string "float"
 484   | Ast.LongType -> print_string "long"
 485   | Ast.LongLongType -> print_string "long long"
 486
 487 and structUnion = function
 488     Ast.Struct -> print_string "struct"
 489   | Ast.Union -> print_string "union"
 490
 491 and sign = function
 492     Ast.Signed -> print_string "signed"
 493   | Ast.Unsigned -> print_string "unsigned"
 494
 495
 496 and const_vol = function
 497     Ast.Const -> print_string "const"
 498   | Ast.Volatile -> print_string "volatile"
 499
 500 (* --------------------------------------------------------------------- *)
 501 (* Function declaration *)
 502
 503 and storage = function
 504     Ast.Static -> print_string "static"
 505   | Ast.Auto -> print_string "auto"
 506   | Ast.Register -> print_string "register"
 507   | Ast.Extern -> print_string "extern"
 508
 509 (* --------------------------------------------------------------------- *)
 510 (* Variable declaration *)
 511
 512 and print_named_type ty id =
 513   match Ast.unwrap ty with
 514     Ast.Type(None,ty1) ->
 515       (match Ast.unwrap ty1 with
 516         Ast.FunctionPointer(ty,lp1,star,rp1,lp2,params,rp2) ->
 517           print_function_pointer (ty,lp1,star,rp1,lp2,params,rp2)
 518             (function _ -> pr_space(); ident id)
 519       | Ast.FunctionType(am,ty,lp1,params,rp1) ->
 520           print_function_type (ty,lp1,params,rp1)
 521             (function _ -> pr_space(); ident id)
 522       | Ast.Array(_,_,_,_) ->
 523           let rec loop ty k =
 524             match Ast.unwrap ty with
 525               Ast.Array(ty,lb,size,rb) ->
 526                 (match Ast.unwrap ty with
 527                   Ast.Type(None,ty) ->
 528                     loop ty
 529                       (function _ ->
 530                         k ();
 531                         mcode print_string lb;
 532                         print_option expression size;
 533                         mcode print_string rb)
 534                 | _ -> failwith "complex array types not supported")
 535             | _ -> typeC ty; ty_space ty; ident id; k () in
 536           loop ty1 (function _ -> ())
 537     (*| should have a case here for pointer to array or function type
 538         that would put ( * ) around the variable.  This makes one wonder
 539         why we really need a special case for function pointer *)
 540       | _ -> fullType ty; ft_space ty; ident id)
 541   | _ -> fullType ty; ft_space ty; ident id
 542
 543 and ty_space ty =
 544   match Ast.unwrap ty with
 545     Ast.Pointer(_,_) -> ()
 546   | _ -> pr_space()
 547
 548 and ft_space ty =
 549   match Ast.unwrap ty with
 550     Ast.Type(cv,ty) ->
 551       (match Ast.unwrap ty with
 552         Ast.Pointer(_,_) -> ()
 553       | Ast.MetaType(name,_,_) ->
 554           (match List.assoc (Ast.unwrap_mcode name) env with
 555             Ast_c.MetaTypeVal (tq,ty) ->
 556               (match Ast_c.unwrap ty with
 557                 Ast_c.Pointer(_,_) -> ()
 558               | _ -> pr_space())
 559           | _ -> pr_space())
 560       | _ -> pr_space())
 561   | _ -> pr_space()
 562
 563 and declaration d =
 564   match Ast.unwrap d with
 565     Ast.Init(stg,ty,id,eq,ini,sem) ->
 566       print_option (mcode storage) stg;
 567       print_option (function _ -> pr_space()) stg;
 568       print_named_type ty id;
 569       pr_space(); mcode print_string eq;
 570       pr_space(); initialiser true ini; mcode print_string sem
 571   | Ast.UnInit(stg,ty,id,sem) ->
 572       print_option (mcode storage) stg;
 573       print_option (function _ -> pr_space()) stg;
 574       print_named_type ty id;
 575       mcode print_string sem
 576   | Ast.MacroDecl(name,lp,args,rp,sem) ->
 577       ident name; mcode print_string_box lp;
 578       dots (function _ -> ()) expression args;
 579       close_box(); mcode print_string rp; mcode print_string sem
 580   | Ast.TyDecl(ty,sem) -> fullType ty; mcode print_string sem
 581   | Ast.Typedef(stg,ty,id,sem) ->
 582       mcode print_string stg;
 583       fullType ty; typeC id;
 584       mcode print_string sem
 585   | Ast.DisjDecl(_) | Ast.MetaDecl(_,_,_) -> raise CantBeInPlus
 586   | Ast.Ddots(_,_) -> raise CantBeInPlus
 587   | Ast.OptDecl(decl)  | Ast.UniqueDecl(decl) ->
 588       raise CantBeInPlus
 589
 590 (* --------------------------------------------------------------------- *)
 591 (* Initialiser *)
 592
 593 and initialiser nlcomma i =
 594   match Ast.unwrap i with
 595     Ast.MetaInit(name,_,_) ->
 596       handle_metavar name  (function
 597           Ast_c.MetaInitVal ini ->
 598             pretty_print_c.Pretty_print_c.init ini
 599         | _ -> raise Impossible)
 600   | Ast.InitExpr(exp) -> expression exp
 601   | Ast.InitList(lb,initlist,rb,[]) ->
 602       mcode print_string lb; start_block();
 603       (* awkward, because the comma is separate from the initialiser *)
 604       let rec loop = function
 605           [] -> ()
 606         | [x] -> initialiser false x
 607         | x::xs -> initialiser nlcomma x; loop xs in
 608       loop initlist;
 609       end_block(); mcode print_string rb
 610   | Ast.InitList(lb,initlist,rb,_) -> failwith "unexpected whencode in plus"
 611   | Ast.InitGccExt(designators,eq,ini) ->
 612       List.iter designator designators; pr_space();
 613       mcode print_string eq; pr_space(); initialiser nlcomma ini
 614   | Ast.InitGccName(name,eq,ini) ->
 615       ident name; mcode print_string eq; initialiser nlcomma ini
 616   | Ast.IComma(comma) ->
 617       mcode print_string comma;
 618       if nlcomma then force_newline()
 619   | Ast.OptIni(ini) | Ast.UniqueIni(ini) ->
 620       raise CantBeInPlus
 621
 622 and designator = function
 623     Ast.DesignatorField(dot,id) -> mcode print_string dot; ident id
 624   | Ast.DesignatorIndex(lb,exp,rb) ->
 625       mcode print_string lb; expression exp; mcode print_string rb
 626   | Ast.DesignatorRange(lb,min,dots,max,rb) ->
 627       mcode print_string lb; expression min; mcode print_string dots;
 628       expression max; mcode print_string rb
 629
 630 (* --------------------------------------------------------------------- *)
 631 (* Parameter *)
 632
 633 and parameterTypeDef p =
 634   match Ast.unwrap p with
 635     Ast.VoidParam(ty) -> fullType ty
 636   | Ast.Param(ty,Some id) -> print_named_type ty id
 637   | Ast.Param(ty,None) -> fullType ty
 638
 639   | Ast.MetaParam(name,_,_) ->
 640       handle_metavar name
 641         (function
 642             Ast_c.MetaParamVal p ->
 643               pretty_print_c.Pretty_print_c.param p
 644           | _ -> raise Impossible)
 645   | Ast.MetaParamList(name,_,_,_) ->
 646       failwith "not handling MetaParamList"
 647
 648   | Ast.PComma(cm) -> mcode print_string cm
 649   | Ast.Pdots(dots) | Ast.Pcircles(dots) when generating ->
 650       mcode print_string dots
 651   | Ast.Pdots(dots) | Ast.Pcircles(dots) -> raise CantBeInPlus
 652   | Ast.OptParam(param) | Ast.UniqueParam(param) -> raise CantBeInPlus
 653
 654 and parameter_list l =
 655   let comma p =
 656     parameterTypeDef p;
 657     match Ast.unwrap p with
 658       Ast.PComma(cm) -> pr_space()
 659     | _ -> () in
 660   dots (function _ -> ()) comma l
 661 in
 662
 663
 664 (* --------------------------------------------------------------------- *)
 665 (* CPP code *)
 666
 667 let rec inc_file = function
 668     Ast.Local(elems) ->
 669       print_string ("\""^(String.concat "/" (List.map inc_elem elems))^"\"")
 670   | Ast.NonLocal(elems) ->
 671       print_string ("<"^(String.concat "/" (List.map inc_elem elems))^">")
 672
 673 and inc_elem = function
 674     Ast.IncPath s -> s
 675   | Ast.IncDots -> "..."
 676
 677 (* --------------------------------------------------------------------- *)
 678 (* Top-level code *)
 679
 680 and rule_elem arity re =
 681   match Ast.unwrap re with
 682     Ast.FunHeader(_,_,fninfo,name,lp,params,rp) ->
 683       pr_arity arity; List.iter print_fninfo fninfo;
 684       ident name; mcode print_string_box lp;
 685       parameter_list params; close_box(); mcode print_string rp;
 686       pr_space()
 687   | Ast.Decl(_,_,decl) -> pr_arity arity; declaration decl
 688
 689   | Ast.SeqStart(brace) ->
 690       pr_arity arity; mcode print_string brace; start_block()
 691   | Ast.SeqEnd(brace) ->
 692       end_block(); pr_arity arity; mcode print_string brace
 693
 694   | Ast.ExprStatement(exp,sem) ->
 695       pr_arity arity; expression exp; mcode print_string sem
 696
 697   | Ast.IfHeader(iff,lp,exp,rp) ->
 698       pr_arity arity;
 699       mcode print_string iff; pr_space(); mcode print_string_box lp;
 700       expression exp; close_box(); mcode print_string rp
 701   | Ast.Else(els) ->
 702       pr_arity arity; mcode print_string els
 703
 704   | Ast.WhileHeader(whl,lp,exp,rp) ->
 705       pr_arity arity;
 706       mcode print_string whl; pr_space(); mcode print_string_box lp;
 707       expression exp; close_box(); mcode print_string rp
 708   | Ast.DoHeader(d) ->
 709       pr_arity arity; mcode print_string d
 710   | Ast.WhileTail(whl,lp,exp,rp,sem) ->
 711       pr_arity arity;
 712       mcode print_string whl; pr_space(); mcode print_string_box lp;
 713       expression exp; close_box(); mcode print_string rp;
 714       mcode print_string sem
 715   | Ast.ForHeader(fr,lp,e1,sem1,e2,sem2,e3,rp) ->
 716       pr_arity arity;
 717       mcode print_string fr; mcode print_string_box lp;
 718       print_option expression e1; mcode print_string sem1;
 719       print_option expression e2; mcode print_string sem2;
 720       print_option expression e3; close_box();
 721       mcode print_string rp
 722   | Ast.IteratorHeader(nm,lp,args,rp) ->
 723       pr_arity arity;
 724       ident nm; pr_space(); mcode print_string_box lp;
 725       dots (function _ -> ()) expression args; close_box();
 726       mcode print_string rp
 727
 728   | Ast.SwitchHeader(switch,lp,exp,rp) ->
 729       pr_arity arity;
 730       mcode print_string switch; pr_space(); mcode print_string_box lp;
 731       expression exp; close_box(); mcode print_string rp
 732
 733   | Ast.Break(br,sem) ->
 734       pr_arity arity; mcode print_string br; mcode print_string sem
 735   | Ast.Continue(cont,sem) ->
 736       pr_arity arity; mcode print_string cont; mcode print_string sem
 737   | Ast.Label(l,dd) -> ident l; mcode print_string dd
 738   | Ast.Goto(goto,l,sem) ->
 739       mcode print_string goto; ident l; mcode print_string sem
 740   | Ast.Return(ret,sem) ->
 741       pr_arity arity; mcode print_string ret;
 742       mcode print_string sem
 743   | Ast.ReturnExpr(ret,exp,sem) ->
 744       pr_arity arity; mcode print_string ret; pr_space();
 745       expression exp; mcode print_string sem
 746
 747   | Ast.Exp(exp) -> pr_arity arity; expression exp
 748   | Ast.TopExp(exp) -> pr_arity arity; expression exp
 749   | Ast.Ty(ty) -> pr_arity arity; fullType ty
 750   | Ast.TopInit(init) -> initialiser false init
 751   | Ast.Include(inc,s) ->
 752       mcode print_string inc; print_text " "; mcode inc_file s
 753   | Ast.DefineHeader(def,id,params) ->
 754       mcode print_string def; pr_space(); ident id;
 755       print_define_parameters params
 756   | Ast.Default(def,colon) ->
 757       mcode print_string def; mcode print_string colon; pr_space()
 758   | Ast.Case(case,exp,colon) ->
 759       mcode print_string case; pr_space(); expression exp;
 760       mcode print_string colon; pr_space()
 761   | Ast.DisjRuleElem(res) ->
 762       if generating
 763       then
 764         (pr_arity arity; print_text "\n(\n";
 765          print_between (function _ -> print_text "\n|\n") (rule_elem arity)
 766            res;
 767          print_text "\n)")
 768       else raise CantBeInPlus
 769
 770   | Ast.MetaRuleElem(name,_,_) ->
 771       raise Impossible
 772
 773   | Ast.MetaStmt(name,_,_,_) ->
 774       handle_metavar name  (function
 775         | Ast_c.MetaStmtVal stm ->
 776             pretty_print_c.Pretty_print_c.statement stm
 777         | _ -> raise Impossible
 778                            )
 779   | Ast.MetaStmtList(name,_,_) ->
 780       failwith
 781         "MetaStmtList not supported (not even in ast_c metavars binding)"
 782
 783 and print_define_parameters params =
 784   match Ast.unwrap params with
 785     Ast.NoParams -> ()
 786   | Ast.DParams(lp,params,rp) ->
 787       mcode print_string lp;
 788       dots (function _ -> ()) print_define_param params; mcode print_string rp
 789
 790 and print_define_param param =
 791   match Ast.unwrap param with
 792     Ast.DParam(id) -> ident id
 793   | Ast.DPComma(comma) -> mcode print_string comma
 794   | Ast.DPdots(dots) -> mcode print_string dots
 795   | Ast.DPcircles(circles) -> mcode print_string circles
 796   | Ast.OptDParam(dp) -> print_text "?"; print_define_param dp
 797   | Ast.UniqueDParam(dp) -> print_text "!"; print_define_param dp
 798
 799 and print_fninfo = function
 800     Ast.FStorage(stg) -> mcode storage stg
 801   | Ast.FType(ty) -> fullType ty
 802   | Ast.FInline(inline) -> mcode print_string inline; pr_space()
 803   | Ast.FAttr(attr) -> mcode print_string attr; pr_space() in
 804
 805 let indent_if_needed s f =
 806   match Ast.unwrap s with
 807     Ast.Seq(lbrace,body,rbrace) -> pr_space(); f()
 808   | _ ->
 809       (*no newline at the end - someone else will do that*)
 810       start_block(); f(); unindent true in
 811
 812 let rec statement arity s =
 813   match Ast.unwrap s with
 814     Ast.Seq(lbrace,body,rbrace) ->
 815       rule_elem arity lbrace;
 816       dots force_newline (statement arity) body;
 817       rule_elem arity rbrace
 818
 819   | Ast.IfThen(header,branch,_) ->
 820       rule_elem arity header;
 821       indent_if_needed branch (function _ -> statement arity branch)
 822   | Ast.IfThenElse(header,branch1,els,branch2,_) ->
 823       rule_elem arity header;
 824       indent_if_needed branch1 (function _ -> statement arity branch1);
 825       force_newline();
 826       rule_elem arity els;
 827       indent_if_needed branch2 (function _ -> statement arity branch2)
 828   | Ast.While(header,body,_) ->
 829       rule_elem arity header;
 830       indent_if_needed body (function _ -> statement arity body)
 831   | Ast.Do(header,body,tail) ->
 832       rule_elem arity header;
 833       indent_if_needed body (function _ -> statement arity body);
 834       rule_elem arity tail
 835   | Ast.For(header,body,_) ->
 836       rule_elem arity header;
 837       indent_if_needed body (function _ -> statement arity body)
 838   | Ast.Iterator(header,body,(_,_,_,aft)) ->
 839       rule_elem arity header;
 840       indent_if_needed body (function _ -> statement arity body);
 841       mcode (fun _ _ _ -> ()) ((),Ast.no_info,aft,Ast.NoMetaPos)
 842
 843   | Ast.Switch(header,lb,decls,cases,rb) ->
 844       rule_elem arity header; pr_space(); rule_elem arity lb;
 845       dots force_newline (statement arity) decls;
 846       List.iter (function x -> case_line arity x; force_newline()) cases;
 847       rule_elem arity rb
 848
 849   | Ast.Atomic(re) -> rule_elem arity re
 850
 851   | Ast.FunDecl(header,lbrace,body,rbrace) ->
 852       rule_elem arity header; rule_elem arity lbrace;
 853       dots force_newline (statement arity) body; rule_elem arity rbrace
 854
 855   | Ast.Define(header,body) ->
 856       rule_elem arity header; pr_space();
 857       dots force_newline (statement arity) body
 858
 859   | Ast.Disj([stmt_dots]) ->
 860       if generating
 861       then
 862         (pr_arity arity;
 863          dots force_newline (statement arity) stmt_dots)
 864       else raise CantBeInPlus
 865   | Ast.Disj(stmt_dots_list) -> (* ignores newline directive for readability *)
 866       if generating
 867       then
 868         (pr_arity arity; print_text "\n(\n";
 869          print_between (function _ -> print_text "\n|\n")
 870            (dots force_newline (statement arity))
 871            stmt_dots_list;
 872          print_text "\n)")
 873       else raise CantBeInPlus
 874   | Ast.Nest(starter,stmt_dots,ender,whn,multi,_,_) when generating ->
 875       pr_arity arity;
 876       nest_dots starter ender (statement arity)
 877         (function _ ->
 878           print_between force_newline
 879             (whencode (dots force_newline (statement "")) (statement "")) whn;
 880           force_newline())
 881         stmt_dots
 882   | Ast.Nest(_) -> raise CantBeInPlus
 883   | Ast.Dots(d,whn,_,_) | Ast.Circles(d,whn,_,_) | Ast.Stars(d,whn,_,_) ->
 884       if generating
 885       then
 886         (pr_arity arity; mcode print_string d;
 887          print_between force_newline
 888            (whencode (dots force_newline (statement "")) (statement "")) whn;
 889          force_newline())
 890       else raise CantBeInPlus
 891
 892   | Ast.OptStm(s) | Ast.UniqueStm(s) ->
 893       raise CantBeInPlus
 894
 895 and whencode notfn alwaysfn = function
 896     Ast.WhenNot a ->
 897       print_text "   WHEN != "; notfn a
 898   | Ast.WhenAlways a ->
 899       print_text "   WHEN = "; alwaysfn a
 900   | Ast.WhenModifier x -> print_text "   WHEN "; print_when_modif x
 901   | Ast.WhenNotTrue a ->
 902       print_text "   WHEN != TRUE "; rule_elem "" a
 903   | Ast.WhenNotFalse a ->
 904       print_text "   WHEN != FALSE "; rule_elem "" a
 905
 906 and print_when_modif = function
 907   | Ast.WhenAny    -> print_text "ANY"
 908   | Ast.WhenStrict -> print_text "STRICT"
 909   | Ast.WhenForall -> print_text "FORALL"
 910   | Ast.WhenExists -> print_text "EXISTS"
 911
 912 and case_line arity c =
 913   match Ast.unwrap c with
 914     Ast.CaseLine(header,code) ->
 915       rule_elem arity header; pr_space();
 916       dots force_newline (statement arity) code
 917   | Ast.OptCase(case) -> raise CantBeInPlus in
 918
 919 let top_level t =
 920   match Ast.unwrap t with
 921     Ast.FILEINFO(old_file,new_file) -> raise CantBeInPlus
 922   | Ast.DECL(stmt) -> statement "" stmt
 923   | Ast.CODE(stmt_dots) -> dots force_newline (statement "") stmt_dots
 924   | Ast.ERRORWORDS(exps) -> raise CantBeInPlus
 925 in
 926
 927 (*
 928 let rule =
 929   print_between (function _ -> force_newline(); force_newline()) top_level
 930 in
 931 *)
 932
 933 let if_open_brace  = function "{" -> true | _ -> false in
 934
 935 (* boolean result indicates whether an indent is needed *)
 936 let rec pp_any = function
 937   (* assert: normally there is only CONTEXT NOTHING tokens in any *)
 938     Ast.FullTypeTag(x) -> fullType x; false
 939   | Ast.BaseTypeTag(x) -> baseType x unknown unknown; false
 940   | Ast.StructUnionTag(x) -> structUnion x unknown unknown; false
 941   | Ast.SignTag(x) -> sign x unknown unknown; false
 942
 943   | Ast.IdentTag(x) -> ident x; false
 944
 945   | Ast.ExpressionTag(x) -> expression x; false
 946
 947   | Ast.ConstantTag(x) -> constant x unknown unknown; false
 948   | Ast.UnaryOpTag(x) -> unaryOp x unknown unknown; false
 949   | Ast.AssignOpTag(x) -> assignOp x unknown unknown; false
 950   | Ast.FixOpTag(x) -> fixOp x unknown unknown; false
 951   | Ast.BinaryOpTag(x) -> binaryOp x unknown unknown; false
 952   | Ast.ArithOpTag(x) -> arithOp x unknown unknown; false
 953   | Ast.LogicalOpTag(x) -> logicalOp x unknown unknown; false
 954
 955   | Ast.InitTag(x) -> initialiser false x; false
 956   | Ast.DeclarationTag(x) -> declaration x; false
 957
 958   | Ast.StorageTag(x) -> storage x unknown unknown; false
 959   | Ast.IncFileTag(x) -> inc_file x unknown unknown; false
 960
 961   | Ast.Rule_elemTag(x) -> rule_elem "" x; false
 962   | Ast.StatementTag(x) -> statement "" x; false
 963   | Ast.CaseLineTag(x) -> case_line "" x; false
 964
 965   | Ast.ConstVolTag(x) -> const_vol x unknown unknown; false
 966   | Ast.Pragma(xs) ->
 967       let print = function Ast.Noindent s | Ast.Indent s -> print_text s in
 968       print_between force_newline print xs; false
 969   | Ast.Token(x,None) -> print_text x; if_open_brace x
 970   | Ast.Token(x,Some info) ->
 971       mcode
 972         (fun x line lcol ->
 973           (match x with
 974             "else" -> force_newline()
 975           | _ -> ());
 976           print_string x line lcol)
 977         (let nomcodekind = Ast.CONTEXT(Ast.DontCarePos,Ast.NOTHING) in
 978         (x,info,nomcodekind,Ast.NoMetaPos));
 979       if_open_brace x
 980
 981   | Ast.Code(x) -> let _ = top_level x in false
 982
 983   (* this is not '...', but a list of expr/statement/params, and
 984      normally there should be no '...' inside them *)
 985   | Ast.ExprDotsTag(x) -> dots (function _ -> ()) expression x; false
 986   | Ast.ParamDotsTag(x) -> parameter_list x; false
 987   | Ast.StmtDotsTag(x) -> dots force_newline (statement "") x; false
 988   | Ast.DeclDotsTag(x) -> dots force_newline declaration x; false
 989
 990   | Ast.TypeCTag(x) -> typeC x; false
 991   | Ast.ParamTag(x) -> parameterTypeDef x; false
 992   | Ast.SgrepStartTag(x) -> failwith "unexpected start tag"
 993   | Ast.SgrepEndTag(x) -> failwith "unexpected end tag"
 994 in
 995
 996   anything := (function x -> let _ = pp_any x in ());
 997
 998   (* todo? imitate what is in pretty_print_cocci ? *)
 999   match xxs with
1000     [] -> ()
1001   | x::xs ->
1002       (* for many tags, we must not do a newline before the first '+' *)
1003       let isfn s =
1004         match Ast.unwrap s with Ast.FunDecl _ -> true | _ -> false in
1005       let unindent_before = function
1006         (* need to get unindent before newline for } *)
1007           (Ast.Token ("}",_)::_) -> true
1008         | _ -> false in
1009       let prnl x =
1010         (if unindent_before x then unindent true);
1011         force_newline() in
1012       let newline_before _ =
1013         if before =*= After
1014         then
1015           let hd = List.hd xxs in
1016           match hd with
1017             (Ast.StatementTag s::_) when isfn s ->
1018               force_newline(); force_newline()
1019           | (Ast.Pragma _::_)
1020           | (Ast.Rule_elemTag _::_) | (Ast.StatementTag _::_)
1021           | (Ast.InitTag _::_)
1022           | (Ast.DeclarationTag _::_) | (Ast.Token ("}",_)::_) -> prnl hd
1023           | _ -> () in
1024       let newline_after _ =
1025         if before =*= Before
1026         then
1027           match List.rev(List.hd(List.rev xxs)) with
1028             (Ast.StatementTag s::_) ->
1029               (if isfn s then force_newline());
1030               force_newline()
1031           | (Ast.Pragma _::_)
1032           | (Ast.Rule_elemTag _::_) | (Ast.InitTag _::_)
1033           | (Ast.DeclarationTag _::_) | (Ast.Token ("{",_)::_) ->
1034               force_newline()
1035           | _ -> () in
1036       (* print a newline at the beginning, if needed *)
1037       newline_before();
1038       (* print a newline before each of the rest *)
1039       let rec loop leading_newline indent_needed = function
1040           [] -> ()
1041         | x::xs ->
1042             (if leading_newline
1043             then
1044               match (indent_needed,unindent_before x) with
1045                 (true,true) -> force_newline()
1046               | (true,false) -> force_newline(); indent()
1047               | (false,true) -> unindent true; force_newline()
1048               | (false,false) -> force_newline());
1049             let space_needed_before = function
1050                 Ast.ParamTag(x) ->
1051                   (match Ast.unwrap x with
1052                     Ast.PComma _ -> false
1053                   | _ -> true)
1054               | Ast.ExpressionTag(x) ->
1055                   (match Ast.unwrap x with
1056                     Ast.EComma _ -> false
1057                   | _ -> true)
1058               | Ast.InitTag(x) ->
1059                   (match Ast.unwrap x with
1060                     Ast.IComma _ -> false
1061                   | _ -> true)
1062               | Ast.Token(t,_) when List.mem t [",";";";"(";")"] -> false
1063               | _ -> true in
1064             let space_needed_after = function
1065                 Ast.Token(t,_) when List.mem t ["("] -> (*never needed*) false
1066               | Ast.Token(t,_) when List.mem t ["if";"for";"while";"do"] ->
1067                   (* space always needed *)
1068                   pr_space(); false
1069               | Ast.ExpressionTag(e) ->
1070                   (match Ast.unwrap e with
1071                     Ast.EComma _ ->
1072                       (* space always needed *)
1073                       pr_space(); false
1074                   | _ -> true)
1075               | t -> true in
1076             let indent_needed =
1077               let rec loop space_after indent_needed = function
1078                   [] -> indent_needed
1079                 | x::xs ->
1080                     (if space_after && space_needed_before x
1081                     then pr_space());
1082                     let indent_needed = pp_any x in
1083                     let space_after = space_needed_after x in
1084                     loop space_after indent_needed xs in
1085               loop false false x in
1086             loop true indent_needed xs in
1087       loop false false (x::xs);
1088       (* print a newline at the end, if needed *)
1089       newline_after()
1090
1091 let rec pp_list_list_any (envs, pr, pr_celem, pr_cspace, pr_space, pr_arity,
1092                           pr_barrier, indent, unindent)
1093     generating xxs before =
1094   List.iter
1095     (function env ->
1096       do_all (env, pr, pr_celem, pr_cspace, pr_space, pr_arity, pr_barrier,
1097               indent, unindent)
1098         generating xxs before)
1099     envs