tools/cxref/contrib/fixheader.pl

   1 #!/bin/sh
   2 #
   3 # C Cross Referencing & Documentation tool. Version 1.5.
   4 #
   5 # A Perl script to determine the required headers for source files.
   6 #
   7 # Written by Andrew M. Bishop
   8 #
   9 # This file Copyright 1999 Andrew M. Bishop
  10 # It may be distributed under the GNU Public License, version 2, or
  11 # any higher version.  See section COPYING of the GNU Public license
  12 # for conditions under which this file may be redistributed.
  13 #
  14
  15 exec perl -x $0 $*
  16
  17 exit 1
  18
  19 #!perl
  20
  21 # The verbose flag
  22 $verbose=0;
  23
  24 # The output flag
  25 $output=0;
  26
  27 # The compiler program.
  28 $cc="gcc";
  29 $cflags="-Wall -c";
  30
  31 # The cxref options.
  32 $cxref_root=".";
  33 $cxref_name="cxref";
  34 $cxref_output=".";
  35
  36 # The C pre-processor arguments (-D, -I).
  37 $cpp_args="";
  38
  39 # The files to check.
  40 @files=();
  41
  42 #
  43 # Parse the command line arguments
  44 #
  45
  46 if( $#ARGV==-1 )
  47   {
  48    print "Usage: fixheader filename [filename ...] [-v] [-o]\n";
  49    print "                 [-Odirname] [-Nbasename] [-Rdirname]\n";
  50    print "                 [-Ddefine] [-Udefine] [-Iinclude]\n";
  51    print "\n";
  52    print "-v    Output verbose information during the processing.\n";
  53    print "-o    Output a modified source file after testing.\n";
  54    exit 0;
  55   }
  56
  57 while ( $#ARGV >= 0 )
  58   {
  59    $_=$ARGV[0];
  60   switch:
  61      {
  62       $_ eq '-v'    && do { $verbose=1; last switch;};
  63       $_ eq '-o'    && do { $output=1; last switch;};
  64       m/^-R/        && die "The -R option is not implemented\n";
  65       m/^-N/        && do { if($_ eq "-N") {shift; $cxref_name=$ARGV[0];} else {$cxref_name=substr($_,2);} last switch;};
  66       m/^-O/        && do { if($_ eq "-O") {shift; $cxref_output=$ARGV[0];} else {$cxref_output=substr($_,2);} last switch;};
  67       -f $_         && do { push(@files,$_); last switch;};
  68
  69       $cpp_args.=" '".$_."'";
  70      }
  71    shift;
  72   }
  73
  74 #
  75 # The main program
  76 #
  77
  78 foreach $file (@files)
  79   {
  80    # Initialise the headers
  81
  82    @cur_headers=&GetFileHeaders($file);
  83
  84    @all_headers=@cur_headers;
  85
  86    %use_headers=();
  87
  88    if($file =~ m/\.h$/)
  89        {
  90         @cxref_headers=&GetCxrefHeaders();
  91
  92         foreach $h (@cxref_headers)
  93             {
  94              next if($file eq substr($h,1,length($h)-2));
  95              foreach $hh (@all_headers)
  96                  {
  97                   $h="" if($hh eq $h);
  98                  }
  99
 100              @all_headers=(@all_headers,$h) if($h =~ m/^\"/);
 101              @all_headers=($h,@all_headers) if($h =~ m/^\</);
 102             }
 103        }
 104
 105    foreach $header (@all_headers)
 106        {
 107         $use_headers{$header}=3;
 108        }
 109
 110    foreach $header (@cur_headers)
 111        {
 112         $use_headers{$header}=1;
 113        }
 114
 115    # Test the file as it is now
 116
 117    print "\nTesting file $file\n" if($verbose);
 118
 119    print "\nWe need to know how well it works without changing it\n" if($verbose);
 120    $current=&TryTheseHeaders($file,"unchanged file",());
 121
 122    if($current>=0)
 123        {
 124         @all_headers=@cur_headers;
 125        }
 126
 127    # Try all of the headers
 128
 129    if($file =~ m/\.h$/)
 130        {
 131         print "\nThis is a header file so we should try all possible headers\n" if($verbose);
 132         $all=&TryTheseHeaders($file,"all headers",@all_headers);
 133        }
 134    else
 135        {
 136         $all=$current;
 137        }
 138
 139    # Try removing headers
 140
 141    print "\nNow we try to remove unneeded headers\n" if($verbose);
 142
 143   tryagain:
 144
 145    ($remove,@remain_headers)=&TryRemovingHeaders($file,$all,@all_headers);
 146
 147    if(($all<0 && $all!=$remove) || $remove<$all)
 148        {
 149         $all=$remove;
 150         @all_headers=@remain_headers;
 151         print "\nWe need to try again now we have removed some problem headers\n" if($verbose);
 152         goto tryagain;
 153        }
 154
 155    # Print out a summary
 156
 157    print "\nSummary for $file\n\n";
 158
 159    $added="";
 160    foreach $header (@all_headers)
 161        {
 162         print "    Removed: \#include $header\n" if($use_headers{$header}==0);
 163         print "    Kept   : \#include $header\n" if($use_headers{$header}==1);
 164         print "    Added  : \#include $header\n" if($use_headers{$header}==3);
 165         $added.=" $header" if($use_headers{$header}==3);
 166        }
 167
 168    &FixupFile($file,$added) if($output);
 169
 170    print "\n";
 171   }
 172
 173
 174 #
 175 # Get the included headers from an existing file.
 176 #
 177
 178 sub GetFileHeaders
 179 {
 180  local($file)=@_;
 181  local(@headers)=();
 182
 183  # Parse the file
 184
 185  open(IN,"<$file") || die "Cannot open the source file '$file'\n";
 186
 187  while(<IN>)
 188      {
 189       push(@headers,$1) if(m/^[ \t]*\#include ([<\"][^>\"]+[>\"])/);
 190      }
 191
 192  close(IN);
 193
 194  return(@headers);
 195 }
 196
 197
 198 #
 199 # Get the headers from the cxref database
 200 #
 201
 202 sub GetCxrefHeaders
 203 {
 204  local(@headers)=();
 205  local(%headers)=();
 206
 207  open(INC,"<$cxref_output/$cxref_name.include") || die "Cannot open the cxref database file '$cxref_output/$cxref_name.include'\n";
 208
 209  while(<INC>)
 210      {
 211       chop;
 212       local($file,@heads)=split(" +");
 213
 214       foreach $h (@heads)
 215           {
 216            next if($headers{$h});
 217            $headers{$h}=1;
 218
 219            if($h =~ m/^%/)
 220                {
 221                 push(@headers,"\"".substr($h,1)."\"");
 222                }
 223            else
 224                {
 225                 push(@headers,"<".$h.">");
 226                }
 227           }
 228      }
 229
 230  close(INC);
 231
 232  return(@headers);
 233 }
 234
 235
 236 #
 237 # Try removing them one at a time.
 238 #
 239
 240 sub TryRemovingHeaders
 241 {
 242  local($file,$curr,@headers)=@_;
 243  local($best)=$curr;
 244  local(@best_headers)=();
 245
 246  foreach $header (reverse(@headers))
 247      {
 248       next if($use_headers{$header}==0 || $use_headers{$header}==2);
 249
 250       @try_headers=();
 251
 252       foreach $h (@headers)
 253           {
 254            next if($use_headers{$h}==0 || $use_headers{$h}==2);
 255            push(@try_headers,$h) if($h ne $header);
 256           }
 257
 258       $use_head=$use_headers{$header};
 259       $use_headers{$header}=-1;
 260       $try=&TryTheseHeaders($file,"to remove $header",@try_headers);
 261       $use_headers{$header}=$use_head;
 262
 263       if(($curr>=0 && $try>=0 && $try<=$curr) || ($curr<0 && $try>=0))
 264           {
 265            $use_headers{$header}--;
 266           }
 267
 268       if(($best>=0 && $try>=0 && $try<=$best) || ($best<0 && $try>$best))
 269           {
 270            $best=$try;
 271            @best_headers=@try_headers;
 272           }
 273      }
 274
 275  return($best,@best_headers);
 276 }
 277
 278
 279 #
 280 # Try the specified headers
 281 #
 282
 283 sub TryTheseHeaders
 284 {
 285  local($file,$what,@these)=@_;
 286
 287  print "  Trying $what .." if($verbose);
 288  $result=&TryCompile($file,@these);
 289  print " ($result)" if($verbose);
 290
 291  if($result>=0)
 292      {
 293       print " OK\n" if($verbose);
 294      }
 295  else
 296      {
 297       print " Failed\n" if($verbose);
 298      }
 299
 300  return $result;
 301 }
 302
 303
 304 #
 305 # Try compiling the file and see if it works.
 306 #
 307
 308 sub TryCompile
 309 {
 310  local($file,@headers)=@_;
 311  $length=0;
 312
 313 # Modify the file
 314
 315  $tmpfile=$file;
 316  $tmpfile =~ s/\.([ch])/.cxref.$1.c/;
 317
 318  die "Cannot create temporary filename from name '$file'\n" if($file eq $tmpfile);
 319
 320  open(IN,"<$file") || die "Cannot open the source file '$file'\n";
 321  open(OUT,">$tmpfile") || die "Cannot create the temporary file '$tmpfile'\n";
 322
 323  foreach $header (@headers)
 324      {
 325       print OUT "#include $header\n" if($use_headers{$header}==3);
 326      }
 327
 328  while(<IN>)
 329      {
 330       next if(m/^[ \t]*\#include ([<\"][^>\"]+[>\"])/ && $use_headers{$1}!=1);
 331       print OUT;
 332      }
 333
 334  close(IN);
 335  close(OUT);
 336
 337 # Test the compilation
 338
 339  $result=system "$cc $cflags $tmpfile -o /dev/null $cpp_args > $file.cxref-result 2>&1";
 340
 341  chop($length=`wc -l $file.cxref-result | awk '{print \$1}'`);
 342
 343  unlink "$tmpfile";
 344  unlink "$file.cxref-result";
 345
 346  $result=($result & 0xffff);
 347
 348  if($result)
 349      {$length=-1-$length;}
 350
 351  return($length);
 352 }
 353
 354
 355 #
 356 # Fixup the headers in the file.
 357 #
 358
 359 sub FixupFile
 360 {
 361  local($file,$added)=@_;
 362
 363 # Modify the file
 364
 365  $newfile=$file;
 366  $newfile =~ s/\.([ch])/.cxref.$1/;
 367
 368  die "Cannot create temporary filename from name '$file'\n" if($file eq $newfile);
 369
 370  open(IN,"<$file") || die "Cannot open the source file '$file'\n";
 371  open(OUT,">$newfile") || die "Cannot create the output file '$newfile'\n";
 372
 373  if($added)
 374      {
 375       (@added)=split(" ",$added);
 376
 377       foreach $h (@added)
 378           {
 379            printf OUT "#include %-30s /* Added by cxref */\n",$h;
 380           }
 381
 382       print OUT "\n";
 383      }
 384
 385  while(<IN>)
 386      {
 387       if(m/^[ \t]*\#include ([<\"][^>\"]+[>\"])(.*)$/)
 388           {
 389            printf OUT "/* #include %-30s* Removed by cxref */ %s\n",$1,$2 if($use_headers{$1}==0);
 390            print OUT $_ if($use_headers{$1}==1);
 391           }
 392       else
 393           {
 394            print OUT;
 395           }
 396      }
 397
 398  close(IN);
 399  close(OUT);
 400 }