#!/usr/bin/perl -w

######################################################################

#

# Synchronizes Qt header files - internal development tool.

#

# Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

# Contact: Nokia Corporation (qt-info@nokia.com)

#

######################################################################

# use packages -------------------------------------------------------

use File::Basename;

use File::Path;

use Cwd;

use Config;

use strict;

die "syncqt: QTDIR not defined" if ! $ENV{"QTDIR"}; # sanity check

# global variables

my $isunix = 0;

my $basedir = $ENV{"QTDIR"};

$basedir =~ s=\\=/=g;

my %modules = ( # path to module name map

        "QtGui" => "$basedir/src/gui",

        "QtOpenGL" => "$basedir/src/opengl",

        "QtOpenVG" => "$basedir/src/openvg",

        "QtCore" => "$basedir/src/corelib",

        "QtXml" => "$basedir/src/xml",

        "QtXmlPatterns" => "$basedir/src/xmlpatterns",

        "QtSql" => "$basedir/src/sql",

        "QtNetwork" => "$basedir/src/network",

        "QtSvg" => "$basedir/src/svg",

        "QtScript" => "$basedir/src/script",

        "QtScriptTools" => "$basedir/src/scripttools",

        "Qt3Support" => "$basedir/src/qt3support",

        "ActiveQt" => "$basedir/src/activeqt/container;$basedir/src/activeqt/control;$basedir/src/activeqt/shared",

        "QtTest" => "$basedir/src/testlib",

        "QtAssistant" => "$basedir/tools/assistant/compat/lib",

        "QtHelp" => "$basedir/tools/assistant/lib",

        "QtDesigner" => "$basedir/tools/designer/src/lib",

        "QtUiTools" => "$basedir/tools/designer/src/uitools",

        "QtDBus" => "$basedir/src/dbus",

        "QtWebKit" => "$basedir/src/3rdparty/webkit/WebCore",

        "phonon" => "$basedir/src/phonon",

        "QtMultimedia" => "$basedir/src/multimedia",

);

my %moduleheaders = ( # restrict the module headers to those found in relative path

        "QtWebKit" => "../WebKit/qt/Api",

        "phonon" => "../3rdparty/phonon/phonon",

);

#$modules{"QtCore"} .= ";$basedir/mkspecs/" . $ENV{"MKSPEC"} if defined $ENV{"MKSPEC"};

# global variables (modified by options)

my $module = 0;

my $showonly = 0;

my $remove_stale = 1;

my $force_win = 0;

my $force_relative = 0;

my $check_includes = 0;

my $copy_headers = 0;

my @modules_to_sync ;

$force_relative = 1 if ( -d "/System/Library/Frameworks" );

my $out_basedir = $basedir;

$out_basedir =~ s=\\=/=g;

# functions ----------------------------------------------------------

######################################################################

# Syntax:  showUsage()

# Params:  -none-

#

# Purpose: Show the usage of the script.

# Returns: -none-

######################################################################

sub showUsage

{

    print "$0 usage:\n";

    print "  -copy                 Copy headers instead of include-fwd(default: " . ($copy_headers ? "yes" : "no") . ")\n";

    print "  -remove-stale         Removes stale headers              (default: " . ($remove_stale ? "yes" : "no") . ")\n";

    print "  -relative             Force relative symlinks            (default: " . ($force_relative ? "yes" : "no") . ")\n";

    print "  -windows              Force platform to Windows          (default: " . ($force_win ? "yes" : "no") . ")\n";

    print "  -showonly             Show action but not perform        (default: " . ($showonly ? "yes" : "no") . ")\n";

    print "  -outdir <PATH>        Specify output directory for sync  (default: $out_basedir)\n";

    print "  -help                 This help\n";

    exit 0;

}

######################################################################

# Syntax:  checkUnix()

# Params:  -none-

#

# Purpose: Check if script runs on a Unix system or not. Cygwin

