bin/syncqt

   1 #!/usr/bin/perl -w
   2 ######################################################################
   3 #
   4 # Synchronizes Qt header files - internal development tool.
   5 #
   6 # Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   7 # Contact: Nokia Corporation (qt-info@nokia.com)
   8 #
   9 ######################################################################
  10
  11 # use packages -------------------------------------------------------
  12 use File::Basename;
  13 use File::Path;
  14 use Cwd;
  15 use Cwd 'abs_path';
  16 use Config;
  17 use strict;
  18
  19 # set output basedir to be where ever syncqt is run from
  20 our $out_basedir = getcwd();
  21 $out_basedir =~ s=\\=/=g;
  22 our $basedir;
  23 our $quoted_basedir;
  24
  25
  26 # try to figure out where QtBase is located
  27 # normally the script location should be enough, if not fall back to
  28 # QTDIR environment variable. If that doesn't work, later ask the
  29 # user to use the -qtdir option explicitly.
  30 my $qtbasedir = dirname(dirname($0));
  31 $qtbasedir = $ENV{"QTDIR"} if ($qtbasedir !~ /qtbase/);
  32 $qtbasedir =~ s=\\=/=g if (defined $qtbasedir);
  33
  34 # will be defined based on the modules sync.profile
  35 our (%modules, %moduleheaders, %classnames, %mastercontent, %modulepris);
  36
  37 # global variables (modified by options)
  38 my $isunix = 0;
  39 my $module = 0;
  40 my $showonly = 0;
  41 my $quiet = 0;
  42 my $remove_stale = 1;
  43 my $force_win = 0;
  44 my $force_relative = 0;
  45 my $check_includes = 0;
  46 my $copy_headers = 0;
  47 my $create_uic_class_map = 0;
  48 my $create_private_headers = 1;
  49 my $no_module_fwd = 0;
  50 my @modules_to_sync ;
  51 $force_relative = 1 if ( -d "/System/Library/Frameworks" );
  52
  53
  54 # functions ----------------------------------------------------------
  55
  56 ######################################################################
  57 # Syntax:  showUsage()
  58 # Params:  -none-
  59 #
  60 # Purpose: Show the usage of the script.
  61 # Returns: -none-
  62 ######################################################################
  63 sub showUsage
  64 {
  65     print "$0 usage:\n";
  66     print "  <module directory>    Specifies which module to sync header files for (required for shadow builds!)\n\n";
  67
  68     print "  -copy                 Copy headers instead of include-fwd(default: " . ($copy_headers ? "yes" : "no") . ")\n";
  69     print "  -remove-stale         Removes stale headers              (default: " . ($remove_stale ? "yes" : "no") . ")\n";
  70     print "  -relative             Force relative symlinks            (default: " . ($force_relative ? "yes" : "no") . ")\n";
  71     print "  -windows              Force platform to Windows          (default: " . ($force_win ? "yes" : "no") . ")\n";
  72     print "  -showonly             Show action but not perform        (default: " . ($showonly ? "yes" : "no") . ")\n";
  73     print "  -outdir <PATH>        Specify output directory for sync  (default: $out_basedir)\n";
  74     print "  -qtdir <PATH>         Set the path to QtBase           (detected: " . (defined $qtbasedir ? $qtbasedir : "-none-") . ")\n";
  75     print "  -quiet                Only report problems, not activity (default: " . ($quiet ? "yes" : "no") . ")\n";
  76     print "  -separate-module <NAME>:<PROFILEDIR>:<HEADERDIR>\n";
  77     print "                        Create headers for <NAME> with original headers in <HEADERDIR> relative to <PROFILEDIR> \n";
  78     print "  -private              Force copy private headers         (default: " . ($create_private_headers ? "yes" : "no") . ")\n";
  79     print "  -no-module-fwd        Don't create fwd includes for module pri files\n";
  80     print "  -help                 This help\n";
  81     exit 0;
  82 }
  83
  84 ######################################################################
  85 # Syntax:  checkUnix()
  86 # Params:  -none-
  87 #
  88 # Purpose: Check if script runs on a Unix system or not. Cygwin
  89 #          systems are _not_ detected as Unix systems.
  90 # Returns: 1 if a unix system, else 0.
  91 ######################################################################
  92 sub checkUnix {
  93     my ($r) = 0;
  94     if ( $force_win != 0) {
  95         return 0;
  96     } elsif ( -f "/bin/uname" ) {
  97         $r = 1;
  98         (-f "\\bin\\uname") && ($r = 0);
  99     } elsif ( -f "/usr/bin/uname" ) {
 100         $r = 1;
 101         (-f "\\usr\\bin\\uname") && ($r = 0);
 102     }
 103     if($r) {
 104         $_ = $Config{'osname'};
 105         $r = 0 if( /(ms)|(cyg)win/i );
 106     }
 107     return $r;
 108 }
 109
 110 sub checkRelative {
 111     my ($dir) = @_;
 112     return 0 if($dir =~ /^\//);
 113     return 0 if(!checkUnix() && $dir =~ /[a-zA-Z]:[\/\\]/);
 114     return 1;
 115 }
 116
 117 ######################################################################
 118 # Syntax:  shouldMasterInclude(iheader)
 119 # Params:  iheader, string, filename to verify inclusion
 120 #
 121 # Purpose: Determines if header should be in the master include file.
 122 # Returns: 0 if file contains "#pragma qt_no_master_include" or not
 123 #          able to open, else 1.
 124 ######################################################################
 125 sub shouldMasterInclude {
 126     my ($iheader) = @_;
 127     return 0 if(basename($iheader) =~ /_/);
 128     return 0 if(basename($iheader) =~ /qconfig/);
 129     if(open(F, "<$iheader")) {
 130         while(<F>) {
 131             chomp;
 132             return 0 if(/^\#pragma qt_no_master_include$/);
 133         }
 134         close(F);
 135     } else {
 136         return 0;
 137     }
 138     return 1;
 139 }
 140
 141 ######################################################################
 142 # Syntax:  classNames(iheader)
 143 # Params:  iheader, string, filename to parse for classname "symlinks"
 144 #
 145 # Purpose: Scans through iheader to find all classnames that should be
 146 #          synced into library's include structure.
 147 # Returns: List of all class names in a file.
 148 ######################################################################
 149 sub classNames {
 150     my @ret;
 151     my ($iheader) = @_;
 152
 153     my $classname = $classnames{basename($iheader)};
 154     push @ret, $classname if ($classname);
 155
 156     my $parsable = "";
 157     if(open(F, "<$iheader")) {
 158         while(<F>) {
 159             my $line = $_;
 160             chomp $line;
 161                         chop $line if ($line =~ /\r$/);
 162             if($line =~ /^\#/) {
 163                 if($line =~ /\\$/) {
 164                     while($line = <F>) {
 165                         chomp $line;
 166                         last unless($line =~ /\\$/);
 167                     }
 168                 }
 169                 return @ret if($line =~ m/^#pragma qt_sync_stop_processing/);
 170                 push(@ret, $1) if($line =~ m/^#pragma qt_class\(([^)]*)\)[\r\n]*$/);
 171                 $line = 0;
 172             }
 173             if($line) {
 174                 $line =~ s,//.*$,,; #remove c++ comments
 175                 $line .= ";" if($line =~ m/^Q_[A-Z_]*\(.*\)[\r\n]*$/); #qt macro
 176                 $line .= ";" if($line =~ m/^QT_(BEGIN|END)_HEADER[\r\n]*$/); #qt macro
 177                 $line .= ";" if($line =~ m/^QT_(BEGIN|END)_NAMESPACE[\r\n]*$/); #qt macro
 178                 $line .= ";" if($line =~ m/^QT_MODULE\(.*\)[\r\n]*$/); # QT_MODULE macro
 179                 $parsable .= " " . $line;
 180             }
 181         }
 182         close(F);
 183     }
 184
 185     my $last_definition = 0;
 186     my @namespaces;
 187     for(my $i = 0; $i < length($parsable); $i++) {
 188         my $definition = 0;
 189         my $character = substr($parsable, $i, 1);
 190         if($character eq "/" && substr($parsable, $i+1, 1) eq "*") { #I parse like this for greedy reasons
 191             for($i+=2; $i < length($parsable); $i++) {
 192                 my $end = substr($parsable, $i, 2);
 193                 if($end eq "*/") {
 194                     $last_definition = $i+2;
 195                     $i++;
 196                     last;
 197                 }
 198             }
 199         } elsif($character eq "{") {
 200             my $brace_depth = 1;
 201             my $block_start = $i + 1;
 202           BLOCK: for($i+=1; $i < length($parsable); $i++) {
 203               my $ignore = substr($parsable, $i, 1);
 204               if($ignore eq "{") {
 205                   $brace_depth++;
 206               } elsif($ignore eq "}") {
 207                   $brace_depth--;
 208                   unless($brace_depth) {
 209                       for(my $i2 = $i+1; $i2 < length($parsable); $i2++) {
 210                           my $end = substr($parsable, $i2, 1);
 211                           if($end eq ";" || $end ne " ") {
 212                               $definition = substr($parsable, $last_definition, $block_start - $last_definition) . "}";
 213                               $i = $i2 if($end eq ";");
 214                               $last_definition = $i + 1;
 215                               last BLOCK;
 216                           }
 217                       }
 218                   }
 219               }
 220           }
 221         } elsif($character eq ";") {
 222             $definition = substr($parsable, $last_definition, $i - $last_definition + 1);
 223             $last_definition = $i + 1;
 224         } elsif($character eq "}") {
 225             # a naked } must be a namespace ending
 226             # if it's not a namespace, it's eaten by the loop above
 227             pop @namespaces;
 228             $last_definition = $i + 1;
 229         }
 230
 231         if (substr($parsable, $last_definition, $i - $last_definition + 1) =~ m/ namespace ([^ ]*) /
 232             && substr($parsable, $i+1, 1) eq "{") {
 233             push @namespaces, $1;
 234
 235             # Eat the opening { so that the condensing loop above doesn't see it
 236             $i++;
 237             $last_definition = $i + 1;
 238         }
 239
 240         if($definition) {
 241             $definition =~ s=[\n\r]==g;
 242             my @symbols;
 243             if($definition =~ m/^ *typedef *.*\(\*([^\)]*)\)\(.*\);$/) {
 244                 push @symbols, $1;
 245             } elsif($definition =~ m/^ *typedef +(.*) +([^ ]*);$/) {
 246                 push @symbols, $2;
 247             } elsif($definition =~ m/^ *(template *<.*> *)?(class|struct) +([^ ]* +)?([^<\s]+) ?(<[^>]*> ?)?\s*((,|:)\s*(public|protected|private) *.*)? *\{\}$/) {
 248                 push @symbols, $4;
 249             } elsif($definition =~ m/^ *Q_DECLARE_.*ITERATOR\((.*)\);$/) {
 250                 push @symbols, "Q" . $1 . "Iterator";
 251                 push @symbols, "QMutable" . $1 . "Iterator";
 252             }
 253
 254             foreach my $symbol (@symbols) {
 255                 $symbol = (join("::", @namespaces) . "::" . $symbol) if (scalar @namespaces);
 256                 push @ret, $symbol
 257                     if ($symbol =~ /^Q[^:]*$/           # no-namespace, starting with Q
 258                         || $symbol =~ /^Phonon::/);     # or in the Phonon namespace
 259             }
 260         }
 261     }
 262     return @ret;
 263 }
 264
 265 ######################################################################
 266 # Syntax:  syncHeader(header, iheader, copy, timestamp)
 267 # Params:  header, string, filename to create "symlink" for
 268 #          iheader, string, destination name of symlink
 269 #          copy, forces header to be a copy of iheader
 270 #          timestamp, the requested modification time if copying
 271 #
 272 # Purpose: Syncronizes header to iheader
 273 # Returns: 1 if successful, else 0.
 274 ######################################################################
 275 sub syncHeader {
 276     my ($header, $iheader, $copy, $ts) = @_;
 277     $iheader =~ s=\\=/=g;
 278     $header =~ s=\\=/=g;
 279     return copyFile($iheader, $header) if($copy);
 280
 281     unless(-e $header) {
 282         my $header_dir = dirname($header);
 283         mkpath $header_dir, !$quiet;
 284
 285         #write it
 286         my $iheader_out = fixPaths($iheader, $header_dir);
 287         open HEADER, ">$header" || die "Could not open $header for writing!\n";
 288         print HEADER "#include \"$iheader_out\"\n";
 289         close HEADER;
 290         if(defined($ts)) {
 291             utime(time, $ts, $header) or die "$iheader, $header";
 292         }
 293         return 1;
 294     }
 295     return 0;
 296 }
 297
 298 ######################################################################
 299 # Syntax:  fixPaths(file, dir)
 300 # Params:  file, string, filepath to be made relative to dir
 301 #          dir, string, dirpath for point of origin
 302 #
 303 # Purpose: file is made relative (if possible) of dir.
 304 # Returns: String with the above applied conversion.
 305 ######################################################################
 306 sub fixPaths {
 307     my ($file, $dir) = @_;
 308     $file =~ s=\\=/=g;
 309     $dir =~ s=\\=/=g;
 310
 311     #setup
 312     my $ret = $file;
 313     $ret =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;
 314     my $file_dir = dirname($file);
 315     if($file_dir eq ".") {
 316         $file_dir = getcwd();
 317         $file_dir =~ s=\\=/=g;
 318     }
 319     $file_dir =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;
 320     if($dir eq ".") {
 321         $dir = getcwd();
 322         $dir =~ s=\\=/=g;
 323     }
 324     $dir =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;
 325     return basename($file) if($file_dir eq $dir);
 326
 327     #guts
 328     while ($file_dir =~ s,/[^/]+/\.\./,/,) {}
 329     while ($dir =~ s,/[^/]+/\.\./,/,) {}
 330     my $match_dir = 0;
 331     for(my $i = 1; $i < length($file_dir); $i++) {
 332         my $slash = index($file_dir, "/", $i);
 333         last if($slash == -1);
 334         my $tmp = substr($file_dir, 0, $slash);
 335         last unless($dir =~ m,^\Q$tmp\E/,);
 336         $match_dir = $tmp;
 337         $i = $slash;
 338     }
 339     if($match_dir) {
 340         my $after = substr($dir, length($match_dir));
 341         my $count = ($after =~ tr,/,,);
 342         my $dots = "";
 343         for(my $i = 0; $i < $count; $i++) {
 344             $dots .= "../";
 345         }
 346         $ret =~ s,^\Q$match_dir\E,$dots,;
 347     }
 348     $ret =~ s,/+,/,g;
 349     return $ret;
 350 }
 351
 352 ######################################################################
 353 # Syntax:  fileContents(filename)
 354 # Params:  filename, string, filename of file to return contents
 355 #
 356 # Purpose: Get the contents of a file.
 357 # Returns: String with contents of the file, or empty string if file
 358 #          doens't exist.
 359 # Warning: Dies if it does exist but script cannot get read access.
 360 ######################################################################
 361 sub fileContents {
 362     my ($filename) = @_;
 363     my $filecontents = "";
 364     if (-e $filename) {
 365         open(I, "< $filename") || die "Could not open $filename for reading, read block?";
 366         local $/;
 367         binmode I;
 368         $filecontents = <I>;
 369         close I;
 370     }
 371     return $filecontents;
 372 }
 373
 374 ######################################################################
 375 # Syntax:  fileCompare(file1, file2)
 376 # Params:  file1, string, filename of first file
 377 #          file2, string, filename of second file
 378 #
 379 # Purpose: Determines if files are equal, and which one is newer.
 380 # Returns: 0 if files are equal no matter the timestamp, -1 if file1
 381 #          is newer, 1 if file2 is newer.
 382 ######################################################################
 383 sub fileCompare {
 384     my ($file1, $file2) = @_;
 385     my $file1contents = fileContents($file1);
 386     my $file2contents = fileContents($file2);
 387     if (! -e $file1) { return 1; }
 388     if (! -e $file2) { return -1; }
 389     return $file1contents ne $file2contents ? (stat($file2))[9] <=> (stat($file1))[9] : 0;
 390 }
 391
 392 ######################################################################
 393 # Syntax:  copyFile(file, ifile)
 394 # Params:  file, string, filename to create duplicate for
 395 #          ifile, string, destination name of duplicate
 396 #
 397 # Purpose: Keeps files in sync so changes in the newer file will be
 398 #          written to the other.
 399 # Returns: 1 if files were synced, else 0.
 400 # Warning: Dies if script cannot get write access.
 401 ######################################################################
 402 sub copyFile
 403 {
 404     my ($file,$ifile, $copy,$knowdiff,$filecontents,$ifilecontents) = @_;
 405     # Bi-directional synchronization
 406     open( I, "< " . $file ) || die "Could not open $file for reading";
 407     local $/;
 408     binmode I;
 409     $filecontents = <I>;
 410     close I;
 411     if ( open(I, "< " . $ifile) ) {
 412         local $/;
 413         binmode I;
 414         $ifilecontents = <I>;
 415         close I;
 416         $copy = fileCompare($file, $ifile);
 417         $knowdiff = 0,
 418     } else {
 419         $copy = -1;
 420         $knowdiff = 1;
 421     }
 422
 423     if ( $knowdiff || ($filecontents ne $ifilecontents) ) {
 424         if ( $copy > 0 ) {
 425             my $file_dir = dirname($file);
 426             mkpath $file_dir, !$quiet unless(-e $file_dir);
 427             open(O, "> " . $file) || die "Could not open $file for writing (no write permission?)";
 428             local $/;
 429             binmode O;
 430             print O $ifilecontents;
 431             close O;
 432             utime time, (stat($ifile))[9], $file;
 433             return 1;
 434         } elsif ( $copy < 0 ) {
 435             my $ifile_dir = dirname($ifile);
 436             mkpath $ifile_dir, !$quiet unless(-e $ifile_dir);
 437             open(O, "> " . $ifile) || die "Could not open $ifile for writing (no write permission?)";
 438             local $/;
 439             binmode O;
 440             print O $filecontents;
 441             close O;
 442             utime time, (stat($file))[9], $ifile;
 443             return 1;
 444         }
 445     }
 446     return 0;
 447 }
 448
 449 ######################################################################
 450 # Syntax:  symlinkFile(file, ifile)
 451 # Params:  file, string, filename to create "symlink" for
 452 #          ifile, string, destination name of symlink
 453 #
 454 # Purpose: File is symlinked to ifile (or copied if filesystem doesn't
 455 #          support symlink).
 456 # Returns: 1 on success, else 0.
 457 ######################################################################
 458 sub symlinkFile
 459 {
 460     my ($file,$ifile) = @_;
 461
 462     if ($isunix) {
 463         print "symlink created for $file " unless $quiet;
 464         if ( $force_relative && ($ifile =~ /^$quoted_basedir/)) {
 465             my $t = getcwd();
 466             my $c = -1;
 467             my $p = "../";
 468             $t =~ s-^$quoted_basedir/--;
 469             $p .= "../" while( ($c = index( $t, "/", $c + 1)) != -1 );
 470             $file =~ s-^$quoted_basedir/-$p-;
 471             print " ($file)\n" unless $quiet;
 472         }
 473         print "\n" unless $quiet;
 474         return symlink($file, $ifile);
 475     }
 476     return copyFile($file, $ifile);
 477 }
 478
 479 ######################################################################
 480 # Syntax:  findFiles(dir, match, descend)
 481 # Params:  dir, string, directory to search for name
 482 #          match, string, regular expression to match in dir
 483 #          descend, integer, 0 = non-recursive search
 484 #                            1 = recurse search into subdirectories
 485 #
 486 # Purpose: Finds files matching a regular expression.
 487 # Returns: List of matching files.
 488 #
 489 # Examples:
 490 #   findFiles("/usr","\.cpp$",1)  - finds .cpp files in /usr and below
 491 #   findFiles("/tmp","^#",0)      - finds #* files in /tmp
 492 ######################################################################
 493 sub findFiles {
 494     my ($dir,$match,$descend) = @_;
 495     my ($file,$p,@files);
 496     local(*D);
 497     $dir =~ s=\\=/=g;
 498     ($dir eq "") && ($dir = ".");
 499     if ( opendir(D,$dir) ) {
 500         if ( $dir eq "." ) {
 501             $dir = "";
 502         } else {
 503             ($dir =~ /\/$/) || ($dir .= "/");
 504         }
 505         foreach $file ( sort readdir(D) ) {
 506             next if ( $file  =~ /^\.\.?$/ );
 507             $p = $file;
 508             ($file =~ /$match/) && (push @files, $p);
 509             if ( $descend && -d $p && ! -l $p ) {
 510                 push @files, &findFiles($p,$match,$descend);
 511             }
 512         }
 513         closedir(D);
 514     }
 515     return @files;
 516 }
 517
 518 ######################################################################
 519 # Syntax:  loadSyncProfile()
 520 #
 521 # Purpose: Locates the sync.profile.
 522 # Returns: Hashmap of module name -> directory.
 523 ######################################################################
 524 sub loadSyncProfile {
 525     my ($srcbase, $outbase) = @_;
 526     print("srcbase = $$srcbase \n");
 527     print("outbase = $$outbase \n");
 528
 529     my $syncprofile = "$$srcbase/sync.profile";
 530     my $result;
 531     unless ($result = do "$syncprofile") {
 532         die "syncqt couldn't parse $syncprofile: $@" if $@;
 533         die "syncqt couldn't execute $syncprofile: $!" unless defined $result;
 534     }
 535     return $result;
 536 }
 537
 538 sub locateSyncProfile
 539 {
 540     my ($directory) = @_;
 541     my $syncprofile;
 542     $directory = abs_path($directory);
 543     while(!defined $syncprofile) {
 544         local(*D);
 545         if (opendir(D, $directory)) {
 546             foreach my $file (sort readdir(D)) {
 547                 next if ($file =~ /^\.\.?$/);
 548                 $syncprofile = "$directory/$file" if ($file =~ /^sync\.profile$/);
 549                 last if (defined $syncprofile);
 550             }
 551             closedir(D);
 552         }
 553         last if (defined $syncprofile || $directory eq "/" || $directory =~ /^?:[\/\\]$/);
 554         $directory = dirname($directory);
 555     }
 556     return $syncprofile;
 557 }
 558
 559 # check if this is an in-source build, and if so use that as the basedir too
 560 $basedir = locateSyncProfile($out_basedir);
 561 $basedir = dirname($basedir) if ($basedir);
 562 $quoted_basedir = "\Q$basedir";
 563
 564 # --------------------------------------------------------------------
 565 # "main" function
 566 # --------------------------------------------------------------------
 567
 568 while ( @ARGV ) {
 569     my $var = 0;
 570     my $val = 0;
 571
 572     #parse
 573     my $arg = shift @ARGV;
 574     if ($arg eq "-h" || $arg eq "-help" || $arg eq "-?" || $arg eq "?") {
 575         $var = "show_help";
 576         $val = "yes";
 577     } elsif($arg eq "-copy") {
 578         $var = "copy";
 579         $val = "yes";
 580     } elsif($arg eq "-o" || $arg eq "-outdir") {
 581         $var = "output";
 582         $val = shift @ARGV;
 583     } elsif($arg eq "-showonly" || $arg eq "-remove-stale" || $arg eq "-windows" ||
 584             $arg eq "-relative" || $arg eq "-check-includes") {
 585         $var = substr($arg, 1);
 586         $val = "yes";
 587     } elsif($arg =~ /^-no-(.*)$/) {
 588         $var = $1;
 589         $val = "no";
 590         #these are for commandline compat
 591     } elsif($arg eq "-inc") {
 592         $var = "output";
 593         $val = shift @ARGV;
 594     } elsif($arg eq "-module") {
 595         $var = "module";
 596         $val = shift @ARGV;
 597     } elsif($arg eq "-separate-module") {
 598         $var = "separate-module";
 599         $val = shift @ARGV;
 600     } elsif($arg eq "-show") {
 601         $var = "showonly";
 602         $val = "yes";
 603     } elsif($arg eq "-quiet") {
 604         $var = "quiet";
 605         $val = "yes";
 606     } elsif($arg eq "-private") {
 607         $var = "create_private_headers";
 608         $val = "yes";
 609     } elsif($arg eq "-qtdir") {
 610         $var = "qtdir";
 611         $val = shift @ARGV;
 612     } elsif($arg eq "-base-dir") {
 613         # skip, it's been dealt with at the top of the file
 614         shift @ARGV;
 615         next;
 616     } elsif($arg eq "-no-module-fwd") {
 617         $var = "no_module_fwd";
 618         $val = "yes";
 619     } elsif($arg =~/^-/) {
 620         print "Unknown option: $arg\n\n" if(!$var);
 621         showUsage();
 622     } else {
 623         $basedir = locateSyncProfile($arg);
 624         die "Could not find a sync.profile for '$arg'\n" if (!$basedir);
 625         $basedir = dirname($basedir);
 626         $basedir =~ s=\\=/=g;
 627         $var = "ignore";
 628     }
 629
 630     #do something
 631     if(!$var || $var eq "show_help") {
 632         print "Unknown option: $arg\n\n" if(!$var);
 633         showUsage();
 634     } elsif ($var eq "copy") {
 635         if($val eq "yes") {
 636             $copy_headers++;
 637         } elsif($showonly) {
 638             $copy_headers--;
 639         }
 640     } elsif ($var eq "showonly") {
 641         if($val eq "yes") {
 642             $showonly++;
 643         } elsif($showonly) {
 644             $showonly--;
 645         }
 646     } elsif ($var eq "quiet") {
 647         if($val eq "yes") {
 648             $quiet++;
 649         } elsif($quiet) {
 650             $quiet--;
 651         }
 652     } elsif ($var eq "check-includes") {
 653         if($val eq "yes") {
 654             $check_includes++;
 655         } elsif($check_includes) {
 656             $check_includes--;
 657         }
 658     } elsif ($var eq "remove-stale") {
 659         if($val eq "yes") {
 660             $remove_stale++;
 661         } elsif($remove_stale) {
 662             $remove_stale--;
 663         }
 664     } elsif ($var eq "windows") {
 665         if($val eq "yes") {
 666             $force_win++;
 667         } elsif($force_win) {
 668             $force_win--;
 669         }
 670     } elsif ($var eq "relative") {
 671         if($val eq "yes") {
 672             $force_relative++;
 673         } elsif($force_relative) {
 674             $force_relative--;
 675         }
 676     } elsif ($var eq "module") {
 677         print "module :$val:\n" unless $quiet;
 678         die "No such module: $val" unless(defined $modules{$val});
 679         push @modules_to_sync, $val;
 680     } elsif ($var eq "separate-module") {
 681         my ($module, $prodir, $headerdir) = split(/:/, $val);
 682         $modules{$module} = $prodir;
 683         push @modules_to_sync, $module;
 684         $moduleheaders{$module} = $headerdir;
 685         $create_uic_class_map = 0;
 686     } elsif ($var eq "qtdir") {
 687         if($val) {
 688             $qtbasedir = $val;
 689             $qtbasedir =~ s=\\=/=g;
 690         } else {
 691             die "The -qtdir option requires an argument";
 692         }
 693     } elsif ($var eq "no_module_fwd") {
 694         $no_module_fwd = 1;
 695     } elsif ($var eq "output") {
 696         my $outdir = $val;
 697         if(checkRelative($outdir)) {
 698             $out_basedir = getcwd();
 699             chomp $out_basedir;
 700             $out_basedir .= "/" . $outdir;
 701         } else {
 702             $out_basedir = $outdir;
 703         }
 704         # \ -> /
 705         $out_basedir =~ s=\\=/=g;
 706     }
 707 }
 708
 709 # if the $qtbasedir neither has 'qtbase' somewhere in its path, nor a
 710 # '.qmake.cache' file in its directory, we assume it's not a valid path
 711 # (remember that a yet-to-be-built qtbase doesn't have this file either,
 712 # thus the 'qtbase' path check!)
 713 die "Cannot automatically detect/use provided path to QtBase's build directory!\n" .
 714     "QTDIR detected/provided: " . (defined $qtbasedir ? $qtbasedir : "-none-") . "\n" .
 715     "Please -qtdir option to provide the correct path.\nsyncqt failed"
 716         if (!defined $qtbasedir || (!-e "$qtbasedir/.qmake.cache" && $qtbasedir !~ /qtbase/));
 717
 718 # if we have no $basedir we cannot be sure which sources you want, so die
 719 die "Could not find any sync.profile for your module!\nPass <module directory> to syncqt to sync your header files.\nsyncqt failed" if (!$basedir);
 720
 721 # load the module's sync.profile here, before we can
 722 loadSyncProfile(\$basedir, \$out_basedir);
 723
 724 @modules_to_sync = keys(%modules) if($#modules_to_sync == -1);
 725
 726 $isunix = checkUnix; #cache checkUnix
 727
 728 # create path
 729 mkpath "$out_basedir/include", !$quiet;
 730 mkpath "$out_basedir/include/Qt", !$quiet;
 731
 732 my @ignore_headers = ();
 733 my $class_lib_map_contents = "";
 734 our @ignore_for_master_contents = ();
 735 our @ignore_for_include_check = ();
 736 our @ignore_for_qt_begin_header_check = ();
 737 our @ignore_for_qt_begin_namespace_check = ();
 738 our @ignore_for_qt_module_check = ();
 739 my %colliding_headers = ();
 740 my %inject_headers = ( "$basedir/src/corelib/global" => ( "qconfig.h" ) ); # all from build dir
 741
 742 foreach my $lib (@modules_to_sync) {
 743     #iteration info
 744     my $dir = $modules{$lib};
 745     my $pathtoheaders = "";
 746     $pathtoheaders = $moduleheaders{$lib} if ($moduleheaders{$lib});
 747
 748     #information used after the syncing
 749     my $pri_install_classes = "";
 750     my $pri_install_files = "";
 751     my $pri_install_pfiles = "";
 752
 753     my $libcapitals = $lib;
 754     $libcapitals =~ y/a-z/A-Z/;
 755     my $master_contents = "#ifndef QT_".$libcapitals."_MODULE_H\n#define QT_".$libcapitals."_MODULE_H\n";
 756
 757     #get dependencies
 758     if(-e "$dir/" . basename($dir) . ".pro") {
 759         if(open(F, "<$dir/" . basename($dir) . ".pro")) {
 760             while(my $line = <F>) {
 761                 chomp $line;
 762                 if($line =~ /^ *QT *\+?= *([^\r\n]*)/) {
 763                     foreach(split(/ /, $1)) {
 764                         my $content = $mastercontent{$_};
 765                         $master_contents .= $content if ($content);
 766                     }
 767                 }
 768             }
 769             close(F);
 770         }
 771     }
 772
 773     #remove the old files
 774     if($remove_stale) {
 775         my @subdirs = ("$out_basedir/include/$lib");
 776         foreach my $subdir (@subdirs) {
 777             if (opendir DIR, $subdir) {
 778                 while(my $t = readdir(DIR)) {
 779                     my $file = "$subdir/$t";
 780                     if(-d $file) {
 781                         push @subdirs, $file unless($t eq "." || $t eq "..");
 782                     } else {
 783                         my @files = ($file);
 784                         #push @files, "$out_basedir/include/Qt/$t" if(-e "$out_basedir/include/Qt/$t");
 785                         foreach my $file (@files) {
 786                            my $remove_file = 0;
 787                            if(open(F, "<$file")) {
 788                                 while(my $line = <F>) {
 789                                     chomp $line;
 790                                     if($line =~ /^\#include \"([^\"]*)\"$/) {
 791                                         my $include = $1;
 792                                         $include = $subdir . "/" . $include unless(substr($include, 0, 1) eq "/");
 793                                         $remove_file = 1 unless(-e $include);
 794                                     } else {
 795                                         $remove_file = 0;
 796                                         last;
 797                                     }
 798                                 }
 799                                 close(F);
 800                                 unlink $file if($remove_file);
 801                             }
 802                         }
 803                     }
 804                 }
 805                 closedir DIR;
 806             }
 807
 808         }
 809     }
 810
 811     #create the new ones
 812     foreach my $current_dir (split(/;/, $dir)) {
 813         my $headers_dir = $current_dir;
 814         $headers_dir .= "/$pathtoheaders" if ($pathtoheaders);
 815         #calc subdirs
 816         my @subdirs = ($headers_dir);
 817         foreach my $subdir (@subdirs) {
 818             opendir DIR, $subdir or next;
 819             while(my $t = readdir(DIR)) {
 820                 push @subdirs, "$subdir/$t" if(-d "$subdir/$t" && !($t eq ".") &&
 821                                                !($t eq "..") && !($t eq ".obj") &&
 822                                                !($t eq ".moc") && !($t eq ".rcc") &&
 823                                                !($t eq ".uic") && !($t eq "build"));
 824             }
 825             closedir DIR;
 826         }
 827
 828         #calc files and "copy" them
 829         foreach my $subdir (@subdirs) {
 830             my @headers = findFiles($subdir, "^[-a-z0-9_]*\\.h\$" , 0);
 831             if (defined $inject_headers{$subdir}) {
 832                 foreach my $if ($inject_headers{$subdir}) {
 833                     @headers = grep(!/^\Q$if\E$/, @headers); #in case we configure'd previously
 834                     push @headers, "*".$if;
 835                 }
 836             }
 837             foreach my $header (@headers) {
 838                 my $shadow = ($header =~ s/^\*//);
 839                 $header = 0 if($header =~ /^ui_.*.h/);
 840                 foreach (@ignore_headers) {
 841                     $header = 0 if($header eq $_);
 842                 }
 843                 if($header) {
 844                     my $header_copies = 0;
 845                     #figure out if it is a public header
 846                     my $public_header = $header;
 847                     if($public_header =~ /_p.h$/ || $public_header =~ /_pch.h$/) {
 848                         $public_header = 0;
 849                     } else {
 850                         foreach (@ignore_for_master_contents) {
 851                             $public_header = 0 if($header eq $_);
 852                         }
 853                     }
 854
 855                     my $iheader = $subdir . "/" . $header;
 856                     $iheader =~ s/^\Q$basedir\E/$out_basedir/ if ($shadow);
 857                     my @classes = $public_header ? classNames($iheader) : ();
 858                     if($showonly) {
 859                         print "$header [$lib]\n";
 860                         foreach(@classes) {
 861                             print "SYMBOL: $_\n";
 862                         }
 863                     } else {
 864                         my $ts = (stat($iheader))[9];
 865                         #find out all the places it goes..
 866                         my @headers;
 867                         if ($public_header) {
 868                             @headers = ( "$out_basedir/include/$lib/$header" );
 869
 870                             # write forwarding headers to include/Qt
 871                             if ($lib ne "phonon" && $subdir =~ /^$quoted_basedir\/src/) {
 872                                 my $file_name = "$out_basedir/include/Qt/$header";
 873                                 my $file_op = '>';
 874                                 my $header_content = '';
 875                                 if (exists $colliding_headers{$file_name}) {
 876                                     $file_op = '>>';
 877                                 } else {
 878                                     $colliding_headers{$file_name} = 1;
 879                                     my $warning_msg = 'Inclusion of header files from include/Qt is deprecated.';
 880                                     $header_content = "#ifndef QT_NO_QT_INCLUDE_WARN\n" .
 881                                                       "    #if defined(__GNUC__)\n" .
 882                                                       "        #warning \"$warning_msg\"\n" .
 883                                                       "    #elif defined(_MSC_VER)\n" .
 884                                                       "        #pragma message(\"WARNING: $warning_msg\")\n" .
 885                                                       "    #endif\n".
 886                                                       "#endif\n\n";
 887                                 }
 888                                 $header_content .= '#include "' . "../$lib/$header" . "\"\n";
 889                                 open HEADERFILE, $file_op, $file_name or die "unable to open '$file_name' : $!\n";
 890                                 print HEADERFILE $header_content;
 891                                 close HEADERFILE;
 892                             }
 893
 894                             foreach my $full_class (@classes) {
 895                                 my $header_base = basename($header);
 896                                 # Strip namespaces:
 897                                 my $class = $full_class;
 898                                 $class =~ s/^.*:://;
 899 #                               if ($class =~ m/::/) {
 900 #                                  class =~ s,::,/,g;
 901 #                               }
 902                                 $class_lib_map_contents .= "QT_CLASS_LIB($full_class, $lib, $header_base)\n";
 903                                 $header_copies++ if(syncHeader("$out_basedir/include/$lib/$class", "$out_basedir/include/$lib/$header", 0, $ts));
 904
 905                                 # KDE-Compat headers for Phonon
 906                                 if ($lib eq "phonon") {
 907                                     $header_copies++ if (syncHeader("$out_basedir/include/phonon_compat/Phonon/$class", "$out_basedir/include/$lib/$header", 0, $ts));
 908                                 }
 909                             }
 910                         } elsif ($create_private_headers) {
 911                             @headers = ( "$out_basedir/include/$lib/private/$header" );
 912                         }
 913                         foreach(@headers) { #sync them
 914                             $header_copies++ if(syncHeader($_, $iheader, $copy_headers && !$shadow, $ts));
 915                         }
 916
 917                         if($public_header) {
 918                             #put it into the master file
 919                             $master_contents .= "#include \"$public_header\"\n" if(shouldMasterInclude($iheader));
 920
 921                             #deal with the install directives
 922                             if($public_header) {
 923                                 my $pri_install_iheader = fixPaths($iheader, $current_dir);
 924                                 foreach my $class (@classes) {
 925                                     # Strip namespaces:
 926                                     $class =~ s/^.*:://;
 927 #                                   if ($class =~ m/::/) {
 928 #                                       $class =~ s,::,/,g;
 929 #                                   }
 930                                     my $class_header = fixPaths("$out_basedir/include/$lib/$class",
 931                                                                 $current_dir) . " ";
 932                                     $pri_install_classes .= $class_header
 933                                                                 unless($pri_install_classes =~ $class_header);
 934                                 }
 935                                 $pri_install_files.= "$pri_install_iheader ";;
 936                             }
 937                         }
 938                         else {
 939                             my $pri_install_iheader = fixPaths($iheader, $current_dir);
 940                             $pri_install_pfiles.= "$pri_install_iheader ";;
 941                         }
 942                     }
 943                     print "header created for $iheader ($header_copies)\n" if($header_copies > 0 && !$quiet);
 944                 }
 945             }
 946         }
 947     }
 948
 949     # close the master include:
 950     $master_contents .= "#endif\n";
 951
 952     unless($showonly) {
 953         my @master_includes;
 954         push @master_includes, "$out_basedir/include/$lib/$lib";
 955         push @master_includes, "$out_basedir/include/phonon_compat/Phonon/Phonon" if ($lib eq "phonon");
 956         foreach my $master_include (@master_includes) {
 957             #generate the "master" include file
 958             my @tmp = split(/;/,$modules{$lib});
 959             $pri_install_files .= fixPaths($master_include, $tmp[0]) . " "; #get the master file installed too
 960             if($master_include && -e $master_include) {
 961                 open MASTERINCLUDE, "<$master_include";
 962                 local $/;
 963                 binmode MASTERINCLUDE;
 964                 my $oldmaster = <MASTERINCLUDE>;
 965                 close MASTERINCLUDE;
 966                 $oldmaster =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
 967                 $master_include = 0 if($oldmaster eq $master_contents);
 968             }
 969             if($master_include && $master_contents) {
 970                 my $master_dir = dirname($master_include);
 971                 mkpath $master_dir, !$quiet;
 972                 print "header (master) created for $lib\n" unless $quiet;
 973                 open MASTERINCLUDE, ">$master_include";
 974                 print MASTERINCLUDE $master_contents;
 975                 close MASTERINCLUDE;
 976             }
 977         }
 978
 979         #handle the headers.pri for each module
 980         my $headers_pri_contents = "";
 981         $headers_pri_contents .= "SYNCQT.HEADER_FILES = $pri_install_files\n";
 982         $headers_pri_contents .= "SYNCQT.HEADER_CLASSES = $pri_install_classes\n";
 983         $headers_pri_contents .= "SYNCQT.PRIVATE_HEADER_FILES = $pri_install_pfiles\n";
 984         my $headers_pri_file = "$out_basedir/include/$lib/headers.pri";
 985         if(-e $headers_pri_file) {
 986             open HEADERS_PRI_FILE, "<$headers_pri_file";
 987             local $/;
 988             binmode HEADERS_PRI_FILE;
 989             my $old_headers_pri_contents = <HEADERS_PRI_FILE>;
 990             close HEADERS_PRI_FILE;
 991             $old_headers_pri_contents =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
 992             $headers_pri_file = 0 if($old_headers_pri_contents eq $headers_pri_contents);
 993         }
 994         if($headers_pri_file && $master_contents) {
 995             my $headers_pri_dir = dirname($headers_pri_file);
 996             mkpath $headers_pri_dir, !$quiet;
 997             print "headers.pri file created for $lib\n" unless $quiet;
 998             open HEADERS_PRI_FILE, ">$headers_pri_file";
 999             print HEADERS_PRI_FILE $headers_pri_contents;
1000             close HEADERS_PRI_FILE;
1001         }
1002
1003         # create forwarding module pri in qtbase/mkspecs/modules
1004         unless ($no_module_fwd) {
1005             my $modulepri = $modulepris{$lib};
1006             if (-e $modulepri) {
1007                 my $modulepriname = basename($modulepri);
1008                 my $moduleprifwd = "$qtbasedir/mkspecs/modules/$modulepriname";
1009                 open MODULE_PRI_FILE, ">$moduleprifwd";
1010                 print MODULE_PRI_FILE "QT_MODULE_BASE = $basedir\n";
1011                 print MODULE_PRI_FILE "QT_MODULE_INCLUDE_BASE = $out_basedir/include\n";
1012                 print MODULE_PRI_FILE "QT_MODULE_LIB_BASE = $out_basedir/lib\n";
1013                 print MODULE_PRI_FILE "include($modulepri)\n";
1014                 close MODULE_PRI_FILE;
1015                 utime(time, (stat($modulepri))[9], $moduleprifwd);
1016             } elsif ($modulepri) {
1017                 print "WARNING: Module $lib\'s pri file '$modulepri' not found.\nSkipped creating forwarding pri for $lib.\n";
1018             }
1019         }
1020     }
1021 }
1022 unless($showonly || !$create_uic_class_map) {
1023     my $class_lib_map = "$out_basedir/src/tools/uic/qclass_lib_map.h";
1024     if(-e $class_lib_map) {
1025         open CLASS_LIB_MAP, "<$class_lib_map";
1026         local $/;
1027         binmode CLASS_LIB_MAP;
1028         my $old_class_lib_map_contents = <CLASS_LIB_MAP>;
1029         close CLASS_LIB_MAP;
1030         $old_class_lib_map_contents =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
1031         $class_lib_map = 0 if($old_class_lib_map_contents eq $class_lib_map_contents);
1032     }
1033     if($class_lib_map) {
1034         my $class_lib_map_dir = dirname($class_lib_map);
1035         mkpath $class_lib_map_dir, !$quiet;
1036         open CLASS_LIB_MAP, ">$class_lib_map";
1037         print CLASS_LIB_MAP $class_lib_map_contents;
1038         close CLASS_LIB_MAP;
1039     }
1040 }
1041
1042 if($check_includes) {
1043     for my $lib (keys(%modules)) {
1044             #calc subdirs
1045             my @subdirs = ($modules{$lib});
1046             foreach my $subdir (@subdirs) {
1047                 opendir DIR, $subdir or die "Huh, directory ".$subdir." cannot be opened.";
1048                 while(my $t = readdir(DIR)) {
1049                     push @subdirs, "$subdir/$t" if(-d "$subdir/$t" && !($t eq ".") &&
1050                                                    !($t eq "..") && !($t eq ".obj") &&
1051                                                    !($t eq ".moc") && !($t eq ".rcc") &&
1052                                                    !($t eq ".uic") && !($t eq "build"));
1053                 }
1054                 closedir DIR;
1055             }
1056
1057             foreach my $subdir (@subdirs) {
1058                 my $header_skip_qt_module_test = 0;
1059                 foreach(@ignore_for_qt_module_check) {
1060                     foreach (split(/;/, $_)) {
1061                         $header_skip_qt_module_test = 1 if ($subdir =~ /^$_/);
1062                     }
1063                 }
1064                 my @headers = findFiles($subdir, "^[-a-z0-9_]*\\.h\$" , 0);
1065                 foreach my $header (@headers) {
1066                     my $header_skip_qt_begin_header_test = 0;
1067                     my $header_skip_qt_begin_namespace_test = 0;
1068                     $header = 0 if($header =~ /^ui_.*.h/);
1069                     foreach (@ignore_headers) {
1070                         $header = 0 if($header eq $_);
1071                     }
1072                     if($header) {
1073                         my $public_header = $header;
1074                         if($public_header =~ /_p.h$/ || $public_header =~ /_pch.h$/) {
1075                             $public_header = 0;
1076                         } else {
1077                             foreach (@ignore_for_master_contents) {
1078                                 $public_header = 0 if($header eq $_);
1079                             }
1080                             if($public_header) {
1081                                 foreach (@ignore_for_include_check) {
1082                                     $public_header = 0 if($header eq $_);
1083                                 }
1084                                 foreach(@ignore_for_qt_begin_header_check) {
1085                                     $header_skip_qt_begin_header_test = 1 if ($header eq $_);
1086                                 }
1087                                 foreach(@ignore_for_qt_begin_namespace_check) {
1088                                     $header_skip_qt_begin_namespace_test = 1 if ($header eq $_);
1089                                 }
1090                             }
1091                         }
1092
1093                         my $iheader = $subdir . "/" . $header;
1094                         if($public_header) {
1095                             if(open(F, "<$iheader")) {
1096                                 my $qt_module_found = 0;
1097                                 my $qt_begin_header_found = 0;
1098                                 my $qt_end_header_found = 0;
1099                                 my $qt_begin_namespace_found = 0;
1100                                 my $qt_end_namespace_found = 0;
1101                                 my $line;
1102                                 while($line = <F>) {
1103                                     chomp $line;
1104                                     my $output_line = 1;
1105                                     if($line =~ /^ *\# *pragma (qt_no_included_check|qt_sync_stop_processing)/) {
1106                                         last;
1107                                     } elsif($line =~ /^ *\# *include/) {
1108                                         my $include = $line;
1109                                         if($line =~ /<.*>/) {
1110                                             $include =~ s,.*<(.*)>.*,$1,;
1111                                         } elsif($line =~ /".*"/) {
1112                                             $include =~ s,.*"(.*)".*,$1,;
1113                                         } else {
1114                                             $include = 0;
1115                                         }
1116                                         if($include) {
1117                                             for my $trylib (keys(%modules)) {
1118                                                 if(-e "$out_basedir/include/$trylib/$include") {
1119                                                     print "WARNING: $iheader includes $include when it should include $trylib/$include\n";
1120                                                 }
1121                                             }
1122                                         }
1123                                     } elsif ($header_skip_qt_begin_header_test == 0 and $line =~ /^QT_BEGIN_HEADER\s*$/) {
1124                                         $qt_begin_header_found = 1;
1125                                     } elsif ($header_skip_qt_begin_header_test == 0 and $line =~ /^QT_END_HEADER\s*$/) {
1126                                         $qt_end_header_found = 1;
1127                                     } elsif ($header_skip_qt_begin_namespace_test == 0 and $line =~ /^QT_BEGIN_NAMESPACE\s*$/) {
1128                                         $qt_begin_namespace_found = 1;
1129                                     } elsif ($header_skip_qt_begin_namespace_test == 0 and $line =~ /^QT_END_NAMESPACE\s*$/) {
1130                                         $qt_end_namespace_found = 1;
1131                                     } elsif ($header_skip_qt_module_test == 0 and $line =~ /^QT_MODULE\(.*\)\s*$/) {
1132                                         $qt_module_found = 1;
1133                                     }
1134                                 }
1135                                 if ($header_skip_qt_begin_header_test == 0) {
1136                                     if ($qt_begin_header_found == 0) {
1137                                         print "WARNING: $iheader does not include QT_BEGIN_HEADER\n";
1138                                     }
1139
1140                                     if ($qt_begin_header_found && $qt_end_header_found == 0) {
1141                                         print "WARNING: $iheader has QT_BEGIN_HEADER but no QT_END_HEADER\n";
1142                                     }
1143                                 }
1144
1145                                 if ($header_skip_qt_begin_namespace_test == 0) {
1146                                     if ($qt_begin_namespace_found == 0) {
1147                                         print "WARNING: $iheader does not include QT_BEGIN_NAMESPACE\n";
1148                                     }
1149
1150                                     if ($qt_begin_namespace_found && $qt_end_namespace_found == 0) {
1151                                         print "WARNING: $iheader has QT_BEGIN_NAMESPACE but no QT_END_NAMESPACE\n";
1152                                     }
1153                                 }
1154
1155                                 if ($header_skip_qt_module_test == 0) {
1156                                     if ($qt_module_found == 0) {
1157                                         print "WARNING: $iheader does not include QT_MODULE\n";
1158                                     }
1159                                 }
1160                                 close(F);
1161                             }
1162                         }
1163                     }
1164                 }
1165             }
1166     }
1167 }
1168
1169 exit 0;