]> git.donarmstrong.com Git - debhelper.git/blobdiff - Debian/Debhelper/Dh_Getopt.pm
clean up --sourcedir/--sourcedirectory conflict
[debhelper.git] / Debian / Debhelper / Dh_Getopt.pm
index 38aa342447c110d5cac695d620e946071ea4f703..9868124cbf996ed82c88b9c9207af94ecbb803ab 100644 (file)
@@ -9,17 +9,13 @@ use strict;
 
 use Debian::Debhelper::Dh_Lib;
 use Getopt::Long;
-use Exporter;
-#use vars qw{@ISA @EXPORT};
-#@ISA=qw(Exporter);
-#@EXPORT=qw(&aparseopts); # FIXME: for some reason, this doesn't work.
 
-my (%options, %exclude_package);
+my %exclude_package;
 
 sub showhelp {
        my $prog=basename($0);
        print "Usage: $prog [options]\n\n";
-       print "  $prog is a part of debhelper. See debhelper(1)\n";
+       print "  $prog is a part of debhelper. See debhelper(7)\n";
        print "  and $prog(1) for complete usage instructions.\n"; 
        exit(1);
 }
@@ -29,25 +25,30 @@ sub showhelp {
 # order.
 sub AddPackage { my($option,$value)=@_;
        if ($option eq 'i' or $option eq 'indep') {
-               push @{$options{DOPACKAGES}}, GetPackages('indep');
-               $options{DOINDEP}=1;
+               push @{$dh{DOPACKAGES}}, getpackages('indep');
+               $dh{DOINDEP}=1;
        }
        elsif ($option eq 'a' or $option eq 'arch') {
-               push @{$options{DOPACKAGES}}, GetPackages('arch');
-               $options{DOARCH}=1;
+               push @{$dh{DOPACKAGES}}, getpackages('arch');
+               $dh{DOARCH}=1;
        }
        elsif ($option eq 'p' or $option eq 'package') {
-               push @{$options{DOPACKAGES}}, $value;
+               push @{$dh{DOPACKAGES}}, $value;
        }
        elsif ($option eq 's' or $option eq 'same-arch') {
-               push @{$options{DOPACKAGES}}, GetPackages('same');
-               $options{DOSAME}=1;
+               push @{$dh{DOPACKAGES}}, getpackages('same');
+               $dh{DOSAME}=1;
        }
        else {
                error("bad option $option - should never happen!\n");
        }
 }
 
+# Adds packages to the list of debug packages.
+sub AddDebugPackage { my($option,$value)=@_;
+       push @{$dh{DEBUGPACKAGES}}, $value;
+}
+
 # Add a package to a list of packages that should not be acted on.
 sub ExcludePackage { my($option,$value)=@_;
        $exclude_package{$value}=1;
@@ -55,21 +56,28 @@ sub ExcludePackage { my($option,$value)=@_;
 
 # Add another item to the exclude list.
 sub AddExclude { my($option,$value)=@_;
-       push @{$options{EXCLUDE}},$value;
+       push @{$dh{EXCLUDE}},$value;
+}
+
+# Add a file to the ignore list.
+sub AddIgnore { my($option,$file)=@_;
+       $dh{IGNORE}->{$file}=1;
 }
 
 # This collects non-options values.
 sub NonOption {
-       push @{$options{ARGV}}, @_;
+       push @{$dh{ARGV}}, @_;
 }
 
-# Parse options and return a hash of the values.
-sub parseopts {
-       undef %options;
-       
-       my $ret=GetOptions(
-               "v" => \$options{VERBOSE},
-               "verbose" => \$options{VERBOSE},
+sub getoptions {
+       my $array=shift;
+       my %options=%{shift()} if ref $_[0];
+
+       Getopt::Long::GetOptionsFromArray($array,
+               "v" => \$dh{VERBOSE},
+               "verbose" => \$dh{VERBOSE},
+
+               "no-act" => \$dh{NO_ACT},
        
                "i" => \&AddPackage,
                "indep" => \&AddPackage,
@@ -79,129 +87,171 @@ sub parseopts {
        
                "p=s" => \&AddPackage,
                "package=s" => \&AddPackage,
+               
+               "N=s" => \&ExcludePackage,
+               "no-package=s" => \&ExcludePackage,
+       
+               "remaining-packages" => \$dh{EXCLUDE_LOGGED},
        
+               "dbg-package=s" => \&AddDebugPackage,
+               
                "s" => \&AddPackage,
                "same-arch" => \&AddPackage,
        
-               "N=s" => \&ExcludePackage,
-               "no-package=s" => \&ExcludePackage,
-       
-               "n" => \$options{NOSCRIPTS},
-               "noscripts" => \$options{NOSCRIPTS},
+               "n" => \$dh{NOSCRIPTS},
+               "noscripts" => \$dh{NOSCRIPTS},
+               "o" => \$dh{ONLYSCRIPTS},
+               "onlyscripts" => \$dh{ONLYSCRIPTS},
 
-               "x" => \$options{INCLUDE_CONFFILES}, # is -x for some unknown historical reason..
-               "include-conffiles" => \$options{INCLUDE_CONFFILES},
-       
                "X=s" => \&AddExclude,
                "exclude=s" => \&AddExclude,
+               
+               "d" => \$dh{D_FLAG},
        
-               "d" => \$options{D_FLAG},
-               "remove-d" => \$options{D_FLAG},
-               "dirs-only" => \$options{D_FLAG},
-       
-               "r" => \$options{R_FLAG},
-               "no-restart-on-upgrade" => \$options{R_FLAG},
-       
-               "k" => \$options{K_FLAG},
-               "keep" => \$options{K_FLAG},
+               "k" => \$dh{K_FLAG},
+               "keep" => \$dh{K_FLAG},
 
-               "P=s" => \$options{TMPDIR},
-               "tmpdir=s" => \$options{TMPDIR},
+               "P=s" => \$dh{TMPDIR},
+               "tmpdir=s" => \$dh{TMPDIR},
 
-               "u=s", => \$options{U_PARAMS},
-               "update-rcd-params=s", => \$options{U_PARAMS},
-               "dpkg-shlibdeps-params=s", => \$options{U_PARAMS},
-               "dpkg-gencontrol-params=s", => \$options{U_PARAMS},
+               "u=s", => \$dh{U_PARAMS},
 
-               "l=s", => \$options{L_PARAMS},
+               "V:s", => \$dh{V_FLAG},
 
-               "m=s", => \$options{M_PARAMS},
-               "major=s" => \$options{M_PARAMS},
+               "A" => \$dh{PARAMS_ALL},
+               "all" => \$dh{PARAMS_ALL},
+       
+               "priority=s" => \$dh{PRIORITY},
+               
+               "h|help" => \&showhelp,
 
-               "V:s", => \$options{V_FLAG},
-               "version-info:s" => \$options{V_FLAG},
+               "mainpackage=s" => \$dh{MAINPACKAGE},
 
-               "A" => \$options{PARAMS_ALL},
-               "all" => \$options{PARAMS_ALL},
+               "name=s" => \$dh{NAME},
 
-               "no-act" => \$options{NO_ACT},
-       
-               "init-script=s" => \$options{INIT_SCRIPT},
+               "error-handler=s" => \$dh{ERROR_HANDLER},
                
-               "sourcedir=s" => \$options{SOURCEDIR},
-               
-               "destdir=s" => \$options{DESTDIR},
+               "ignore=s" => \&AddIgnore,
 
-               "filename=s" => \$options{FILENAME},
-               
-               "priority=i" => \$options{PRIORITY},
-               
-               "flavor=s" => \$options{FLAVOR},
+               %options,
 
-               "autodest" => \$options{AUTODEST},
+               "<>" => \&NonOption,
+       )
+}
 
-               "h|help" => \&showhelp,
+sub split_options_string {
+       my $str=shift;
+       $str=~s/^\s+//;
+       return split(/\s+/,$str);
+}
 
-               "mainpackage=s" => \$options{MAINPACKAGE},
+# Parse options and set %dh values.
+sub parseopts {
+       my $options=shift;
+       
+       my @ARGV_extra;
 
-               "list-missing" => \$options{LIST_MISSING},
-               
-               "L|libpackage=s" => \$options{LIBPACKAGE},
-               
-               "<>" => \&NonOption,
-       );
+       # DH_INTERNAL_OPTIONS is used to pass additional options from
+       # dh through an override target to a command.
+       if (defined $ENV{DH_INTERNAL_OPTIONS}) {
+               @ARGV_extra=split_options_string($ENV{DH_INTERNAL_OPTIONS});
+               # Unknown options will be silently ignored.
+               my $oldwarn=$SIG{__WARN__};
+               $SIG{__WARN__}=sub {};
+               getoptions(\@ARGV_extra, $options);
+               $SIG{__WARN__}=$oldwarn;
 
-       if (!$ret) {
-               error("unknown option; aborting");
+               # Avoid forcing acting on packages specified in
+               # DH_INTERNAL_OPTIONS. This way, -p can be specified
+               # at the command line to act on a specific package, and if
+               # nothing is specified, the excludes will cause the set of
+               # packages DH_INTERNAL_OPTIONS specifies to be acted on.
+               if (defined $dh{DOPACKAGES}) {
+                       foreach my $package (getpackages()) {
+                               if (! grep { $_ eq $package } @{$dh{DOPACKAGES}}) {
+                                       $exclude_package{$package}=1;
+                               }
+                       }
+               }
+               delete $dh{DOPACKAGES};
+               delete $dh{DOINDEP};
+               delete $dh{DOARCH};
+               delete $dh{DOSAME};
        }
        
+       # DH_OPTIONS can contain additional options
+       # to be parsed like @ARGV, but with unknown options
+       # skipped.
+       if (defined $ENV{DH_OPTIONS}) {
+               @ARGV_extra=split_options_string($ENV{DH_OPTIONS});
+               my $ret=getoptions(\@ARGV_extra, $options);
+               if (!$ret) {
+                       warning("warning: ignored unknown options in DH_OPTIONS");
+               }
+       }
+
+       my $ret=getoptions(\@ARGV, $options);
+       if (!$ret) {
+               warning("warning: unknown options will be a fatal error in a future debhelper release");
+               #error("unknown option; aborting");
+       }
+
        # Check to see if -V was specified. If so, but no parameters were
        # passed, the variable will be defined but empty.
-       if (defined($options{V_FLAG})) {
-               $options{V_FLAG_SET}=1;
+       if (defined($dh{V_FLAG})) {
+               $dh{V_FLAG_SET}=1;
        }
        
        # If we have not been given any packages to act on, assume they
        # want us to act on them all. Note we have to do this before excluding
        # packages out, below.
-       if (! defined $options{DOPACKAGES} || ! @{$options{DOPACKAGES}}) {
-               if ($options{DOINDEP} || $options{DOARCH} || $options{DOSAME}) {
+       if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
+               if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
                        # User specified that all arch (in)dep package be
                        # built, and there are none of that type.
-                       error("I have no package to build");
+                       warning("You asked that all arch in(dep) packages be built, but there are none of that type.");
+                       exit(0);
                }
-               push @{$options{DOPACKAGES}},GetPackages();
+               push @{$dh{DOPACKAGES}},getpackages();
        }
-       
+
        # Remove excluded packages from the list of packages to act on.
+       # Also unique the list, in case some options were specified that
+       # added a package to it twice.
        my @package_list;
        my $package;
-       foreach $package (@{$options{DOPACKAGES}}) {
+       my %packages_seen;
+       foreach $package (@{$dh{DOPACKAGES}}) {
+               if (defined($dh{EXCLUDE_LOGGED}) &&
+                   grep { $_ eq basename($0) } load_log($package)) {
+                       $exclude_package{$package}=1;
+               }
                if (! $exclude_package{$package}) {
-                       push @package_list, $package;   
+                       if (! exists $packages_seen{$package}) {
+                               $packages_seen{$package}=1;
+                               push @package_list, $package;   
+                       }
                }
        }
-       @{$options{DOPACKAGES}}=@package_list;
+       @{$dh{DOPACKAGES}}=@package_list;
 
-       # If there are no packages to act on now, it's an error.
-       if (! defined $options{DOPACKAGES} || ! @{$options{DOPACKAGES}}) {
-               error("I have no package to build");
+       if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
+               warning("No packages to build.");
+               exit(0);
        }
 
-       if (defined $options{U_PARAMS}) {
+       if (defined $dh{U_PARAMS}) {
                # Split the U_PARAMS up into an array.
-               my $u=$options{U_PARAMS};
-               undef $options{U_PARAMS};
-                push @{$options{U_PARAMS}}, split(/\s+/,$u);
+               my $u=$dh{U_PARAMS};
+               undef $dh{U_PARAMS};
+                push @{$dh{U_PARAMS}}, split(/\s+/,$u);
         }
 
        # Anything left in @ARGV is options that appeared after a --
        # These options are added to the U_PARAMS array, while the
        # non-option values we collected replace them in @ARGV;
-       push @{$options{U_PARAMS}}, @ARGV;
-       @ARGV=@{$options{ARGV}} if exists $options{ARGV};
-
-       return %options;
+       push @{$dh{U_PARAMS}}, @ARGV, @ARGV_extra;
+       @ARGV=@{$dh{ARGV}} if exists $dh{ARGV};
 }
 
 sub import {