2 ######################################################################
4 # Synchronizes Qt header files - internal development tool.
6 # Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
7 # Contact: Nokia Corporation (qt-info@nokia.com)
9 ######################################################################
11 # use packages -------------------------------------------------------
19 # set output basedir to be where ever syncqt is run from
20 our $out_basedir = getcwd();
21 $out_basedir =~ s=\\=/=g;
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);
34 # will be defined based on the modules sync.profile
35 our (%modules, %moduleheaders, %classnames, %mastercontent, %modulepris);
37 # global variables (modified by options)
44 my $force_relative = 0;
45 my $check_includes = 0;
47 my $create_uic_class_map = 0;
48 my $create_private_headers = 1;
49 my $no_module_fwd = 0;
51 $force_relative = 1 if ( -d "/System/Library/Frameworks" );
54 # functions ----------------------------------------------------------
56 ######################################################################
60 # Purpose: Show the usage of the script.
62 ######################################################################
66 print " <module directory> Specifies which module to sync header files for (required for shadow builds!)\n\n";
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";
84 ######################################################################
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 ######################################################################
94 if ( $force_win != 0) {
96 } elsif ( -f "/bin/uname" ) {
98 (-f "\\bin\\uname") && ($r = 0);
99 } elsif ( -f "/usr/bin/uname" ) {
101 (-f "\\usr\\bin\\uname") && ($r = 0);
104 $_ = $Config{'osname'};
105 $r = 0 if( /(ms)|(cyg)win/i );
112 return 0 if($dir =~ /^\//);
113 return 0 if(!checkUnix() && $dir =~ /[a-zA-Z]:[\/\\]/);
117 ######################################################################
118 # Syntax: shouldMasterInclude(iheader)
119 # Params: iheader, string, filename to verify inclusion
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 {
127 return 0 if(basename($iheader) =~ /_/);
128 return 0 if(basename($iheader) =~ /qconfig/);
129 if(open(F, "<$iheader")) {
132 return 0 if(/^\#pragma qt_no_master_include$/);
141 ######################################################################
142 # Syntax: classNames(iheader)
143 # Params: iheader, string, filename to parse for classname "symlinks"
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 ######################################################################
153 my $classname = $classnames{basename($iheader)};
154 push @ret, $classname if ($classname);
157 if(open(F, "<$iheader")) {
161 chop $line if ($line =~ /\r$/);
166 last unless($line =~ /\\$/);
169 return @ret if($line =~ m/^#pragma qt_sync_stop_processing/);
170 push(@ret, $1) if($line =~ m/^#pragma qt_class\(([^)]*)\)[\r\n]*$/);
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;
185 my $last_definition = 0;
187 for(my $i = 0; $i < length($parsable); $i++) {
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);
194 $last_definition = $i+2;
199 } elsif($character eq "{") {
201 my $block_start = $i + 1;
202 BLOCK: for($i+=1; $i < length($parsable); $i++) {
203 my $ignore = substr($parsable, $i, 1);
206 } elsif($ignore eq "}") {
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;
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
228 $last_definition = $i + 1;
231 if (substr($parsable, $last_definition, $i - $last_definition + 1) =~ m/ namespace ([^ ]*) /
232 && substr($parsable, $i+1, 1) eq "{") {
233 push @namespaces, $1;
235 # Eat the opening { so that the condensing loop above doesn't see it
237 $last_definition = $i + 1;
241 $definition =~ s=[\n\r]==g;
243 if($definition =~ m/^ *typedef *.*\(\*([^\)]*)\)\(.*\);$/) {
245 } elsif($definition =~ m/^ *typedef +(.*) +([^ ]*);$/) {
247 } elsif($definition =~ m/^ *(template *<.*> *)?(class|struct) +([^ ]* +)?([^<\s]+) ?(<[^>]*> ?)?\s*((,|:)\s*(public|protected|private) *.*)? *\{\}$/) {
249 } elsif($definition =~ m/^ *Q_DECLARE_.*ITERATOR\((.*)\);$/) {
250 push @symbols, "Q" . $1 . "Iterator";
251 push @symbols, "QMutable" . $1 . "Iterator";
254 foreach my $symbol (@symbols) {
255 $symbol = (join("::", @namespaces) . "::" . $symbol) if (scalar @namespaces);
257 if ($symbol =~ /^Q[^:]*$/ # no-namespace, starting with Q
258 || $symbol =~ /^Phonon::/); # or in the Phonon namespace
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
272 # Purpose: Syncronizes header to iheader
273 # Returns: 1 if successful, else 0.
274 ######################################################################
276 my ($header, $iheader, $copy, $ts) = @_;
277 $iheader =~ s=\\=/=g;
279 return copyFile($iheader, $header) if($copy);
282 my $header_dir = dirname($header);
283 mkpath $header_dir, !$quiet;
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";
291 utime(time, $ts, $header) or die "$iheader, $header";
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
303 # Purpose: file is made relative (if possible) of dir.
304 # Returns: String with the above applied conversion.
305 ######################################################################
307 my ($file, $dir) = @_;
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;
319 $file_dir =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;
324 $dir =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;
325 return basename($file) if($file_dir eq $dir);
329 for(my $i = 1; $i < length($file_dir); $i++) {
330 my $slash = index($file_dir, "/", $i);
331 last if($slash == -1);
332 my $tmp = substr($file_dir, 0, $slash);
333 last unless($dir =~ m,^\Q$tmp\E/,);
338 my $after = substr($dir, length($match_dir));
339 my $count = ($after =~ tr,/,,);
341 for(my $i = 0; $i < $count; $i++) {
344 $ret =~ s,^\Q$match_dir\E,$dots,;
350 ######################################################################
351 # Syntax: fileContents(filename)
352 # Params: filename, string, filename of file to return contents
354 # Purpose: Get the contents of a file.
355 # Returns: String with contents of the file, or empty string if file
357 # Warning: Dies if it does exist but script cannot get read access.
358 ######################################################################
361 my $filecontents = "";
363 open(I, "< $filename") || die "Could not open $filename for reading, read block?";
369 return $filecontents;
372 ######################################################################
373 # Syntax: fileCompare(file1, file2)
374 # Params: file1, string, filename of first file
375 # file2, string, filename of second file
377 # Purpose: Determines if files are equal, and which one is newer.
378 # Returns: 0 if files are equal no matter the timestamp, -1 if file1
379 # is newer, 1 if file2 is newer.
380 ######################################################################
382 my ($file1, $file2) = @_;
383 my $file1contents = fileContents($file1);
384 my $file2contents = fileContents($file2);
385 if (! -e $file1) { return 1; }
386 if (! -e $file2) { return -1; }
387 return $file1contents ne $file2contents ? (stat($file2))[9] <=> (stat($file1))[9] : 0;
390 ######################################################################
391 # Syntax: copyFile(file, ifile)
392 # Params: file, string, filename to create duplicate for
393 # ifile, string, destination name of duplicate
395 # Purpose: Keeps files in sync so changes in the newer file will be
396 # written to the other.
397 # Returns: 1 if files were synced, else 0.
398 # Warning: Dies if script cannot get write access.
399 ######################################################################
402 my ($file,$ifile, $copy,$knowdiff,$filecontents,$ifilecontents) = @_;
403 # Bi-directional synchronization
404 open( I, "< " . $file ) || die "Could not open $file for reading";
409 if ( open(I, "< " . $ifile) ) {
412 $ifilecontents = <I>;
414 $copy = fileCompare($file, $ifile);
421 if ( $knowdiff || ($filecontents ne $ifilecontents) ) {
423 my $file_dir = dirname($file);
424 mkpath $file_dir, !$quiet unless(-e $file_dir);
425 open(O, "> " . $file) || die "Could not open $file for writing (no write permission?)";
428 print O $ifilecontents;
430 utime time, (stat($ifile))[9], $file;
432 } elsif ( $copy < 0 ) {
433 my $ifile_dir = dirname($ifile);
434 mkpath $ifile_dir, !$quiet unless(-e $ifile_dir);
435 open(O, "> " . $ifile) || die "Could not open $ifile for writing (no write permission?)";
438 print O $filecontents;
440 utime time, (stat($file))[9], $ifile;
447 ######################################################################
448 # Syntax: symlinkFile(file, ifile)
449 # Params: file, string, filename to create "symlink" for
450 # ifile, string, destination name of symlink
452 # Purpose: File is symlinked to ifile (or copied if filesystem doesn't
454 # Returns: 1 on success, else 0.
455 ######################################################################
458 my ($file,$ifile) = @_;
461 print "symlink created for $file " unless $quiet;
462 if ( $force_relative && ($ifile =~ /^$quoted_basedir/)) {
466 $t =~ s-^$quoted_basedir/--;
467 $p .= "../" while( ($c = index( $t, "/", $c + 1)) != -1 );
468 $file =~ s-^$quoted_basedir/-$p-;
469 print " ($file)\n" unless $quiet;
471 print "\n" unless $quiet;
472 return symlink($file, $ifile);
474 return copyFile($file, $ifile);
477 ######################################################################
478 # Syntax: findFiles(dir, match, descend)
479 # Params: dir, string, directory to search for name
480 # match, string, regular expression to match in dir
481 # descend, integer, 0 = non-recursive search
482 # 1 = recurse search into subdirectories
484 # Purpose: Finds files matching a regular expression.
485 # Returns: List of matching files.
488 # findFiles("/usr","\.cpp$",1) - finds .cpp files in /usr and below
489 # findFiles("/tmp","^#",0) - finds #* files in /tmp
490 ######################################################################
492 my ($dir,$match,$descend) = @_;
493 my ($file,$p,@files);
496 ($dir eq "") && ($dir = ".");
497 if ( opendir(D,$dir) ) {
501 ($dir =~ /\/$/) || ($dir .= "/");
503 foreach $file ( sort readdir(D) ) {
504 next if ( $file =~ /^\.\.?$/ );
506 ($file =~ /$match/) && (push @files, $p);
507 if ( $descend && -d $p && ! -l $p ) {
508 push @files, &findFiles($p,$match,$descend);
516 ######################################################################
517 # Syntax: loadSyncProfile()
519 # Purpose: Locates the sync.profile.
520 # Returns: Hashmap of module name -> directory.
521 ######################################################################
522 sub loadSyncProfile {
523 my ($srcbase, $outbase) = @_;
524 print("srcbase = $$srcbase \n");
525 print("outbase = $$outbase \n");
527 my $syncprofile = "$$srcbase/sync.profile";
529 unless ($result = do "$syncprofile") {
530 die "syncqt couldn't parse $syncprofile: $@" if $@;
531 die "syncqt couldn't execute $syncprofile: $!" unless defined $result;
536 sub locateSyncProfile
538 my ($directory) = @_;
540 $directory = abs_path($directory);
541 while(!defined $syncprofile) {
543 if (opendir(D, $directory)) {
544 foreach my $file (sort readdir(D)) {
545 next if ($file =~ /^\.\.?$/);
546 $syncprofile = "$directory/$file" if ($file =~ /^sync\.profile$/);
547 last if (defined $syncprofile);
551 last if (defined $syncprofile || $directory eq "/" || $directory =~ /^?:[\/\\]$/);
552 $directory = dirname($directory);
557 # check if this is an in-source build, and if so use that as the basedir too
558 $basedir = locateSyncProfile($out_basedir);
559 $basedir = dirname($basedir) if ($basedir);
560 $quoted_basedir = "\Q$basedir";
562 # --------------------------------------------------------------------
564 # --------------------------------------------------------------------
571 my $arg = shift @ARGV;
572 if ($arg eq "-h" || $arg eq "-help" || $arg eq "-?" || $arg eq "?") {
575 } elsif($arg eq "-copy") {
578 } elsif($arg eq "-o" || $arg eq "-outdir") {
581 } elsif($arg eq "-showonly" || $arg eq "-remove-stale" || $arg eq "-windows" ||
582 $arg eq "-relative" || $arg eq "-check-includes") {
583 $var = substr($arg, 1);
585 } elsif($arg =~ /^-no-(.*)$/) {
588 #these are for commandline compat
589 } elsif($arg eq "-inc") {
592 } elsif($arg eq "-module") {
595 } elsif($arg eq "-separate-module") {
596 $var = "separate-module";
598 } elsif($arg eq "-show") {
601 } elsif($arg eq "-quiet") {
604 } elsif($arg eq "-private") {
605 $var = "create_private_headers";
607 } elsif($arg eq "-qtdir") {
610 } elsif($arg eq "-base-dir") {
611 # skip, it's been dealt with at the top of the file
614 } elsif($arg eq "-no-module-fwd") {
615 $var = "no_module_fwd";
617 } elsif($arg =~/^-/) {
618 print "Unknown option: $arg\n\n" if(!$var);
621 $basedir = locateSyncProfile($arg);
622 die "Could not find a sync.profile for '$arg'\n" if (!$basedir);
623 $basedir = dirname($basedir);
624 $basedir =~ s=\\=/=g;
629 if(!$var || $var eq "show_help") {
630 print "Unknown option: $arg\n\n" if(!$var);
632 } elsif ($var eq "copy") {
638 } elsif ($var eq "showonly") {
644 } elsif ($var eq "quiet") {
650 } elsif ($var eq "check-includes") {
653 } elsif($check_includes) {
656 } elsif ($var eq "remove-stale") {
659 } elsif($remove_stale) {
662 } elsif ($var eq "windows") {
665 } elsif($force_win) {
668 } elsif ($var eq "relative") {
671 } elsif($force_relative) {
674 } elsif ($var eq "module") {
675 print "module :$val:\n" unless $quiet;
676 die "No such module: $val" unless(defined $modules{$val});
677 push @modules_to_sync, $val;
678 } elsif ($var eq "separate-module") {
679 my ($module, $prodir, $headerdir) = split(/:/, $val);
680 $modules{$module} = $prodir;
681 push @modules_to_sync, $module;
682 $moduleheaders{$module} = $headerdir;
683 $create_uic_class_map = 0;
684 } elsif ($var eq "qtdir") {
687 $qtbasedir =~ s=\\=/=g;
689 die "The -qtdir option requires an argument";
691 } elsif ($var eq "no_module_fwd") {
693 } elsif ($var eq "output") {
695 if(checkRelative($outdir)) {
696 $out_basedir = getcwd();
698 $out_basedir .= "/" . $outdir;
700 $out_basedir = $outdir;
703 $out_basedir =~ s=\\=/=g;
707 # if the $qtbasedir neither has 'qtbase' somewhere in its path, nor a
708 # '.qmake.cache' file in its directory, we assume it's not a valid path
709 # (remember that a yet-to-be-built qtbase doesn't have this file either,
710 # thus the 'qtbase' path check!)
711 die "Cannot automatically detect/use provided path to QtBase's build directory!\n" .
712 "QTDIR detected/provided: " . (defined $qtbasedir ? $qtbasedir : "-none-") . "\n" .
713 "Please -qtdir option to provide the correct path.\nsyncqt failed"
714 if (!defined $qtbasedir || (!-e "$qtbasedir/.qmake.cache" && $qtbasedir !~ /qtbase/));
716 # if we have no $basedir we cannot be sure which sources you want, so die
717 die "Could not find any sync.profile for your module!\nPass <module directory> to syncqt to sync your header files.\nsyncqt failed" if (!$basedir);
719 # load the module's sync.profile here, before we can
720 loadSyncProfile(\$basedir, \$out_basedir);
722 @modules_to_sync = keys(%modules) if($#modules_to_sync == -1);
724 $isunix = checkUnix; #cache checkUnix
727 mkpath "$out_basedir/include", !$quiet;
728 mkpath "$out_basedir/include/Qt", !$quiet;
730 my @ignore_headers = ();
731 my $class_lib_map_contents = "";
732 our @ignore_for_master_contents = ();
733 our @ignore_for_include_check = ();
734 our @ignore_for_qt_begin_header_check = ();
735 our @ignore_for_qt_begin_namespace_check = ();
736 our @ignore_for_qt_module_check = ();
737 my %colliding_headers = ();
738 my %inject_headers = ( "$basedir/src/corelib/global" => ( "qconfig.h" ) ); # all from build dir
740 foreach my $lib (@modules_to_sync) {
742 my $dir = $modules{$lib};
743 my $pathtoheaders = "";
744 $pathtoheaders = $moduleheaders{$lib} if ($moduleheaders{$lib});
746 #information used after the syncing
747 my $pri_install_classes = "";
748 my $pri_install_files = "";
749 my $pri_install_pfiles = "";
751 my $libcapitals = $lib;
752 $libcapitals =~ y/a-z/A-Z/;
753 my $master_contents = "#ifndef QT_".$libcapitals."_MODULE_H\n#define QT_".$libcapitals."_MODULE_H\n";
756 if(-e "$dir/" . basename($dir) . ".pro") {
757 if(open(F, "<$dir/" . basename($dir) . ".pro")) {
758 while(my $line = <F>) {
760 if($line =~ /^ *QT *\+?= *([^\r\n]*)/) {
761 foreach(split(/ /, $1)) {
762 my $content = $mastercontent{$_};
763 $master_contents .= $content if ($content);
771 #remove the old files
773 my @subdirs = ("$out_basedir/include/$lib");
774 foreach my $subdir (@subdirs) {
775 if (opendir DIR, $subdir) {
776 while(my $t = readdir(DIR)) {
777 my $file = "$subdir/$t";
779 push @subdirs, $file unless($t eq "." || $t eq "..");
782 #push @files, "$out_basedir/include/Qt/$t" if(-e "$out_basedir/include/Qt/$t");
783 foreach my $file (@files) {
785 if(open(F, "<$file")) {
786 while(my $line = <F>) {
788 if($line =~ /^\#include \"([^\"]*)\"$/) {
790 $include = $subdir . "/" . $include unless(substr($include, 0, 1) eq "/");
791 $remove_file = 1 unless(-e $include);
798 unlink $file if($remove_file);
810 foreach my $current_dir (split(/;/, $dir)) {
811 my $headers_dir = $current_dir;
812 $headers_dir .= "/$pathtoheaders" if ($pathtoheaders);
814 my @subdirs = ($headers_dir);
815 foreach my $subdir (@subdirs) {
816 opendir DIR, $subdir or next;
817 while(my $t = readdir(DIR)) {
818 push @subdirs, "$subdir/$t" if(-d "$subdir/$t" && !($t eq ".") &&
819 !($t eq "..") && !($t eq ".obj") &&
820 !($t eq ".moc") && !($t eq ".rcc") &&
821 !($t eq ".uic") && !($t eq "build"));
826 #calc files and "copy" them
827 foreach my $subdir (@subdirs) {
828 my @headers = findFiles($subdir, "^[-a-z0-9_]*\\.h\$" , 0);
829 if (defined $inject_headers{$subdir}) {
830 foreach my $if ($inject_headers{$subdir}) {
831 @headers = grep(!/^\Q$if\E$/, @headers); #in case we configure'd previously
832 push @headers, "*".$if;
835 foreach my $header (@headers) {
836 my $shadow = ($header =~ s/^\*//);
837 $header = 0 if($header =~ /^ui_.*.h/);
838 foreach (@ignore_headers) {
839 $header = 0 if($header eq $_);
842 my $header_copies = 0;
843 #figure out if it is a public header
844 my $public_header = $header;
845 if($public_header =~ /_p.h$/ || $public_header =~ /_pch.h$/) {
848 foreach (@ignore_for_master_contents) {
849 $public_header = 0 if($header eq $_);
853 my $iheader = $subdir . "/" . $header;
854 $iheader =~ s/^\Q$basedir\E/$out_basedir/ if ($shadow);
855 my @classes = $public_header ? classNames($iheader) : ();
857 print "$header [$lib]\n";
859 print "SYMBOL: $_\n";
862 my $ts = (stat($iheader))[9];
863 #find out all the places it goes..
865 if ($public_header) {
866 @headers = ( "$out_basedir/include/$lib/$header" );
868 # write forwarding headers to include/Qt
869 if ($lib ne "phonon" && $subdir =~ /^$quoted_basedir\/src/) {
870 my $file_name = "$out_basedir/include/Qt/$header";
872 my $header_content = '';
873 if (exists $colliding_headers{$file_name}) {
876 $colliding_headers{$file_name} = 1;
877 my $warning_msg = 'Inclusion of header files from include/Qt is deprecated.';
878 $header_content = "#ifndef QT_NO_QT_INCLUDE_WARN\n" .
879 " #if defined(__GNUC__)\n" .
880 " #warning \"$warning_msg\"\n" .
881 " #elif defined(_MSC_VER)\n" .
882 " #pragma message(\"WARNING: $warning_msg\")\n" .
886 $header_content .= '#include "' . "../$lib/$header" . "\"\n";
887 open HEADERFILE, $file_op, $file_name or die "unable to open '$file_name' : $!\n";
888 print HEADERFILE $header_content;
892 foreach my $full_class (@classes) {
893 my $header_base = basename($header);
895 my $class = $full_class;
897 # if ($class =~ m/::/) {
900 $class_lib_map_contents .= "QT_CLASS_LIB($full_class, $lib, $header_base)\n";
901 $header_copies++ if(syncHeader("$out_basedir/include/$lib/$class", "$out_basedir/include/$lib/$header", 0, $ts));
903 # KDE-Compat headers for Phonon
904 if ($lib eq "phonon") {
905 $header_copies++ if (syncHeader("$out_basedir/include/phonon_compat/Phonon/$class", "$out_basedir/include/$lib/$header", 0, $ts));
908 } elsif ($create_private_headers) {
909 @headers = ( "$out_basedir/include/$lib/private/$header" );
911 foreach(@headers) { #sync them
912 $header_copies++ if(syncHeader($_, $iheader, $copy_headers && !$shadow, $ts));
916 #put it into the master file
917 $master_contents .= "#include \"$public_header\"\n" if(shouldMasterInclude($iheader));
919 #deal with the install directives
921 my $pri_install_iheader = fixPaths($iheader, $current_dir);
922 foreach my $class (@classes) {
925 # if ($class =~ m/::/) {
926 # $class =~ s,::,/,g;
928 my $class_header = fixPaths("$out_basedir/include/$lib/$class",
930 $pri_install_classes .= $class_header
931 unless($pri_install_classes =~ $class_header);
933 $pri_install_files.= "$pri_install_iheader ";;
937 my $pri_install_iheader = fixPaths($iheader, $current_dir);
938 $pri_install_pfiles.= "$pri_install_iheader ";;
941 print "header created for $iheader ($header_copies)\n" if($header_copies > 0 && !$quiet);
947 # close the master include:
948 $master_contents .= "#endif\n";
952 push @master_includes, "$out_basedir/include/$lib/$lib";
953 push @master_includes, "$out_basedir/include/phonon_compat/Phonon/Phonon" if ($lib eq "phonon");
954 foreach my $master_include (@master_includes) {
955 #generate the "master" include file
956 my @tmp = split(/;/,$modules{$lib});
957 $pri_install_files .= fixPaths($master_include, $tmp[0]) . " "; #get the master file installed too
958 if($master_include && -e $master_include) {
959 open MASTERINCLUDE, "<$master_include";
961 binmode MASTERINCLUDE;
962 my $oldmaster = <MASTERINCLUDE>;
964 $oldmaster =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
965 $master_include = 0 if($oldmaster eq $master_contents);
967 if($master_include && $master_contents) {
968 my $master_dir = dirname($master_include);
969 mkpath $master_dir, !$quiet;
970 print "header (master) created for $lib\n" unless $quiet;
971 open MASTERINCLUDE, ">$master_include";
972 print MASTERINCLUDE $master_contents;
977 #handle the headers.pri for each module
978 my $headers_pri_contents = "";
979 $headers_pri_contents .= "SYNCQT.HEADER_FILES = $pri_install_files\n";
980 $headers_pri_contents .= "SYNCQT.HEADER_CLASSES = $pri_install_classes\n";
981 $headers_pri_contents .= "SYNCQT.PRIVATE_HEADER_FILES = $pri_install_pfiles\n";
982 my $headers_pri_file = "$out_basedir/include/$lib/headers.pri";
983 if(-e $headers_pri_file) {
984 open HEADERS_PRI_FILE, "<$headers_pri_file";
986 binmode HEADERS_PRI_FILE;
987 my $old_headers_pri_contents = <HEADERS_PRI_FILE>;
988 close HEADERS_PRI_FILE;
989 $old_headers_pri_contents =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
990 $headers_pri_file = 0 if($old_headers_pri_contents eq $headers_pri_contents);
992 if($headers_pri_file && $master_contents) {
993 my $headers_pri_dir = dirname($headers_pri_file);
994 mkpath $headers_pri_dir, !$quiet;
995 print "headers.pri file created for $lib\n" unless $quiet;
996 open HEADERS_PRI_FILE, ">$headers_pri_file";
997 print HEADERS_PRI_FILE $headers_pri_contents;
998 close HEADERS_PRI_FILE;
1001 # create forwarding module pri in qtbase/mkspecs/modules
1002 unless ($no_module_fwd) {
1003 my $modulepri = $modulepris{$lib};
1004 if (-e $modulepri) {
1005 my $modulepriname = basename($modulepri);
1006 my $moduleprifwd = "$qtbasedir/mkspecs/modules/$modulepriname";
1007 open MODULE_PRI_FILE, ">$moduleprifwd";
1008 print MODULE_PRI_FILE "QT_MODULE_BASE = $basedir\n";
1009 print MODULE_PRI_FILE "QT_MODULE_INCLUDE_BASE = $out_basedir/include\n";
1010 print MODULE_PRI_FILE "QT_MODULE_LIB_BASE = $out_basedir/lib\n";
1011 print MODULE_PRI_FILE "include($modulepri)\n";
1012 close MODULE_PRI_FILE;
1013 utime(time, (stat($modulepri))[9], $moduleprifwd);
1014 } elsif ($modulepri) {
1015 print "WARNING: Module $lib\'s pri file '$modulepri' not found.\nSkipped creating forwarding pri for $lib.\n";
1020 unless($showonly || !$create_uic_class_map) {
1021 my $class_lib_map = "$out_basedir/src/tools/uic/qclass_lib_map.h";
1022 if(-e $class_lib_map) {
1023 open CLASS_LIB_MAP, "<$class_lib_map";
1025 binmode CLASS_LIB_MAP;
1026 my $old_class_lib_map_contents = <CLASS_LIB_MAP>;
1027 close CLASS_LIB_MAP;
1028 $old_class_lib_map_contents =~ s/\r//g; # remove \r's , so comparison is ok on all platforms
1029 $class_lib_map = 0 if($old_class_lib_map_contents eq $class_lib_map_contents);
1031 if($class_lib_map) {
1032 my $class_lib_map_dir = dirname($class_lib_map);
1033 mkpath $class_lib_map_dir, !$quiet;
1034 open CLASS_LIB_MAP, ">$class_lib_map";
1035 print CLASS_LIB_MAP $class_lib_map_contents;
1036 close CLASS_LIB_MAP;
1040 if($check_includes) {
1041 for my $lib (keys(%modules)) {
1043 my @subdirs = ($modules{$lib});
1044 foreach my $subdir (@subdirs) {
1045 opendir DIR, $subdir or die "Huh, directory ".$subdir." cannot be opened.";
1046 while(my $t = readdir(DIR)) {
1047 push @subdirs, "$subdir/$t" if(-d "$subdir/$t" && !($t eq ".") &&
1048 !($t eq "..") && !($t eq ".obj") &&
1049 !($t eq ".moc") && !($t eq ".rcc") &&
1050 !($t eq ".uic") && !($t eq "build"));
1055 foreach my $subdir (@subdirs) {
1056 my $header_skip_qt_module_test = 0;
1057 foreach(@ignore_for_qt_module_check) {
1058 foreach (split(/;/, $_)) {
1059 $header_skip_qt_module_test = 1 if ($subdir =~ /^$_/);
1062 my @headers = findFiles($subdir, "^[-a-z0-9_]*\\.h\$" , 0);
1063 foreach my $header (@headers) {
1064 my $header_skip_qt_begin_header_test = 0;
1065 my $header_skip_qt_begin_namespace_test = 0;
1066 $header = 0 if($header =~ /^ui_.*.h/);
1067 foreach (@ignore_headers) {
1068 $header = 0 if($header eq $_);
1071 my $public_header = $header;
1072 if($public_header =~ /_p.h$/ || $public_header =~ /_pch.h$/) {
1075 foreach (@ignore_for_master_contents) {
1076 $public_header = 0 if($header eq $_);
1078 if($public_header) {
1079 foreach (@ignore_for_include_check) {
1080 $public_header = 0 if($header eq $_);
1082 foreach(@ignore_for_qt_begin_header_check) {
1083 $header_skip_qt_begin_header_test = 1 if ($header eq $_);
1085 foreach(@ignore_for_qt_begin_namespace_check) {
1086 $header_skip_qt_begin_namespace_test = 1 if ($header eq $_);
1091 my $iheader = $subdir . "/" . $header;
1092 if($public_header) {
1093 if(open(F, "<$iheader")) {
1094 my $qt_module_found = 0;
1095 my $qt_begin_header_found = 0;
1096 my $qt_end_header_found = 0;
1097 my $qt_begin_namespace_found = 0;
1098 my $qt_end_namespace_found = 0;
1100 while($line = <F>) {
1102 my $output_line = 1;
1103 if($line =~ /^ *\# *pragma (qt_no_included_check|qt_sync_stop_processing)/) {
1105 } elsif($line =~ /^ *\# *include/) {
1106 my $include = $line;
1107 if($line =~ /<.*>/) {
1108 $include =~ s,.*<(.*)>.*,$1,;
1109 } elsif($line =~ /".*"/) {
1110 $include =~ s,.*"(.*)".*,$1,;
1115 for my $trylib (keys(%modules)) {
1116 if(-e "$out_basedir/include/$trylib/$include") {
1117 print "WARNING: $iheader includes $include when it should include $trylib/$include\n";
1121 } elsif ($header_skip_qt_begin_header_test == 0 and $line =~ /^QT_BEGIN_HEADER\s*$/) {
1122 $qt_begin_header_found = 1;
1123 } elsif ($header_skip_qt_begin_header_test == 0 and $line =~ /^QT_END_HEADER\s*$/) {
1124 $qt_end_header_found = 1;
1125 } elsif ($header_skip_qt_begin_namespace_test == 0 and $line =~ /^QT_BEGIN_NAMESPACE\s*$/) {
1126 $qt_begin_namespace_found = 1;
1127 } elsif ($header_skip_qt_begin_namespace_test == 0 and $line =~ /^QT_END_NAMESPACE\s*$/) {
1128 $qt_end_namespace_found = 1;
1129 } elsif ($header_skip_qt_module_test == 0 and $line =~ /^QT_MODULE\(.*\)\s*$/) {
1130 $qt_module_found = 1;
1133 if ($header_skip_qt_begin_header_test == 0) {
1134 if ($qt_begin_header_found == 0) {
1135 print "WARNING: $iheader does not include QT_BEGIN_HEADER\n";
1138 if ($qt_begin_header_found && $qt_end_header_found == 0) {
1139 print "WARNING: $iheader has QT_BEGIN_HEADER but no QT_END_HEADER\n";
1143 if ($header_skip_qt_begin_namespace_test == 0) {
1144 if ($qt_begin_namespace_found == 0) {
1145 print "WARNING: $iheader does not include QT_BEGIN_NAMESPACE\n";
1148 if ($qt_begin_namespace_found && $qt_end_namespace_found == 0) {
1149 print "WARNING: $iheader has QT_BEGIN_NAMESPACE but no QT_END_NAMESPACE\n";
1153 if ($header_skip_qt_module_test == 0) {
1154 if ($qt_module_found == 0) {
1155 print "WARNING: $iheader does not include QT_MODULE\n";