]> git.donarmstrong.com Git - debhelper.git/blobdiff - Debian/Debhelper/Dh_Getopt.pm
Allow individual debhelper programs to define their own special options by passing...
[debhelper.git] / Debian / Debhelper / Dh_Getopt.pm
index 191227da2e2f4d9a752a515039d837993fbd687e..a676eaaa30612b73fe4c622a3ceccc4f58c56358 100644 (file)
@@ -2,44 +2,53 @@
 #
 # Debhelper option processing library.
 #
-# Joey Hess GPL copyright 1998.
+# Joey Hess GPL copyright 1998-2002
 
 package Debian::Debhelper::Dh_Getopt;
 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(7)\n";
+       print "  and $prog(1) for complete usage instructions.\n"; 
+       exit(1);
+}
 
 # Passed an option name and an option value, adds packages to the list
 # of packages. We need this so the list will be built up in the right
 # 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;
@@ -47,21 +56,31 @@ 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;
+}
+
+# Add an item to the with list.
+sub AddWith { my($option,$value)=@_;
+       push @{$dh{WITH}},$value;
 }
 
 # This collects non-options values.
 sub NonOption {
-       push @{$options{ARGV}}, @_;
+       push @{$dh{ARGV}}, @_;
 }
 
-# Parse options and return a hash of the values.
+# Parse options and set %dh values.
 sub parseopts {
-       undef %options;
-       
+       my %options=%{shift()} if ref $_[0];
+
        my $ret=GetOptions(
-               "v" => \$options{VERBOSE},
-               "verbose" => \$options{VERBOSE},
+               "v" => \$dh{VERBOSE},
+               "verbose" => \$dh{VERBOSE},
        
                "i" => \&AddPackage,
                "indep" => \&AddPackage,
@@ -72,64 +91,101 @@ sub parseopts {
                "p=s" => \&AddPackage,
                "package=s" => \&AddPackage,
        
+               "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" => \$dh{INCLUDE_CONFFILES}, # is -x for some unknown historical reason..
+               "include-conffiles" => \$dh{INCLUDE_CONFFILES},
        
                "X=s" => \&AddExclude,
                "exclude=s" => \&AddExclude,
+               
+               "ignore=s" => \&AddIgnore,
        
-               "d" => \$options{D_FLAG},
-               "remove-d" => \$options{D_FLAG},
-               "dirs-only" => \$options{D_FLAG},
+               "d" => \$dh{D_FLAG},
+               "remove-d" => \$dh{D_FLAG},
+               "dirs-only" => \$dh{D_FLAG},
        
-               "r" => \$options{R_FLAG},
-               "no-restart-on-upgrade" => \$options{R_FLAG},
+               "r" => \$dh{R_FLAG},
+               "no-restart-on-upgrade" => \$dh{R_FLAG},
+               "no-start" => \$dh{NO_START},
+               "R|restart-after-upgrade" => \$dh{RESTART_AFTER_UPGRADE},
        
-               "k" => \$options{K_FLAG},
-               "keep" => \$options{K_FLAG},
+               "k" => \$dh{K_FLAG},
+               "keep" => \$dh{K_FLAG},
+               "keep-debug" => \$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},
+               "update-rcd-params=s", => \$dh{U_PARAMS},
+               "dpkg-shlibdeps-params=s", => \$dh{U_PARAMS},
+               "dpkg-gencontrol-params=s", => \$dh{U_PARAMS},
 
-               "l=s", => \$options{L_PARAMS},
+               "l=s", => \$dh{L_PARAMS},
 
-               "m=s", => \$options{M_PARAMS},
-               "major=s" => \$options{M_PARAMS},
+               "m=s", => \$dh{M_PARAMS},
+               "major=s" => \$dh{M_PARAMS},
 
-               "V:s", => \$options{V_FLAG},
-               "version-info:s" => \$options{V_FLAG},
+               "V:s", => \$dh{V_FLAG},
+               "version-info:s" => \$dh{V_FLAG},
 
-               "A" => \$options{PARAMS_ALL},
-               "all" => \$options{PARAMS_ALL},
+               "A" => \$dh{PARAMS_ALL},
+               "all" => \$dh{PARAMS_ALL},
 
-               "no-act" => \$options{NO_ACT},
+               "no-act" => \$dh{NO_ACT},
        
-               "init-script=s" => \$options{INIT_SCRIPT},
+               "init-script=s" => \$dh{INIT_SCRIPT},
+               
+               "sourcedir=s" => \$dh{SOURCEDIR},
+               
+               "destdir=s" => \$dh{DESTDIR},
+
+               "filename=s" => \$dh{FILENAME},
                
-               "sourcedir=s" => \$options{SOURCEDIR},
+               "priority=s" => \$dh{PRIORITY},
                
-               "destdir=s" => \$options{DESTDIR},
+               "flavor=s" => \$dh{FLAVOR},
 
-               "filename=s" => \$options{FILENAME},
+               "autodest" => \$dh{AUTODEST},
+
+               "h|help" => \&showhelp,
+
+               "mainpackage=s" => \$dh{MAINPACKAGE},
+
+               "list-missing" => \$dh{LIST_MISSING},
+
+               "fail-missing" => \$dh{FAIL_MISSING},
                
-               "priority=i" => \$options{PRIORITY},
+               "L|libpackage=s" => \$dh{LIBPACKAGE},
                
-               "flavor=s" => \$options{FLAVOR},
+               "name=s" => \$dh{NAME},
                
+               "error-handler=s" => \$dh{ERROR_HANDLER},
+               
+               "add-udeb=s" => \$dh{SHLIBS_UDEB},
+               
+               "language=s" => \$dh{LANGUAGE},
+
+               "until=s" => \$dh{UNTIL},
+               "after=s" => \$dh{AFTER},
+               "before=s" => \$dh{BEFORE},
+               "remaining" => \$dh{REMAINING},
+               "with=s" => \&AddWith,
+
+               %options,
+
                "<>" => \&NonOption,
        );
 
@@ -139,59 +195,57 @@ sub parseopts {
        
        # 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("I have no package to build");
+                       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 (! $exclude_package{$package}) {
-                       push @package_list, $package;   
+                       if (! exists $packages_seen{$package}) {
+                               $packages_seen{$package}=1;
+                               push @package_list, $package;   
+                       }
                }
        }
-       @{$options{DOPACKAGES}}=@package_list;
-
-       # Generate EXCLUDE_FIND.
-       $options{EXCLUDE_FIND}='';
-       foreach (@{$options{EXCLUDE}}) {
-               $options{EXCLUDE_FIND}.="-regex .*".quotemeta($_).".* -or ";
-       }
-       $options{EXCLUDE_FIND}=~s/ -or $//;
+       @{$dh{DOPACKAGES}}=@package_list;
 
        # If there are no packages to act on now, it's an error.
-       if (! defined $options{DOPACKAGES} || ! @{$options{DOPACKAGES}}) {
+       if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
                error("I have no package to build");
        }
 
-       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=@{$dh{ARGV}} if exists $dh{ARGV};
+}
 
 sub import {
        # Enable bundling of short command line options.