#          systems are _not_ detected as Unix systems.

# Returns: 1 if a unix system, else 0.

######################################################################

sub checkUnix {

    my ($r) = 0;

    if ( $force_win != 0) {

        return 0;

    } elsif ( -f "/bin/uname" ) {

        $r = 1;

        (-f "\\bin\\uname") && ($r = 0);

    } elsif ( -f "/usr/bin/uname" ) {

        $r = 1;

        (-f "\\usr\\bin\\uname") && ($r = 0);

    }

    if($r) {

        $_ = $Config{'osname'};

        $r = 0 if( /(ms)|(cyg)win/i );

    }

    return $r;

}

sub checkRelative {

    my ($dir) = @_;

    return 0 if($dir =~ /^\//);

    return 0 if(!checkUnix() && $dir =~ /[a-zA-Z]:[\/\\]/);

    return 1;

}

######################################################################

# Syntax:  shouldMasterInclude(iheader)

# Params:  iheader, string, filename to verify inclusion

#

# Purpose: Determines if header should be in the master include file.

# Returns: 0 if file contains "#pragma qt_no_master_include" or not

#          able to open, else 1.

######################################################################

sub shouldMasterInclude {

    my ($iheader) = @_;

    return 0 if(basename($iheader) =~ /_/);

    return 0 if(basename($iheader) =~ /qconfig/);

    if(open(F, "<$iheader")) {

        while(<F>) {

	    chomp;

	    return 0 if(/^\#pragma qt_no_master_include$/);

	}

	close(F);

    } else {

	return 0;

    }

    return 1;

}

######################################################################

# Syntax:  classNames(iheader)

# Params:  iheader, string, filename to parse for classname "symlinks"

#

# Purpose: Scans through iheader to find all classnames that should be

#          synced into library's include structure.

# Returns: List of all class names in a file.

######################################################################

sub classNames {

    my @ret;

    my ($iheader) = @_;

    if(basename($iheader) eq "qglobal.h") {

	push @ret, "QtGlobal";

    } elsif(basename($iheader) eq "qendian.h") {

	push @ret, "QtEndian";

    } elsif(basename($iheader) eq "qconfig.h") {

        push @ret, "QtConfig";

    } elsif(basename($iheader) eq "qplugin.h") {

	push @ret, "QtPlugin";

    } elsif(basename($iheader) eq "qalgorithms.h") {

	push @ret, "QtAlgorithms";

    } elsif(basename($iheader) eq "qcontainerfwd.h") {

	push @ret, "QtContainerFwd";

    } elsif(basename($iheader) eq "qdebug.h") {

        push @ret, "QtDebug";

    } elsif(basename($iheader) eq "qevent.h") {

        push @ret, "QtEvents";

    } elsif(basename($iheader) eq "qnamespace.h") {

        push @ret, "Qt"

    } elsif(basename($iheader) eq "qssl.h") {

	push @ret, "QSsl";

    } elsif(basename($iheader) eq "qtest.h") {

        push @ret, "QTest"

    } elsif(basename($iheader) eq "qtconcurrentmap.h") {

        push @ret, "QtConcurrentMap"

    } elsif(basename($iheader) eq "qtconcurrentfilter.h") {

        push @ret, "QtConcurrentFilter"

    } elsif(basename($iheader) eq "qtconcurrentrun.h") {

        push @ret, "QtConcurrentRun"

    }

    my $parsable = "";

    if(open(F, "<$iheader")) {

        while(<F>) {

            my $line = $_;

            chomp $line;

			chop $line if ($line =~ /\r$/);

            if($line =~ /^\#/) {

                if($line =~ /\\$/) {

                    while($line = <F>) {

                        chomp $line;

                        last unless($line =~ /\\$/);

                    }

                }

		return @ret if($line =~ m/^#pragma qt_sync_stop_processing/);

                push(@ret, "$1") if($line =~ m/^#pragma qt_class\(([^)]*)\)[\r\n]*$/);

		$line = 0;

            }

	    if($line) {

                $line =~ s,//.*$,,; #remove c++ comments

	        $line .= ";" if($line =~ m/^Q_[A-Z_]*\(.*\)[\r\n]*$/); #qt macro

	        $line .= ";" if($line =~ m/^QT_(BEGIN|END)_HEADER[\r\n]*$/); #qt macro

	        $line .= ";" if($line =~ m/^QT_(BEGIN|END)_NAMESPACE[\r\n]*$/); #qt macro

	        $line .= ";" if($line =~ m/^QT_MODULE\(.*\)[\r\n]*$/); # QT_MODULE macro

                $parsable .= " " . $line;

	    }

        }

        close(F);

    }

    my $last_definition = 0;

    my @namespaces;

    for(my $i = 0; $i < length($parsable); $i++) {

        my $definition = 0;

        my $character = substr($parsable, $i, 1);

        if($character eq "/" && substr($parsable, $i+1, 1) eq "*") { #I parse like this for greedy reasons

            for($i+=2; $i < length($parsable); $i++) {

                my $end = substr($parsable, $i, 2);

                if($end eq "*/") {

                    $last_definition = $i+2;

                    $i++;

                    last;

                }

            }

        } elsif($character eq "{") {

            my $brace_depth = 1;

            my $block_start = $i + 1;

          BLOCK: for($i+=1; $i < length($parsable); $i++) {

              my $ignore = substr($parsable, $i, 1);

              if($ignore eq "{") {

                  $brace_depth++;

              } elsif($ignore eq "}") {

                  $brace_depth--;

                  unless($brace_depth) {

                      for(my $i2 = $i+1; $i2 < length($parsable); $i2++) {

                          my $end = substr($parsable, $i2, 1);

                          if($end eq ";" || $end ne " ") {

                              $definition = substr($parsable, $last_definition, $block_start - $last_definition) . "}";

                              $i = $i2 if($end eq ";");

                              $last_definition = $i + 1;

                              last BLOCK;

			  }

                      }

                  }

              }

          }

        } elsif($character eq ";") {

            $definition = substr($parsable, $last_definition, $i - $last_definition + 1);

            $last_definition = $i + 1;

	} elsif($character eq "}") {

	    # a naked } must be a namespace ending

	    # if it's not a namespace, it's eaten by the loop above

	    pop @namespaces;

	    $last_definition = $i + 1;

	}

	if (substr($parsable, $last_definition, $i - $last_definition + 1) =~ m/ namespace ([^ ]*) /

	    && substr($parsable, $i+1, 1) eq "{") {

	    push @namespaces, $1;

	    # Eat the opening { so that the condensing loop above doesn't see it

	    $i++;

	    $last_definition = $i + 1;

	}

        if($definition) {

	    $definition =~ s=[\n\r]==g;

            my @symbols;

            if($definition =~ m/^ *typedef *.*\(\*([^\)]*)\)\(.*\);$/) {

		push @symbols, $1;

            } elsif($definition =~ m/^ *typedef +(.*) +([^ ]*);$/) {

		push @symbols, $2;

            } elsif($definition =~ m/^ *(template *<.*> *)?(class|struct) +([^ ]* +)?([^<\s]+) ?(<[^>]*> ?)?\s*((,|:)\s*(public|protected|private) *.*)? *\{\}$/) {

		push @symbols, $4;

            } elsif($definition =~ m/^ *Q_DECLARE_.*ITERATOR\((.*)\);$/) {

		push @symbols, "Q" . $1 . "Iterator";

		push @symbols, "QMutable" . $1 . "Iterator";

	    }

	    foreach (@symbols) {

		my $symbol = $_;

		$symbol = (join("::", @namespaces) . "::" . $symbol) if (scalar @namespaces);

		push @ret, $symbol

		    if ($symbol =~ /^Q[^:]*$/		# no-namespace, starting with Q

			|| $symbol =~ /^Phonon::/);	# or in the Phonon namespace

            }

        }

    }

    return @ret;

}

######################################################################

# Syntax:  syncHeader(header, iheader, copy)

# Params:  header, string, filename to create "symlink" for

#          iheader, string, destination name of symlink

#          copy, forces header to be a copy of iheader

#

# Purpose: Syncronizes header to iheader

# Returns: 1 if successful, else 0.

######################################################################

sub syncHeader {

    my ($header, $iheader, $copy) = @_;

    $iheader =~ s=\\=/=g;

    $header =~ s=\\=/=g;

    return copyFile($iheader, $header) if($copy);

    unless(-e "$header") {

        my $header_dir = dirname($header);

        mkpath $header_dir, 0777;

        #write it

        my $iheader_out = fixPaths($iheader, $header_dir);

        open HEADER, ">$header" || die "Could not open $header for writing!\n";

        print HEADER "#include \"$iheader_out\"\n";

        close HEADER;

        return 1;

    }

    return 0;

}

######################################################################

# Syntax:  fixPaths(file, dir)

# Params:  file, string, filepath to be made relative to dir

#          dir, string, dirpath for point of origin

#

# Purpose: file is made relative (if possible) of dir.

# Returns: String with the above applied conversion.

######################################################################

sub fixPaths {

    my ($file, $dir) = @_;

    $dir =~ s=^$basedir/=$out_basedir/= if(!($basedir eq $out_basedir));

    $file =~ s=\\=/=g;

    $file =~ s/\+/\\+/g;

    $dir =~ s=\\=/=g;

    $dir =~ s/\+/\\+/g;

    #setup

    my $ret = $file;

    my $file_dir = dirname($file);

    if($file_dir eq ".") {

        $file_dir = getcwd();

        $file_dir =~ s=\\=/=g;

    }

    $file_dir =~ s,/cygdrive/([a-zA-Z])/,$1:,g;

    if($dir eq ".") {

        $dir = getcwd();

        $dir =~ s=\\=/=g;

    }

    $dir =~ s,/cygdrive/([a-zA-Z])/,$1:/,g;

    return basename($file) if("$file_dir" eq "$dir");

    #guts

    my $match_dir = 0;

    for(my $i = 1; $i < length($file_dir); $i++) {

        my $slash = index($file_dir, "/", $i);

        last if($slash == -1);

        my $tmp = substr($file_dir, 0, $slash);

        last unless($dir =~ m,^$tmp/,);

        $match_dir = $tmp;

        $i = $slash;

    }

    if($match_dir) {

        my $after = substr($dir, length($match_dir));

        my $count = ($after =~ tr,/,,);

        my $dots = "";

        for(my $i = 0; $i < $count; $i++) {

            $dots .= "../";

        }

        $ret =~ s,^$match_dir,$dots,;

    }

    $ret =~ s,/+,/,g;

    return $ret;

}

######################################################################

# Syntax:  fileContents(filename)

# Params:  filename, string, filename of file to return contents

#

# Purpose: Get the contents of a file.

# Returns: String with contents of the file, or empty string if file

#          doens't exist.

# Warning: Dies if it does exist but script cannot get read access.

######################################################################

sub fileContents {

    my ($filename) = @_;

    my $filecontents = "";

    if (-e $filename) {

        open(I, "< $filename") || die "Could not open $filename for reading, read block?";

        local $/;

        binmode I;

        $filecontents = <I>;

        close I;

    }

    return $filecontents;

}

######################################################################

# Syntax:  fileCompare(file1, file2)

# Params:  file1, string, filename of first file

#          file2, string, filename of second file

#

# Purpose: Determines if files are equal, and which one is newer.

# Returns: 0 if files are equal no matter the timestamp, -1 if file1

#          is newer, 1 if file2 is newer.

######################################################################

sub fileCompare {

    my ($file1, $file2) = @_;

    my $file1contents = fileContents($file1);

    my $file2contents = fileContents($file2);

    if (! -e $file1) { return 1; }

    if (! -e $file2) { return -1; }

    return $file1contents ne $file2contents ? (stat("$file2"))[9] <=> (stat("$file1"))[9] : 0;

}

######################################################################

# Syntax:  copyFile(file, ifile)

# Params:  file, string, filename to create duplicate for

#          ifile, string, destination name of duplicate

#

# Purpose: Keeps files in sync so changes in the newer file will be

#          written to the other.

# Returns: 1 if files were synced, else 0.

# Warning: Dies if script cannot get write access.

######################################################################

sub copyFile

{

    my ($file,$ifile, $copy,$knowdiff,$filecontents,$ifilecontents) = @_;

    # Bi-directional synchronization

    open( I, "< " . $file ) || die "Could not open $file for reading";

    local $/;

    binmode I;

    $filecontents = <I>;

    close I;

    if ( open(I, "< " . $ifile) ) {

	local $/;

	binmode I;

	$ifilecontents = <I>;

	close I;

	$copy = fileCompare($file, $ifile);

	$knowdiff = 0,

    } else {

	$copy = -1;

	$knowdiff = 1;

    }

    if ( $knowdiff || ($filecontents ne $ifilecontents) ) {

	if ( $copy > 0 ) {

	    my $file_dir = dirname($file);

	    mkpath $file_dir, 0777 unless(-e "$file_dir");

	    open(O, "> " . $file) || die "Could not open $file for writing (no write permission?)";

	    local $/;

	    binmode O;

	    print O $ifilecontents;

	    close O;

	    return 1;

	} elsif ( $copy < 0 ) {

	    my $ifile_dir = dirname($ifile);

	    mkpath $ifile_dir, 0777 unless(-e "$ifile_dir");

	    open(O, "> " . $ifile) || die "Could not open $ifile for writing (no write permission?)";

	    local $/;

	    binmode O;

	    print O $filecontents;

	    close O;

	    return 1;

	}

    }

    return 0;

}

######################################################################

# Syntax:  symlinkFile(file, ifile)

# Params:  file, string, filename to create "symlink" for

#          ifile, string, destination name of symlink

#

# Purpose: File is symlinked to ifile (or copied if filesystem doesn't

#          support symlink).

# Returns: 1 on success, else 0.

######################################################################

sub symlinkFile

{

    my ($file,$ifile) = @_;

    if ($isunix) {

        print "symlink created for $file ";

        if ( $force_relative && ($ifile =~ /^$basedir/)) {

            my $t = getcwd();

            my $c = -1;

            my $p = "../";

            $t =~ s-^$basedir/--;

            $p .= "../" while( ($c = index( $t, "/", $c + 1)) != -1 );

            $file =~ s-^$basedir/-$p-;

            print " ($file)\n";

        }

        print "\n";

        return symlink($file, $ifile);

    }

    return copyFile($file, $ifile);

}

######################################################################

# Syntax:  findFiles(dir, match, descend)

# Params:  dir, string, directory to search for name

#          match, string, regular expression to match in dir

#          descend, integer, 0 = non-recursive search

#                            1 = recurse search into subdirectories

#

# Purpose: Finds files matching a regular expression.

# Returns: List of matching files.

#

# Examples:

#   findFiles("/usr","\.cpp$",1)  - finds .cpp files in /usr and below

#   findFiles("/tmp","^#",0)      - finds #* files in /tmp

######################################################################

sub findFiles {

    my ($dir,$match,$descend) = @_;

    my ($file,$p,@files);

    local(*D);

    $dir =~ s=\\=/=g;

    ($dir eq "") && ($dir = ".");

    if ( opendir(D,$dir) ) {

        if ( $dir eq "." ) {

            $dir = "";