3 # Debhelper option processing library.
5 # Joey Hess GPL copyright 1998-2002
7 package Debian::Debhelper::Dh_Getopt;
10 use Debian::Debhelper::Dh_Lib;
16 my $prog=basename($0);
17 print "Usage: $prog [options]\n\n";
18 print " $prog is a part of debhelper. See debhelper(7)\n";
19 print " and $prog(1) for complete usage instructions.\n";
23 # Passed an option name and an option value, adds packages to the list
24 # of packages. We need this so the list will be built up in the right
26 sub AddPackage { my($option,$value)=@_;
27 if ($option eq 'i' or $option eq 'indep') {
28 push @{$dh{DOPACKAGES}}, getpackages('indep');
31 elsif ($option eq 'a' or $option eq 'arch') {
32 push @{$dh{DOPACKAGES}}, getpackages('arch');
35 elsif ($option eq 'p' or $option eq 'package') {
36 push @{$dh{DOPACKAGES}}, $value;
38 elsif ($option eq 's' or $option eq 'same-arch') {
39 push @{$dh{DOPACKAGES}}, getpackages('same');
43 error("bad option $option - should never happen!\n");
47 # Adds packages to the list of debug packages.
48 sub AddDebugPackage { my($option,$value)=@_;
49 push @{$dh{DEBUGPACKAGES}}, $value;
52 # Add a package to a list of packages that should not be acted on.
53 sub ExcludePackage { my($option,$value)=@_;
54 $exclude_package{$value}=1;
57 # Add another item to the exclude list.
58 sub AddExclude { my($option,$value)=@_;
59 push @{$dh{EXCLUDE}},$value;
62 # Add a file to the ignore list.
63 sub AddIgnore { my($option,$file)=@_;
64 $dh{IGNORE}->{$file}=1;
67 # This collects non-options values.
69 push @{$dh{ARGV}}, @_;
74 my $extraoptions=shift;
78 "verbose" => \$dh{VERBOSE},
80 "no-act" => \$dh{NO_ACT},
83 "indep" => \&AddPackage,
86 "arch" => \&AddPackage,
88 "p=s" => \&AddPackage,
89 "package=s" => \&AddPackage,
91 "N=s" => \&ExcludePackage,
92 "no-package=s" => \&ExcludePackage,
94 "remaining-packages" => \$dh{EXCLUDE_LOGGED},
96 "dbg-package=s" => \&AddDebugPackage,
99 "same-arch" => \&AddPackage,
101 "n" => \$dh{NOSCRIPTS},
102 "noscripts" => \$dh{NOSCRIPTS},
103 "o" => \$dh{ONLYSCRIPTS},
104 "onlyscripts" => \$dh{ONLYSCRIPTS},
106 "X=s" => \&AddExclude,
107 "exclude=s" => \&AddExclude,
112 "keep" => \$dh{K_FLAG},
114 "P=s" => \$dh{TMPDIR},
115 "tmpdir=s" => \$dh{TMPDIR},
117 "u=s", => \$dh{U_PARAMS},
119 "V:s", => \$dh{V_FLAG},
121 "A" => \$dh{PARAMS_ALL},
122 "all" => \$dh{PARAMS_ALL},
124 "sourcedir=s" => \$dh{SOURCEDIR},
126 "destdir=s" => \$dh{DESTDIR},
128 "priority=s" => \$dh{PRIORITY},
130 "h|help" => \&showhelp,
132 "mainpackage=s" => \$dh{MAINPACKAGE},
134 "name=s" => \$dh{NAME},
136 "error-handler=s" => \$dh{ERROR_HANDLER},
138 "ignore=s" => \&AddIgnore,
143 # Merge extra options and cancel default ones as needed (undef)
144 if (defined $extraoptions) {
145 for my $opt (keys %$extraoptions) {
146 if (defined $extraoptions->{$opt}) {
147 $options{$opt}=$extraoptions->{$opt};
150 delete $options{$opt};
155 Getopt::Long::GetOptionsFromArray($array, %options);
158 sub split_options_string {
162 return map { $_=~s/\\(\s)/$1/g; $_=~s/\s+$//g; $_ } split(/(?<!\\)\s+/,$str);
165 # Parse options and set %dh values.
168 my $extra_args=shift;
172 # DH_INTERNAL_OPTIONS is used to pass additional options from
173 # dh through an override target to a command.
174 if (defined $ENV{DH_INTERNAL_OPTIONS}) {
175 @ARGV_extra=split_options_string($ENV{DH_INTERNAL_OPTIONS});
176 # Unknown options will be silently ignored.
177 my $oldwarn=$SIG{__WARN__};
178 $SIG{__WARN__}=sub {};
179 getoptions(\@ARGV_extra, $options);
180 $SIG{__WARN__}=$oldwarn;
182 # Avoid forcing acting on packages specified in
183 # DH_INTERNAL_OPTIONS. This way, -p can be specified
184 # at the command line to act on a specific package, and if
185 # nothing is specified, the excludes will cause the set of
186 # packages DH_INTERNAL_OPTIONS specifies to be acted on.
187 if (defined $dh{DOPACKAGES}) {
188 foreach my $package (getpackages()) {
189 if (! grep { $_ eq $package } @{$dh{DOPACKAGES}}) {
190 $exclude_package{$package}=1;
194 delete $dh{DOPACKAGES};
200 # DH_OPTIONS can contain additional options
201 # to be parsed like @ARGV, but with unknown options
203 if (defined $ENV{DH_OPTIONS}) {
204 @ARGV_extra=split_options_string($ENV{DH_OPTIONS});
205 my $ret=getoptions(\@ARGV_extra, $options);
207 warning("warning: ignored unknown options in DH_OPTIONS");
211 if (defined $extra_args) {
212 my @extra_opts=split_options_string($extra_args);
213 my $ret=getoptions(\@extra_opts, $options);
215 warning("warning: ignored unknown options");
217 push @ARGV_extra, @extra_opts;
220 my $ret=getoptions(\@ARGV, $options);
222 warning("warning: unknown options will be a fatal error in a future debhelper release");
223 #error("unknown option; aborting");
226 # Check to see if -V was specified. If so, but no parameters were
227 # passed, the variable will be defined but empty.
228 if (defined($dh{V_FLAG})) {
232 # If we have not been given any packages to act on, assume they
233 # want us to act on them all. Note we have to do this before excluding
234 # packages out, below.
235 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
236 if ($dh{DOINDEP} || $dh{DOARCH} || $dh{DOSAME}) {
237 # User specified that all arch (in)dep package be
238 # built, and there are none of that type.
239 warning("You asked that all arch in(dep) packages be built, but there are none of that type.");
242 push @{$dh{DOPACKAGES}},getpackages();
245 # Remove excluded packages from the list of packages to act on.
246 # Also unique the list, in case some options were specified that
247 # added a package to it twice.
251 foreach $package (@{$dh{DOPACKAGES}}) {
252 if (defined($dh{EXCLUDE_LOGGED}) &&
253 grep { $_ eq basename($0) } load_log($package)) {
254 $exclude_package{$package}=1;
256 if (! $exclude_package{$package}) {
257 if (! exists $packages_seen{$package}) {
258 $packages_seen{$package}=1;
259 push @package_list, $package;
263 @{$dh{DOPACKAGES}}=@package_list;
265 if (! defined $dh{DOPACKAGES} || ! @{$dh{DOPACKAGES}}) {
266 warning("No packages to build.");
270 if (defined $dh{U_PARAMS}) {
271 # Split the U_PARAMS up into an array.
274 push @{$dh{U_PARAMS}}, split(/\s+/,$u);
277 # Anything left in @ARGV is options that appeared after a --
278 # These options are added to the U_PARAMS array, while the
279 # non-option values we collected replace them in @ARGV;
280 push @{$dh{U_PARAMS}}, @ARGV, @ARGV_extra;
281 @ARGV=@{$dh{ARGV}} if exists $dh{ARGV};
285 # Enable bundling of short command line options.
286 Getopt::Long::config("bundling");