-
Notifications
You must be signed in to change notification settings - Fork 138
/
Utils.pm
337 lines (234 loc) · 7.81 KB
/
Utils.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# Copyright (C) 2001-2008, The Perl Foundation.
# $Id$
=head1 NAME
Parrot::Configure::Utils - Configuration Step Utilities
=head1 DESCRIPTION
The C<Parrot::Configure::Utils> module contains utility functions for use by
the configuration step classes found under F<config/>.
The subroutines found in this module do B<not> require the Parrot::Configure
object as an argument. Those subroutines formerly found in this module which
B<do> require the Parrot::Configure object as an argument have been moved into
Parrot::Configure::Compiler.
=head2 Functions
=over 4
=cut
package Parrot::Configure::Utils;
use strict;
use warnings;
use base qw( Exporter );
use Carp;
use File::Copy ();
use File::Spec;
use File::Which;
use lib ("lib");
our @EXPORT = ();
our @EXPORT_OK = qw(
prompt copy_if_diff move_if_diff integrate
capture_output check_progs _slurp
_run_command _build_compile_command
);
our %EXPORT_TAGS = (
inter => [qw(prompt integrate)],
auto => [
qw(capture_output check_progs)
],
gen => [qw( copy_if_diff move_if_diff )]
);
=item C<_run_command($command, $out, $err)>
Runs the specified command. Output is directed to the file specified by
C<$out>, warnings and errors are directed to the file specified by C<$err>.
=cut
sub _run_command {
my ( $command, $out, $err, $verbose ) = @_;
if ($verbose) {
print "$command\n";
}
# Mostly copied from Parrot::Test.pm
foreach ( $out, $err ) {
$_ = File::Spec->devnull
if $_ and $_ eq '/dev/null';
}
if ( $out and $err and $out eq $err ) {
$err = "&STDOUT";
}
# Save the old filehandles; we must not let them get closed.
open my $OLDOUT, '>&', \*STDOUT or die "Can't save stdout" if $out;
open my $OLDERR, '>&', \*STDERR or die "Can't save stderr" if $err;
open STDOUT, '>', $out or die "Can't redirect stdout" if $out;
# See 'Obscure Open Tricks' in perlopentut
open STDERR, ">$err" ## no critic InputOutput::ProhibitTwoArgOpen
or die "Can't redirect stderr"
if $err;
system $command;
my $exit_code = $? >> 8;
close STDOUT or die "Can't close stdout" if $out;
close STDERR or die "Can't close stderr" if $err;
open STDOUT, '>&', $OLDOUT or die "Can't restore stdout" if $out;
open STDERR, '>&', $OLDERR or die "Can't restore stderr" if $err;
if ($verbose) {
foreach ( $out, $err ) {
if ( ( defined($_) )
&& ( $_ ne File::Spec->devnull )
&& ( !m/^&/ ) )
{
open( my $verbose_handle, '<', $_ );
print <$verbose_handle>;
close $verbose_handle;
}
}
}
return $exit_code;
}
=item C<_build_compile_command( $cc, $ccflags, $cc_args )>
Constructs a command-line to do the compile.
=cut
sub _build_compile_command {
my ( $cc, $ccflags, $cc_args ) = @_;
$_ ||= '' for ( $cc, $ccflags, $cc_args );
return "$cc $ccflags $cc_args -I./include -c test_$$.c";
}
=item C<integrate($orig, $new)>
Integrates C<$new> into C<$orig>. Returns C<$orig> if C<$new> is undefined.
=cut
sub integrate {
my ( $orig, $new ) = @_;
# Rather than sprinkling "if defined(...)", everywhere,
# various inter::* steps (coded in config/inter/*.pm) permit simply
# passing in potentially undefined strings.
# In these instances, we simply pass back the original string without
# generating a warning.
return $orig unless defined $new;
if ( $new =~ /\S/ ) {
$orig = $new;
}
return $orig;
}
=item C<prompt($message, $value)>
Prints out "message [default] " and waits for the user's response. Returns the
response, or the default if the user just hit C<ENTER>.
=cut
sub prompt {
my ( $message, $value ) = @_;
print("$message [$value] ");
chomp( my $input = <STDIN> );
if ($input) {
$value = $input;
}
return integrate( $value, $input );
}
=item C<file_checksum($filename, $ignore_pattern)>
Creates a checksum for the specified file. This is used to compare files.
Any lines matching the regular expression specified by C<$ignore_pattern> are
not included in the checksum.
=cut
sub file_checksum {
my ( $filename, $ignore_pattern ) = @_;
open( my $file, '<', $filename ) or die "Can't open $filename: $!";
my $sum = 0;
while (<$file>) {
next if defined($ignore_pattern) && /$ignore_pattern/;
$sum += unpack( "%32C*", $_ );
}
close($file) or die "Can't close $filename: $!";
return $sum;
}
=item C<copy_if_diff($from, $to, $ignore_pattern)>
Copies the file specified by C<$from> to the location specified by C<$to> if
its contents have changed.
The regular expression specified by C<$ignore_pattern> is passed to
C<file_checksum()> when comparing the files.
=cut
sub copy_if_diff {
my ( $from, $to, $ignore_pattern ) = @_;
# Don't touch the file if it didn't change (avoid unnecessary rebuilds)
if ( -r $to ) {
my $from_sum = file_checksum( $from, $ignore_pattern );
my $to_sum = file_checksum( $to, $ignore_pattern );
return if $from_sum == $to_sum;
}
File::Copy::copy( $from, $to );
# Make sure the timestamp is updated
my $now = time;
utime $now, $now, $to;
return 1;
}
=item C<move_if_diff($from, $to, $ignore_pattern)>
Moves the file specified by C<$from> to the location specified by C<$to> if
its contents have changed.
=cut
sub move_if_diff { ## no critic Subroutines::RequireFinalReturn
my ( $from, $to, $ignore_pattern ) = @_;
copy_if_diff( $from, $to, $ignore_pattern );
unlink $from;
}
=item C<capture_output($command)>
Executes the given command. The command's output (both stdout and stderr), and
its return status is returned as a 3-tuple. B<STDERR> is redirected to
F<test.err> during the execution, and deleted after the command's run.
=cut
sub capture_output {
my $command = join ' ', @_;
# disable STDERR
open my $OLDERR, '>&', \*STDERR;
open STDERR, '>', "test_$$.err";
my $output = `$command`;
my $retval = ( $? == -1 ) ? -1 : ( $? >> 8 );
# reenable STDERR
close STDERR;
open STDERR, '>&', $OLDERR;
# slurp stderr
my $out_err = _slurp("./test_$$.err");
# cleanup
unlink "test_$$.err";
return ( $output, $out_err, $retval ) if wantarray;
return $output;
}
=item C<check_progs([$programs])>
Where C<$programs> may be either a scalar with the name of a single program or
an array ref of programs to search the current C<PATH> for. The first matching
program name is returned or C<undef> on failure. Note: this function only
returns the name of the program and not its complete path.
This function is similar to C<autoconf>'s C<AC_CHECK_PROGS> macro.
=cut
sub check_progs {
my ( $progs, $verbose ) = @_;
$progs = [$progs] unless ref $progs eq 'ARRAY';
print "checking for program: ", join( " or ", @$progs ), "\n" if $verbose;
foreach my $prog (@$progs) {
my $util = $prog;
# use the first word in the string to ignore any options
($util) = $util =~ /(\S+)/;
my $path = which($util);
if ($verbose) {
print "$path is executable\n" if $path;
}
return $prog if $path;
}
return;
}
=item C<_slurp($filename)>
Slurps C<$filename> into memory and returns it as a string.
=cut
sub _slurp {
my $filename = shift;
open( my $fh, '<', $filename ) or die "Can't open $filename: $!";
my $text = do { local $/; <$fh> };
close($fh) or die "Can't close $filename: $!";
return $text;
}
=back
=cut
=head1 SEE ALSO
=over 4
=item C<Parrot::Configure::runsteps()>
=item F<docs/configuration.pod>
=item F<lib/Parrot/Configure/Compiler.pm>
=back
=cut
1;
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 100
# End:
# vim: expandtab shiftwidth=4: