More warining fixes: char -> const char
[obnox/wireshark/wip.git] / make-version.pl
index ecaf52aa4a473a8bcd15480abc0aa2b18faca405..16170680a9227b536efa579d6058f58c966065d4 100755 (executable)
@@ -2,7 +2,7 @@
 #
 # Copyright 2004 Jörg Mayer (see AUTHORS file)
 #
-# $Id: make-version.pl,v 1.3 2004/01/18 01:41:13 obiot Exp $
+# $Id$
 #
 # Ethereal - Network traffic analyzer
 # By Gerald Combs <gerald@ethereal.com>
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-# usage:  ./make-version.pl
+# usage:  ./make-version.pl [-p] [--package-version]
+#
+# If "version.conf" is present, it is parsed for configuration values.  
+# Possible values are:
+#
+#   enable     - Enable or disable versioning.  Zero (0) disables, nonzero
+#                enables.
+#   format     - A strftime() formatted string to use as a template for
+#                the version string.  The sequence "%#" will substitute
+#                the SVN revision number.
+#   pkg_format - Like "format", but used for the package version.
+#
+# If run with the "-p" or "--package-version" argument, the
+# AM_INIT_AUTOMAKE macro in configure.in and the VERSION macro in
+# config.nmake will have the pkg_format template appended to the 
+# version number.  svnversion.h will _not_ be generated if either
+# argument is present.
+#
+# Default configuration:
+#
+# enable: 1
+# format: SVN %Y%m%d%H%M%S
+# pkg_format: -SVN-%#
+# am_init: 0
 
-use strict;
+# XXX - We're pretty dumb about the "%#" substitution, and about having
+# spaces in the package format.
 
-my ($d1,$d2,$d3,$date,$drest);
-my ($wdayascii, $monthascii, $day, $time, $year);
+use strict;
 
-my %asctonum = ( "Jan" => "01", "Feb" => "02", "Mar" => "03", "Apr" => "04",
-               "May" => "05", "Jun" => "06", "Jul" => "07", "Aug" => "08",
-               "Sep" => "09", "Oct" => "10", "Nov" => "11", "Dec" => "12" );
+use Time::Local;
+use POSIX qw(strftime);
+use Getopt::Long;
+
+my $version_file = 'svnversion.h';
+my $version_string = "";
+my $package_string = "";
+my $vconf_file = 'version.conf';
+my $last = 0;
+my $revision = 0;
+my $pkg_version = 0;
+my %version_pref = (
+       "enable"     => 1,
+       "format"     => "SVN %Y%m%d%H%M%S",
+       "pkg_format" => "-SVN-%#",
+       );
+my $srcdir = ".";
+
+
+# Run "svn info".  Parse out the most recent modification time and the
+# revision number.
+sub read_svn_info {
+       my $line;
+       my $version_format = $version_pref{"format"};
+       my $package_format = $version_pref{"pkg_format"};
+       my $in_entries = 0;
+       my $svn_name;
+
+       if (! open (ENTRIES, "< $srcdir/.svn/entries")) {
+               print ("Unable to get SVN info.\n");
+               return;
+       }
 
-my $current;
-my $last = "";
+       # The entries schema is flat, so we can use regexes to parse its contents.
+       while ($line = <ENTRIES>) {
+               if ($line =~ /<entry$/ || $line =~ /<entry\s/) {
+                       $in_entries = 1;
+                       $svn_name = "";
+               }
+               if ($in_entries) {
+                       if ($line =~ /name="(.*)"/) { $svn_name = $1; }
+                       if ($line =~ /committed-date="(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)/) {
+                               $last = timegm($6, $5, $4, $3, $2 - 1, $1);
+                       }
+                       if ($line =~ /revision="(\d+)"/) { $revision = $1; }
+               }
+               if ($line =~ /\/>/) {
+                       if (($svn_name eq "" || $svn_name eq "svn:this_dir") &&
+                                       $last && $revision) {
+                               $in_entries = 0;
+                               $version_format =~ s/%#/$revision/;
+                               $version_string = strftime($version_format, gmtime($last));
+
+                               $package_format =~ s/%#/$revision/;
+                               $package_string = strftime($package_format, gmtime($last));
+
+                               last;
+                       }
+               }
+       }
+       close ENTRIES;
+}
 
 
-sub findentries {
-       my $currentdir = shift;
+# Read configure.in, then write it back out with an updated 
+# "AM_INIT_AUTOMAKE" line.
+sub update_configure_in
+{
+       my $line;
+       my $contents = "";
+       my $version = "";
+       
+       return if ($package_string eq "");
+       
+       open(CFGIN, "< configure.in") || die "Can't read configure.in!";
+       while ($line = <CFGIN>) {
+               if ($line =~ /^AM_INIT_AUTOMAKE\(ethereal, (\d+)\.(\d+).(\d+)/) {
+                       $line = "AM_INIT_AUTOMAKE\(ethereal, $1.$2.$3$package_string)\n";
+               }
+               $contents .= $line
+       }
+       
+       open(CFGIN, "> configure.in") || die "Can't write configure.in!";
+       print(CFGIN $contents);
+       close(CFGIN);
+       print "configure.in has been updated.\n";
+}
 
-       opendir(DIR, "$currentdir") || print STDERR "Opendir $currentdir failed ($!)\n" && next;
-       grep { (-d "$currentdir/$_" && $_ !~ /^\.(|.)$/ && &findentries("$currentdir/$_")) ||
-              (-f "$currentdir/$_" && $_ =~ /^Entries$/ && &lastentry("$currentdir/$_")) } readdir(DIR);
-       closedir DIR;
+# Read config.nmake, then write it back out with an updated 
+# "VERSION" line.
+sub update_config_nmake
+{
+       my $line;
+       my $contents = "";
+       my $version = "";
+       
+       return if ($package_string eq "");
+       
+       open(CFGIN, "< config.nmake") || die "Can't read config.nmake!";
+       while ($line = <CFGIN>) {
+               if ($line =~ /^VERSION=(\d+)\.(\d+).(\d+)/) {
+                       $line = "VERSION=$1.$2.$3$package_string\n";
+               }
+               $contents .= $line
+       }
+       
+       open(CFGIN, "> config.nmake") || die "Can't write config.nmake!";
+       print(CFGIN $contents);
+       close(CFGIN);
+       print "config.nmake has been updated.\n";
 }
 
-sub lastentry {
-       my $file = shift;
 
-       open(FILE, "<$file") || print STDERR "Open $file for reading failed ($!)\n" && return 1;
-       while (<FILE>) {
-               chomp;
-               # Regular lines look like this: /ethereal_be.py/1.6/Fri Aug  2 22:55:19 2002//
-               next if (/^D/);
-               ($d1,$d2,$d2,$date,$drest) = split(/\//, $_, 5);
-               next if ($date !~ /\d:\d\d:\d\d/);
-               ($wdayascii, $monthascii, $day, $time, $year) = split(/\s+/, $date);
-               $day = substr("0".$day, -2, 2);
-               $time =~ s/://g;
-               $current = "$year$asctonum{$monthascii}$day$time";
-               if ($current gt $last) {
-                       $last = $current;
+
+# Print the SVN version to $version_file.
+# Don't change the file if it is not needed.
+sub print_svn_version
+{
+       my $svn_version;
+       my $needs_update = 1;
+
+       if ($pkg_version) { return; }
+
+       if ($last && $revision) {
+               $svn_version = "#define SVNVERSION \"" . 
+                       $version_string . "\"\n";
+       } else {
+               $svn_version = "/* #define SVNVERSION \"\" */\n";
+       }
+       if (open(OLDVER, "<$version_file")) {
+               if (<OLDVER> eq $svn_version) {
+                       print "$version_file is up-to-date.\n";
+                       $needs_update = 0;
                }
+               close OLDVER;
+       }
+
+       if ($needs_update == 1) {
+               # print "Updating $version_file so it contains:\n$svn_version";
+               open(VER, ">$version_file") || die ("Cannot write to $version_file ($!)\n");
+               print VER "$svn_version";
+               close VER;
+               print "$version_file has been updated.\n";
        }
-       close FILE;
-       return 1;
 }
 
-&findentries(".");
+# Read values from the configuration file, if it exists.
+sub get_config {
+       my $arg;
 
-if ($last eq "" && -f "cvsversion") {
-       $last = `cat cvsversion`;
-}
-if ( $last ne "" ) {
-       $last = "#define CVSVERSION \"$last\"\n";
-} else {
-       $last = "/* #define CVSVERSION \"\" */\n";
-}
+       # Get our command-line args
+       GetOptions("package-version", \$pkg_version);
 
-my $needsupdate=0;
+       if ($#ARGV >= 0) {
+               $srcdir = $ARGV[0]
+       }
 
-if (! open(OLDVER, "<cvsversion.h")) {
-       $needsupdate = 1;
-} else {
-       if (<OLDVER> ne $last) {
-               $needsupdate = 1;
+
+       if (! open(FILE, "<$vconf_file")) {
+               print STDERR "Version configuration file $vconf_file not "
+               . "found.  Using defaults.\n";
+               return 1;
        }
-       close OLDVER;
-}
 
-if ($needsupdate == 1) {
-       open(VER, ">cvsversion.h") || die ("Cannot write to cvsversion.h ($!)\n");
-       print VER "$last";
-       close VER;
+       while (<FILE>) {
+               chomp;
+               next if (/^#/);
+               next unless (/^(\w+):\s+(\S.*)/);
+               $version_pref{$1} = $2;
+       }
+       close FILE;
+       return 1;
 }
 
-__END__
+##
+## Start of code
+##
+
+&get_config();
+
+if (-d "./.svn") {
+       print "This is a build from SVN (or a SVN snapshot).\n";
+       &read_svn_info(".");
+       if ($pkg_version) {
+               print "Generating package version.  Ignoring $version_file\n";
+               &update_configure_in;
+               &update_config_nmake;
+       } elsif ($version_pref{"enable"} == 0) {
+               print "Version tag disabled in $vconf_file.\n";
+               $last = 0;
+               $revision = 0;
+       } else {
+               print "SVN version tag will be computed.\n";
+       }
+} else {
+       print "This is not a SVN build.\n";
+}
 
+&print_svn_version;
 
+__END__