use new Git::config_path() for aliasesfile
[git/git.git] / perl / Git.pm
CommitLineData
b1edc53d
PB
1=head1 NAME
2
3Git - Perl interface to the Git version control system
4
5=cut
6
7
8package Git;
9
d48b2841 10use 5.008;
b1edc53d
PB
11use strict;
12
13
14BEGIN {
15
16our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
17
18# Totally unstable API.
19$VERSION = '0.01';
20
21
22=head1 SYNOPSIS
23
24 use Git;
25
26 my $version = Git::command_oneline('version');
27
8b9150e3
PB
28 git_cmd_try { Git::command_noisy('update-server-info') }
29 '%s failed w/ code %d';
b1edc53d
PB
30
31 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
32
33
34 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
35
d79850e1 36 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
b1edc53d 37 my $lastrev = <$fh>; chomp $lastrev;
8b9150e3 38 $repo->command_close_pipe($fh, $c);
b1edc53d 39
d43ba468
PB
40 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
41 STDERR => 0 );
b1edc53d 42
7182530d
AR
43 my $sha1 = $repo->hash_and_insert_object('file.txt');
44 my $tempfile = tempfile();
45 my $size = $repo->cat_blob($sha1, $tempfile);
46
b1edc53d
PB
47=cut
48
49
50require Exporter;
51
52@ISA = qw(Exporter);
53
8b9150e3 54@EXPORT = qw(git_cmd_try);
b1edc53d
PB
55
56# Methods which can be called as standalone functions as well:
d79850e1
PB
57@EXPORT_OK = qw(command command_oneline command_noisy
58 command_output_pipe command_input_pipe command_close_pipe
d1a29af9 59 command_bidi_pipe command_close_bidi_pipe
89a56bfb 60 version exec_path html_path hash_object git_cmd_try
e41352b2 61 remote_refs
836ff95d 62 temp_acquire temp_release temp_reset temp_path);
b1edc53d
PB
63
64
65=head1 DESCRIPTION
66
67This module provides Perl scripts easy way to interface the Git version control
68system. The modules have an easy and well-tested way to call arbitrary Git
69commands; in the future, the interface will also provide specialized methods
70for doing easily operations which are not totally trivial to do over
71the generic command interface.
72
73While some commands can be executed outside of any context (e.g. 'version'
5c94f87e 74or 'init'), most operations require a repository context, which in practice
b1edc53d
PB
75means getting an instance of the Git object using the repository() constructor.
76(In the future, we will also get a new_repository() constructor.) All commands
77called as methods of the object are then executed in the context of the
78repository.
79
d5c7721d
PB
80Part of the "repository state" is also information about path to the attached
81working copy (unless you work with a bare repository). You can also navigate
82inside of the working copy using the C<wc_chdir()> method. (Note that
83the repository object is self-contained and will not change working directory
84of your process.)
b1edc53d 85
d5c7721d 86TODO: In the future, we might also do
b1edc53d
PB
87
88 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
89 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
90 my @refs = $remoterepo->refs();
91
b1edc53d
PB
92Currently, the module merely wraps calls to external Git tools. In the future,
93it will provide a much faster way to interact with Git by linking directly
94to libgit. This should be completely opaque to the user, though (performance
9751a32a 95increase notwithstanding).
b1edc53d
PB
96
97=cut
98
99
8b9150e3 100use Carp qw(carp croak); # but croak is bad - throw instead
97b16c06 101use Error qw(:try);
48d9e6ae 102use Cwd qw(abs_path cwd);
d1a29af9 103use IPC::Open2 qw(open2);
e41352b2 104use Fcntl qw(SEEK_SET SEEK_CUR);
b1edc53d
PB
105}
106
107
108=head1 CONSTRUCTORS
109
110=over 4
111
112=item repository ( OPTIONS )
113
114=item repository ( DIRECTORY )
115
116=item repository ()
117
118Construct a new repository object.
119C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
120Possible options are:
121
122B<Repository> - Path to the Git repository.
123
124B<WorkingCopy> - Path to the associated working copy; not strictly required
125as many commands will happily crunch on a bare repository.
126
d5c7721d
PB
127B<WorkingSubdir> - Subdirectory in the working copy to work inside.
128Just left undefined if you do not want to limit the scope of operations.
129
130B<Directory> - Path to the Git working directory in its usual setup.
131The C<.git> directory is searched in the directory and all the parent
132directories; if found, C<WorkingCopy> is set to the directory containing
133it and C<Repository> to the C<.git> directory itself. If no C<.git>
134directory was found, the C<Directory> is assumed to be a bare repository,
135C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
136If the C<$GIT_DIR> environment variable is set, things behave as expected
137as well.
b1edc53d 138
b1edc53d
PB
139You should not use both C<Directory> and either of C<Repository> and
140C<WorkingCopy> - the results of that are undefined.
141
142Alternatively, a directory path may be passed as a single scalar argument
143to the constructor; it is equivalent to setting only the C<Directory> option
144field.
145
146Calling the constructor with no options whatsoever is equivalent to
d5c7721d
PB
147calling it with C<< Directory => '.' >>. In general, if you are building
148a standard porcelain command, simply doing C<< Git->repository() >> should
149do the right thing and setup the object to reflect exactly where the user
150is right now.
b1edc53d
PB
151
152=cut
153
154sub repository {
155 my $class = shift;
156 my @args = @_;
157 my %opts = ();
158 my $self;
159
160 if (defined $args[0]) {
161 if ($#args % 2 != 1) {
162 # Not a hash.
97b16c06
PB
163 $#args == 0 or throw Error::Simple("bad usage");
164 %opts = ( Directory => $args[0] );
b1edc53d
PB
165 } else {
166 %opts = @args;
167 }
d5c7721d
PB
168 }
169
11b8a41c
PB
170 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
171 and not defined $opts{Directory}) {
172 $opts{Directory} = '.';
d5c7721d
PB
173 }
174
11b8a41c 175 if (defined $opts{Directory}) {
64abcc48 176 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
d5c7721d
PB
177
178 my $search = Git->repository(WorkingCopy => $opts{Directory});
179 my $dir;
180 try {
181 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
182 STDERR => 0);
183 } catch Git::Error::Command with {
184 $dir = undef;
185 };
b1edc53d 186
d5c7721d 187 if ($dir) {
71efe0ca 188 $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir;
fe53bbc9 189 $opts{Repository} = abs_path($dir);
d5c7721d
PB
190
191 # If --git-dir went ok, this shouldn't die either.
192 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
193 $dir = abs_path($opts{Directory}) . '/';
194 if ($prefix) {
195 if (substr($dir, -length($prefix)) ne $prefix) {
196 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
197 }
198 substr($dir, -length($prefix)) = '';
b1edc53d 199 }
d5c7721d
PB
200 $opts{WorkingCopy} = $dir;
201 $opts{WorkingSubdir} = $prefix;
202
203 } else {
204 # A bare repository? Let's see...
205 $dir = $opts{Directory};
206
207 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
9517e6b8 208 # Mimic git-rev-parse --git-dir error message:
f66bc5f9 209 throw Error::Simple("fatal: Not a git repository: $dir");
d5c7721d
PB
210 }
211 my $search = Git->repository(Repository => $dir);
212 try {
213 $search->command('symbolic-ref', 'HEAD');
214 } catch Git::Error::Command with {
9517e6b8 215 # Mimic git-rev-parse --git-dir error message:
f66bc5f9 216 throw Error::Simple("fatal: Not a git repository: $dir");
d5c7721d
PB
217 }
218
219 $opts{Repository} = abs_path($dir);
b1edc53d 220 }
d5c7721d
PB
221
222 delete $opts{Directory};
b1edc53d
PB
223 }
224
81a71734 225 $self = { opts => \%opts };
b1edc53d
PB
226 bless $self, $class;
227}
228
b1edc53d
PB
229=back
230
231=head1 METHODS
232
233=over 4
234
235=item command ( COMMAND [, ARGUMENTS... ] )
236
d43ba468
PB
237=item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
238
b1edc53d
PB
239Execute the given Git C<COMMAND> (specify it without the 'git-'
240prefix), optionally with the specified extra C<ARGUMENTS>.
241
d43ba468
PB
242The second more elaborate form can be used if you want to further adjust
243the command execution. Currently, only one option is supported:
244
245B<STDERR> - How to deal with the command's error output. By default (C<undef>)
246it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
247it to be thrown away. If you want to process it, you can get it in a filehandle
248you specify, but you must be extremely careful; if the error output is not
249very short and you want to read it in the same process as where you called
250C<command()>, you are set up for a nice deadlock!
251
b1edc53d
PB
252The method can be called without any instance or on a specified Git repository
253(in that case the command will be run in the repository context).
254
255In scalar context, it returns all the command output in a single string
256(verbatim).
257
258In array context, it returns an array containing lines printed to the
259command's stdout (without trailing newlines).
260
261In both cases, the command's stdin and stderr are the same as the caller's.
262
263=cut
264
265sub command {
d79850e1 266 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
267
268 if (not defined wantarray) {
8b9150e3
PB
269 # Nothing to pepper the possible exception with.
270 _cmd_close($fh, $ctx);
b1edc53d
PB
271
272 } elsif (not wantarray) {
273 local $/;
274 my $text = <$fh>;
8b9150e3
PB
275 try {
276 _cmd_close($fh, $ctx);
277 } catch Git::Error::Command with {
278 # Pepper with the output:
279 my $E = shift;
280 $E->{'-outputref'} = \$text;
281 throw $E;
282 };
b1edc53d
PB
283 return $text;
284
285 } else {
286 my @lines = <$fh>;
67e4baf8 287 defined and chomp for @lines;
8b9150e3
PB
288 try {
289 _cmd_close($fh, $ctx);
290 } catch Git::Error::Command with {
291 my $E = shift;
292 $E->{'-outputref'} = \@lines;
293 throw $E;
294 };
b1edc53d
PB
295 return @lines;
296 }
297}
298
299
300=item command_oneline ( COMMAND [, ARGUMENTS... ] )
301
d43ba468
PB
302=item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
303
b1edc53d
PB
304Execute the given C<COMMAND> in the same way as command()
305does but always return a scalar string containing the first line
306of the command's standard output.
307
308=cut
309
310sub command_oneline {
d79850e1 311 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
312
313 my $line = <$fh>;
d5c7721d 314 defined $line and chomp $line;
8b9150e3
PB
315 try {
316 _cmd_close($fh, $ctx);
317 } catch Git::Error::Command with {
318 # Pepper with the output:
319 my $E = shift;
320 $E->{'-outputref'} = \$line;
321 throw $E;
322 };
b1edc53d
PB
323 return $line;
324}
325
326
d79850e1 327=item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
b1edc53d 328
d43ba468
PB
329=item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
330
b1edc53d
PB
331Execute the given C<COMMAND> in the same way as command()
332does but return a pipe filehandle from which the command output can be
333read.
334
d79850e1
PB
335The function can return C<($pipe, $ctx)> in array context.
336See C<command_close_pipe()> for details.
337
b1edc53d
PB
338=cut
339
d79850e1
PB
340sub command_output_pipe {
341 _command_common_pipe('-|', @_);
342}
b1edc53d 343
b1edc53d 344
d79850e1
PB
345=item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
346
d43ba468
PB
347=item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
348
d79850e1
PB
349Execute the given C<COMMAND> in the same way as command_output_pipe()
350does but return an input pipe filehandle instead; the command output
351is not captured.
352
353The function can return C<($pipe, $ctx)> in array context.
354See C<command_close_pipe()> for details.
355
356=cut
357
358sub command_input_pipe {
359 _command_common_pipe('|-', @_);
8b9150e3
PB
360}
361
362
363=item command_close_pipe ( PIPE [, CTX ] )
364
d79850e1 365Close the C<PIPE> as returned from C<command_*_pipe()>, checking
3dff5379 366whether the command finished successfully. The optional C<CTX> argument
8b9150e3 367is required if you want to see the command name in the error message,
d79850e1 368and it is the second value returned by C<command_*_pipe()> when
8b9150e3
PB
369called in array context. The call idiom is:
370
d79850e1
PB
371 my ($fh, $ctx) = $r->command_output_pipe('status');
372 while (<$fh>) { ... }
373 $r->command_close_pipe($fh, $ctx);
8b9150e3
PB
374
375Note that you should not rely on whatever actually is in C<CTX>;
376currently it is simply the command name but in future the context might
377have more complicated structure.
378
379=cut
380
381sub command_close_pipe {
382 my ($self, $fh, $ctx) = _maybe_self(@_);
383 $ctx ||= '<unknown>';
384 _cmd_close($fh, $ctx);
b1edc53d
PB
385}
386
d1a29af9
AR
387=item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
388
389Execute the given C<COMMAND> in the same way as command_output_pipe()
390does but return both an input pipe filehandle and an output pipe filehandle.
391
392The function will return return C<($pid, $pipe_in, $pipe_out, $ctx)>.
393See C<command_close_bidi_pipe()> for details.
394
395=cut
396
397sub command_bidi_pipe {
398 my ($pid, $in, $out);
48d9e6ae
MO
399 my ($self) = _maybe_self(@_);
400 local %ENV = %ENV;
401 my $cwd_save = undef;
402 if ($self) {
403 shift;
404 $cwd_save = cwd();
405 _setup_git_cmd_env($self);
406 }
d1a29af9 407 $pid = open2($in, $out, 'git', @_);
48d9e6ae 408 chdir($cwd_save) if $cwd_save;
d1a29af9
AR
409 return ($pid, $in, $out, join(' ', @_));
410}
411
412=item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
413
414Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
415checking whether the command finished successfully. The optional C<CTX>
416argument is required if you want to see the command name in the error message,
417and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
418is:
419
420 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
421 print "000000000\n" $out;
422 while (<$in>) { ... }
423 $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
424
425Note that you should not rely on whatever actually is in C<CTX>;
426currently it is simply the command name but in future the context might
427have more complicated structure.
428
429=cut
430
431sub command_close_bidi_pipe {
108c2aaf 432 local $?;
d1a29af9
AR
433 my ($pid, $in, $out, $ctx) = @_;
434 foreach my $fh ($in, $out) {
435 unless (close $fh) {
436 if ($!) {
437 carp "error closing pipe: $!";
438 } elsif ($? >> 8) {
439 throw Git::Error::Command($ctx, $? >>8);
440 }
441 }
442 }
443
444 waitpid $pid, 0;
445
446 if ($? >> 8) {
447 throw Git::Error::Command($ctx, $? >>8);
448 }
449}
450
b1edc53d
PB
451
452=item command_noisy ( COMMAND [, ARGUMENTS... ] )
453
454Execute the given C<COMMAND> in the same way as command() does but do not
455capture the command output - the standard output is not redirected and goes
456to the standard output of the caller application.
457
458While the method is called command_noisy(), you might want to as well use
459it for the most silent Git commands which you know will never pollute your
460stdout but you want to avoid the overhead of the pipe setup when calling them.
461
462The function returns only after the command has finished running.
463
464=cut
465
466sub command_noisy {
467 my ($self, $cmd, @args) = _maybe_self(@_);
d79850e1 468 _check_valid_cmd($cmd);
b1edc53d
PB
469
470 my $pid = fork;
471 if (not defined $pid) {
97b16c06 472 throw Error::Simple("fork failed: $!");
b1edc53d
PB
473 } elsif ($pid == 0) {
474 _cmd_exec($self, $cmd, @args);
475 }
8b9150e3
PB
476 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
477 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
b1edc53d
PB
478 }
479}
480
481
63df97ae
PB
482=item version ()
483
484Return the Git version in use.
485
63df97ae
PB
486=cut
487
18b0fc1c
PB
488sub version {
489 my $verstr = command_oneline('--version');
490 $verstr =~ s/^git version //;
491 $verstr;
492}
63df97ae
PB
493
494
eca1f6fd
PB
495=item exec_path ()
496
d5c7721d 497Return path to the Git sub-command executables (the same as
eca1f6fd
PB
498C<git --exec-path>). Useful mostly only internally.
499
eca1f6fd
PB
500=cut
501
18b0fc1c 502sub exec_path { command_oneline('--exec-path') }
eca1f6fd
PB
503
504
89a56bfb
MH
505=item html_path ()
506
507Return path to the Git html documentation (the same as
508C<git --html-path>). Useful mostly only internally.
509
510=cut
511
512sub html_path { command_oneline('--html-path') }
513
514
d5c7721d
PB
515=item repo_path ()
516
517Return path to the git repository. Must be called on a repository instance.
518
519=cut
520
521sub repo_path { $_[0]->{opts}->{Repository} }
522
523
524=item wc_path ()
525
526Return path to the working copy. Must be called on a repository instance.
527
528=cut
529
530sub wc_path { $_[0]->{opts}->{WorkingCopy} }
531
532
533=item wc_subdir ()
534
535Return path to the subdirectory inside of a working copy. Must be called
536on a repository instance.
537
538=cut
539
540sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
541
542
543=item wc_chdir ( SUBDIR )
544
545Change the working copy subdirectory to work within. The C<SUBDIR> is
546relative to the working copy root directory (not the current subdirectory).
547Must be called on a repository instance attached to a working copy
548and the directory must exist.
549
550=cut
551
552sub wc_chdir {
553 my ($self, $subdir) = @_;
d5c7721d
PB
554 $self->wc_path()
555 or throw Error::Simple("bare repository");
556
557 -d $self->wc_path().'/'.$subdir
64abcc48 558 or throw Error::Simple("subdir not found: $subdir $!");
d5c7721d
PB
559 # Of course we will not "hold" the subdirectory so anyone
560 # can delete it now and we will never know. But at least we tried.
561
562 $self->{opts}->{WorkingSubdir} = $subdir;
563}
564
565
dc2613de
PB
566=item config ( VARIABLE )
567
e0d10e1c 568Retrieve the configuration C<VARIABLE> in the same manner as C<config>
dc2613de
PB
569does. In scalar context requires the variable to be set only one time
570(exception is thrown otherwise), in array context returns allows the
571variable to be set multiple times and returns all the values.
572
e0d10e1c 573This currently wraps command('config') so it is not so fast.
dc2613de
PB
574
575=cut
576
577sub config {
c2e357c2 578 my ($self, $var) = _maybe_self(@_);
dc2613de
PB
579
580 try {
c2e357c2
FL
581 my @cmd = ('config');
582 unshift @cmd, $self if $self;
dc2613de 583 if (wantarray) {
c2e357c2 584 return command(@cmd, '--get-all', $var);
dc2613de 585 } else {
c2e357c2 586 return command_oneline(@cmd, '--get', $var);
dc2613de
PB
587 }
588 } catch Git::Error::Command with {
589 my $E = shift;
590 if ($E->value() == 1) {
591 # Key not found.
32d8050a 592 return;
dc2613de
PB
593 } else {
594 throw $E;
595 }
596 };
597}
598
599
35c49eea 600=item config_bool ( VARIABLE )
7b9a13ec 601
35c49eea
PB
602Retrieve the bool configuration C<VARIABLE>. The return value
603is usable as a boolean in perl (and C<undef> if it's not defined,
604of course).
7b9a13ec 605
7b9a13ec
TT
606This currently wraps command('config') so it is not so fast.
607
608=cut
609
35c49eea 610sub config_bool {
c2e357c2 611 my ($self, $var) = _maybe_self(@_);
7b9a13ec
TT
612
613 try {
c2e357c2
FL
614 my @cmd = ('config', '--bool', '--get', $var);
615 unshift @cmd, $self if $self;
616 my $val = command_oneline(@cmd);
35c49eea
PB
617 return undef unless defined $val;
618 return $val eq 'true';
7b9a13ec
TT
619 } catch Git::Error::Command with {
620 my $E = shift;
621 if ($E->value() == 1) {
622 # Key not found.
623 return undef;
624 } else {
625 throw $E;
626 }
627 };
628}
629
9fef9e27
CS
630
631=item config_path ( VARIABLE )
632
633Retrieve the path configuration C<VARIABLE>. The return value
634is an expanded path or C<undef> if it's not defined.
635
636This currently wraps command('config') so it is not so fast.
637
638=cut
639
640sub config_path {
641 my ($self, $var) = _maybe_self(@_);
642
643 try {
644 my @cmd = ('config', '--path');
645 unshift @cmd, $self if $self;
646 if (wantarray) {
647 return command(@cmd, '--get-all', $var);
648 } else {
649 return command_oneline(@cmd, '--get', $var);
650 }
651 } catch Git::Error::Command with {
652 my $E = shift;
653 if ($E->value() == 1) {
654 # Key not found.
655 return undef;
656 } else {
657 throw $E;
658 }
659 };
660}
661
346d203b
JN
662=item config_int ( VARIABLE )
663
664Retrieve the integer configuration C<VARIABLE>. The return value
665is simple decimal number. An optional value suffix of 'k', 'm',
666or 'g' in the config file will cause the value to be multiplied
667by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
668It would return C<undef> if configuration variable is not defined,
669
346d203b
JN
670This currently wraps command('config') so it is not so fast.
671
672=cut
673
674sub config_int {
c2e357c2 675 my ($self, $var) = _maybe_self(@_);
346d203b
JN
676
677 try {
c2e357c2
FL
678 my @cmd = ('config', '--int', '--get', $var);
679 unshift @cmd, $self if $self;
680 return command_oneline(@cmd);
346d203b
JN
681 } catch Git::Error::Command with {
682 my $E = shift;
683 if ($E->value() == 1) {
684 # Key not found.
685 return undef;
686 } else {
687 throw $E;
688 }
689 };
690}
7b9a13ec 691
b4c61ed6
JH
692=item get_colorbool ( NAME )
693
694Finds if color should be used for NAMEd operation from the configuration,
695and returns boolean (true for "use color", false for "do not use color").
696
697=cut
698
699sub get_colorbool {
700 my ($self, $var) = @_;
701 my $stdout_to_tty = (-t STDOUT) ? "true" : "false";
702 my $use_color = $self->command_oneline('config', '--get-colorbool',
703 $var, $stdout_to_tty);
704 return ($use_color eq 'true');
705}
706
707=item get_color ( SLOT, COLOR )
708
709Finds color for SLOT from the configuration, while defaulting to COLOR,
710and returns the ANSI color escape sequence:
711
712 print $repo->get_color("color.interactive.prompt", "underline blue white");
713 print "some text";
714 print $repo->get_color("", "normal");
715
716=cut
717
718sub get_color {
719 my ($self, $slot, $default) = @_;
720 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
721 if (!defined $color) {
722 $color = "";
723 }
724 return $color;
725}
726
31a92f6a
PB
727=item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
728
729This function returns a hashref of refs stored in a given remote repository.
730The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
731contains the tag object while a C<refname^{}> entry gives the tagged objects.
732
733C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
734argument; either an URL or a remote name (if called on a repository instance).
735C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
736tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
737of strings containing a shell-like glob to further limit the refs returned in
738the hash; the meaning is again the same as the appropriate C<git-ls-remote>
739argument.
740
741This function may or may not be called on a repository instance. In the former
742case, remote names as defined in the repository are recognized as repository
743specifiers.
744
745=cut
746
747sub remote_refs {
748 my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
749 my @args;
750 if (ref $groups eq 'ARRAY') {
751 foreach (@$groups) {
752 if ($_ eq 'heads') {
753 push (@args, '--heads');
754 } elsif ($_ eq 'tags') {
755 push (@args, '--tags');
756 } else {
757 # Ignore unknown groups for future
758 # compatibility
759 }
760 }
761 }
762 push (@args, $repo);
763 if (ref $refglobs eq 'ARRAY') {
764 push (@args, @$refglobs);
765 }
766
767 my @self = $self ? ($self) : (); # Ultra trickery
768 my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
769 my %refs;
770 while (<$fh>) {
771 chomp;
772 my ($hash, $ref) = split(/\t/, $_, 2);
773 $refs{$ref} = $hash;
774 }
775 Git::command_close_pipe(@self, $fh, $ctx);
776 return \%refs;
777}
778
779
c7a30e56
PB
780=item ident ( TYPE | IDENTSTR )
781
782=item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
783
784This suite of functions retrieves and parses ident information, as stored
785in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
786C<TYPE> can be either I<author> or I<committer>; case is insignificant).
787
5354a56f 788The C<ident> method retrieves the ident information from C<git var>
c7a30e56
PB
789and either returns it as a scalar string or as an array with the fields parsed.
790Alternatively, it can take a prepared ident string (e.g. from the commit
791object) and just parse it.
792
793C<ident_person> returns the person part of the ident - name and email;
794it can take the same arguments as C<ident> or the array returned by C<ident>.
795
796The synopsis is like:
797
798 my ($name, $email, $time_tz) = ident('author');
799 "$name <$email>" eq ident_person('author');
800 "$name <$email>" eq ident_person($name);
801 $time_tz =~ /^\d+ [+-]\d{4}$/;
802
c7a30e56
PB
803=cut
804
805sub ident {
44617928 806 my ($self, $type) = _maybe_self(@_);
c7a30e56
PB
807 my $identstr;
808 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
44617928
FL
809 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
810 unshift @cmd, $self if $self;
811 $identstr = command_oneline(@cmd);
c7a30e56
PB
812 } else {
813 $identstr = $type;
814 }
815 if (wantarray) {
816 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
817 } else {
818 return $identstr;
819 }
820}
821
822sub ident_person {
44617928
FL
823 my ($self, @ident) = _maybe_self(@_);
824 $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
c7a30e56
PB
825 return "$ident[0] <$ident[1]>";
826}
827
828
24c4b714 829=item hash_object ( TYPE, FILENAME )
b1edc53d 830
58c8dd21
LW
831Compute the SHA1 object id of the given C<FILENAME> considering it is
832of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
b1edc53d 833
b1edc53d
PB
834The method can be called without any instance or on a specified Git repository,
835it makes zero difference.
836
837The function returns the SHA1 hash.
838
b1edc53d
PB
839=cut
840
18b0fc1c 841# TODO: Support for passing FILEHANDLE instead of FILENAME
e6634ac9
PB
842sub hash_object {
843 my ($self, $type, $file) = _maybe_self(@_);
18b0fc1c 844 command_oneline('hash-object', '-t', $type, $file);
e6634ac9 845}
b1edc53d
PB
846
847
7182530d
AR
848=item hash_and_insert_object ( FILENAME )
849
850Compute the SHA1 object id of the given C<FILENAME> and add the object to the
851object database.
852
853The function returns the SHA1 hash.
854
855=cut
856
857# TODO: Support for passing FILEHANDLE instead of FILENAME
858sub hash_and_insert_object {
859 my ($self, $filename) = @_;
860
861 carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
862
863 $self->_open_hash_and_insert_object_if_needed();
864 my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
865
866 unless (print $out $filename, "\n") {
867 $self->_close_hash_and_insert_object();
868 throw Error::Simple("out pipe went bad");
869 }
870
871 chomp(my $hash = <$in>);
872 unless (defined($hash)) {
873 $self->_close_hash_and_insert_object();
874 throw Error::Simple("in pipe went bad");
875 }
876
877 return $hash;
878}
879
880sub _open_hash_and_insert_object_if_needed {
881 my ($self) = @_;
882
883 return if defined($self->{hash_object_pid});
884
885 ($self->{hash_object_pid}, $self->{hash_object_in},
886 $self->{hash_object_out}, $self->{hash_object_ctx}) =
48d9e6ae 887 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
7182530d
AR
888}
889
890sub _close_hash_and_insert_object {
891 my ($self) = @_;
892
893 return unless defined($self->{hash_object_pid});
894
895 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
896
452d36b1
AMS
897 command_close_bidi_pipe(@$self{@vars});
898 delete @$self{@vars};
7182530d
AR
899}
900
901=item cat_blob ( SHA1, FILEHANDLE )
902
903Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
904returns the number of bytes printed.
905
906=cut
907
908sub cat_blob {
909 my ($self, $sha1, $fh) = @_;
910
911 $self->_open_cat_blob_if_needed();
912 my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
913
914 unless (print $out $sha1, "\n") {
915 $self->_close_cat_blob();
916 throw Error::Simple("out pipe went bad");
917 }
918
919 my $description = <$in>;
920 if ($description =~ / missing$/) {
921 carp "$sha1 doesn't exist in the repository";
d683a0e0 922 return -1;
7182530d
AR
923 }
924
925 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
926 carp "Unexpected result returned from git cat-file";
d683a0e0 927 return -1;
7182530d
AR
928 }
929
930 my $size = $1;
931
932 my $blob;
933 my $bytesRead = 0;
934
935 while (1) {
936 my $bytesLeft = $size - $bytesRead;
937 last unless $bytesLeft;
938
939 my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024;
940 my $read = read($in, $blob, $bytesToRead, $bytesRead);
941 unless (defined($read)) {
942 $self->_close_cat_blob();
943 throw Error::Simple("in pipe went bad");
944 }
945
946 $bytesRead += $read;
947 }
948
949 # Skip past the trailing newline.
950 my $newline;
951 my $read = read($in, $newline, 1);
952 unless (defined($read)) {
953 $self->_close_cat_blob();
954 throw Error::Simple("in pipe went bad");
955 }
956 unless ($read == 1 && $newline eq "\n") {
957 $self->_close_cat_blob();
958 throw Error::Simple("didn't find newline after blob");
959 }
960
961 unless (print $fh $blob) {
962 $self->_close_cat_blob();
963 throw Error::Simple("couldn't write to passed in filehandle");
964 }
965
966 return $size;
967}
968
969sub _open_cat_blob_if_needed {
970 my ($self) = @_;
971
972 return if defined($self->{cat_blob_pid});
973
974 ($self->{cat_blob_pid}, $self->{cat_blob_in},
975 $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
48d9e6ae 976 $self->command_bidi_pipe(qw(cat-file --batch));
7182530d
AR
977}
978
979sub _close_cat_blob {
980 my ($self) = @_;
981
982 return unless defined($self->{cat_blob_pid});
983
984 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
985
452d36b1
AMS
986 command_close_bidi_pipe(@$self{@vars});
987 delete @$self{@vars};
7182530d 988}
8b9150e3 989
e41352b2
MG
990
991{ # %TEMP_* Lexical Context
992
836ff95d 993my (%TEMP_FILEMAP, %TEMP_FILES);
e41352b2
MG
994
995=item temp_acquire ( NAME )
996
997Attempts to retreive the temporary file mapped to the string C<NAME>. If an
998associated temp file has not been created this session or was closed, it is
999created, cached, and set for autoflush and binmode.
1000
1001Internally locks the file mapped to C<NAME>. This lock must be released with
1002C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1003to retrieve temporary files mapped to the same C<NAME> while still locked will
1004cause an error. This locking mechanism provides a weak guarantee and is not
1005threadsafe. It does provide some error checking to help prevent temp file refs
1006writing over one another.
1007
1008In general, the L<File::Handle> returned should not be closed by consumers as
1009it defeats the purpose of this caching mechanism. If you need to close the temp
1010file handle, then you should use L<File::Temp> or another temp file faculty
1011directly. If a handle is closed and then requested again, then a warning will
1012issue.
1013
1014=cut
1015
1016sub temp_acquire {
bcdd1b44 1017 my $temp_fd = _temp_cache(@_);
e41352b2 1018
836ff95d 1019 $TEMP_FILES{$temp_fd}{locked} = 1;
e41352b2
MG
1020 $temp_fd;
1021}
1022
1023=item temp_release ( NAME )
1024
1025=item temp_release ( FILEHANDLE )
1026
1027Releases a lock acquired through C<temp_acquire()>. Can be called either with
1028the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1029referencing a locked temp file.
1030
1031Warns if an attempt is made to release a file that is not locked.
1032
1033The temp file will be truncated before being released. This can help to reduce
1034disk I/O where the system is smart enough to detect the truncation while data
1035is in the output buffers. Beware that after the temp file is released and
1036truncated, any operations on that file may fail miserably until it is
1037re-acquired. All contents are lost between each release and acquire mapped to
1038the same string.
1039
1040=cut
1041
1042sub temp_release {
1043 my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1044
836ff95d 1045 if (exists $TEMP_FILEMAP{$temp_fd}) {
e41352b2
MG
1046 $temp_fd = $TEMP_FILES{$temp_fd};
1047 }
836ff95d 1048 unless ($TEMP_FILES{$temp_fd}{locked}) {
e41352b2
MG
1049 carp "Attempt to release temp file '",
1050 $temp_fd, "' that has not been locked";
1051 }
1052 temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1053
836ff95d 1054 $TEMP_FILES{$temp_fd}{locked} = 0;
e41352b2
MG
1055 undef;
1056}
1057
1058sub _temp_cache {
bcdd1b44 1059 my ($self, $name) = _maybe_self(@_);
e41352b2 1060
c14c8ceb
MG
1061 _verify_require();
1062
836ff95d 1063 my $temp_fd = \$TEMP_FILEMAP{$name};
e41352b2 1064 if (defined $$temp_fd and $$temp_fd->opened) {
836ff95d 1065 if ($TEMP_FILES{$$temp_fd}{locked}) {
8faea4f3
JS
1066 throw Error::Simple("Temp file with moniker '" .
1067 $name . "' already in use");
e41352b2
MG
1068 }
1069 } else {
1070 if (defined $$temp_fd) {
1071 # then we're here because of a closed handle.
1072 carp "Temp file '", $name,
1073 "' was closed. Opening replacement.";
1074 }
836ff95d 1075 my $fname;
bcdd1b44
MS
1076
1077 my $tmpdir;
1078 if (defined $self) {
1079 $tmpdir = $self->repo_path();
1080 }
1081
836ff95d 1082 ($$temp_fd, $fname) = File::Temp->tempfile(
bcdd1b44 1083 'Git_XXXXXX', UNLINK => 1, DIR => $tmpdir,
e41352b2 1084 ) or throw Error::Simple("couldn't open new temp file");
bcdd1b44 1085
e41352b2
MG
1086 $$temp_fd->autoflush;
1087 binmode $$temp_fd;
836ff95d 1088 $TEMP_FILES{$$temp_fd}{fname} = $fname;
e41352b2
MG
1089 }
1090 $$temp_fd;
1091}
1092
c14c8ceb
MG
1093sub _verify_require {
1094 eval { require File::Temp; require File::Spec; };
1095 $@ and throw Error::Simple($@);
1096}
1097
e41352b2
MG
1098=item temp_reset ( FILEHANDLE )
1099
1100Truncates and resets the position of the C<FILEHANDLE>.
1101
1102=cut
1103
1104sub temp_reset {
1105 my ($self, $temp_fd) = _maybe_self(@_);
1106
1107 truncate $temp_fd, 0
1108 or throw Error::Simple("couldn't truncate file");
1109 sysseek($temp_fd, 0, SEEK_SET) and seek($temp_fd, 0, SEEK_SET)
1110 or throw Error::Simple("couldn't seek to beginning of file");
1111 sysseek($temp_fd, 0, SEEK_CUR) == 0 and tell($temp_fd) == 0
1112 or throw Error::Simple("expected file position to be reset");
1113}
1114
836ff95d
MG
1115=item temp_path ( NAME )
1116
1117=item temp_path ( FILEHANDLE )
1118
1119Returns the filename associated with the given tempfile.
1120
1121=cut
1122
1123sub temp_path {
1124 my ($self, $temp_fd) = _maybe_self(@_);
1125
1126 if (exists $TEMP_FILEMAP{$temp_fd}) {
1127 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1128 }
1129 $TEMP_FILES{$temp_fd}{fname};
1130}
1131
e41352b2 1132sub END {
836ff95d 1133 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
e41352b2
MG
1134}
1135
1136} # %TEMP_* Lexical Context
1137
b1edc53d
PB
1138=back
1139
97b16c06 1140=head1 ERROR HANDLING
b1edc53d 1141
97b16c06 1142All functions are supposed to throw Perl exceptions in case of errors.
8b9150e3
PB
1143See the L<Error> module on how to catch those. Most exceptions are mere
1144L<Error::Simple> instances.
1145
1146However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1147functions suite can throw C<Git::Error::Command> exceptions as well: those are
1148thrown when the external command returns an error code and contain the error
1149code as well as access to the captured command's output. The exception class
1150provides the usual C<stringify> and C<value> (command's exit code) methods and
1151in addition also a C<cmd_output> method that returns either an array or a
1152string with the captured command output (depending on the original function
1153call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1154returns the command and its arguments (but without proper quoting).
1155
d79850e1 1156Note that the C<command_*_pipe()> functions cannot throw this exception since
8b9150e3
PB
1157it has no idea whether the command failed or not. You will only find out
1158at the time you C<close> the pipe; if you want to have that automated,
1159use C<command_close_pipe()>, which can throw the exception.
1160
1161=cut
1162
1163{
1164 package Git::Error::Command;
1165
1166 @Git::Error::Command::ISA = qw(Error);
1167
1168 sub new {
1169 my $self = shift;
1170 my $cmdline = '' . shift;
1171 my $value = 0 + shift;
1172 my $outputref = shift;
1173 my(@args) = ();
1174
1175 local $Error::Depth = $Error::Depth + 1;
1176
1177 push(@args, '-cmdline', $cmdline);
1178 push(@args, '-value', $value);
1179 push(@args, '-outputref', $outputref);
1180
1181 $self->SUPER::new(-text => 'command returned error', @args);
1182 }
1183
1184 sub stringify {
1185 my $self = shift;
1186 my $text = $self->SUPER::stringify;
1187 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1188 }
1189
1190 sub cmdline {
1191 my $self = shift;
1192 $self->{'-cmdline'};
1193 }
1194
1195 sub cmd_output {
1196 my $self = shift;
1197 my $ref = $self->{'-outputref'};
1198 defined $ref or undef;
1199 if (ref $ref eq 'ARRAY') {
1200 return @$ref;
1201 } else { # SCALAR
1202 return $$ref;
1203 }
1204 }
1205}
1206
1207=over 4
1208
1209=item git_cmd_try { CODE } ERRMSG
1210
1211This magical statement will automatically catch any C<Git::Error::Command>
1212exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1213on its lips; the message will have %s substituted for the command line
1214and %d for the exit status. This statement is useful mostly for producing
1215more user-friendly error messages.
1216
1217In case of no exception caught the statement returns C<CODE>'s return value.
1218
1219Note that this is the only auto-exported function.
1220
1221=cut
1222
1223sub git_cmd_try(&$) {
1224 my ($code, $errmsg) = @_;
1225 my @result;
1226 my $err;
1227 my $array = wantarray;
1228 try {
1229 if ($array) {
1230 @result = &$code;
1231 } else {
1232 $result[0] = &$code;
1233 }
1234 } catch Git::Error::Command with {
1235 my $E = shift;
1236 $err = $errmsg;
1237 $err =~ s/\%s/$E->cmdline()/ge;
1238 $err =~ s/\%d/$E->value()/ge;
1239 # We can't croak here since Error.pm would mangle
1240 # that to Error::Simple.
1241 };
1242 $err and croak $err;
1243 return $array ? @result : $result[0];
1244}
1245
1246
1247=back
b1edc53d
PB
1248
1249=head1 COPYRIGHT
1250
1251Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1252
1253This module is free software; it may be used, copied, modified
1254and distributed under the terms of the GNU General Public Licence,
1255either version 2, or (at your option) any later version.
1256
1257=cut
1258
1259
1260# Take raw method argument list and return ($obj, @args) in case
1261# the method was called upon an instance and (undef, @args) if
1262# it was called directly.
1263sub _maybe_self {
d8b24b93 1264 UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
b1edc53d
PB
1265}
1266
d79850e1
PB
1267# Check if the command id is something reasonable.
1268sub _check_valid_cmd {
1269 my ($cmd) = @_;
1270 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1271}
1272
1273# Common backend for the pipe creators.
1274sub _command_common_pipe {
1275 my $direction = shift;
d43ba468
PB
1276 my ($self, @p) = _maybe_self(@_);
1277 my (%opts, $cmd, @args);
1278 if (ref $p[0]) {
1279 ($cmd, @args) = @{shift @p};
1280 %opts = ref $p[0] ? %{$p[0]} : @p;
1281 } else {
1282 ($cmd, @args) = @p;
1283 }
d79850e1
PB
1284 _check_valid_cmd($cmd);
1285
a6065b54 1286 my $fh;
d3b1785f 1287 if ($^O eq 'MSWin32') {
a6065b54
PB
1288 # ActiveState Perl
1289 #defined $opts{STDERR} and
1290 # warn 'ignoring STDERR option - running w/ ActiveState';
1291 $direction eq '-|' or
1292 die 'input pipe for ActiveState not implemented';
bed118d6
AR
1293 # the strange construction with *ACPIPE is just to
1294 # explain the tie below that we want to bind to
1295 # a handle class, not scalar. It is not known if
1296 # it is something specific to ActiveState Perl or
1297 # just a Perl quirk.
1298 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
1299 $fh = *ACPIPE;
a6065b54
PB
1300
1301 } else {
1302 my $pid = open($fh, $direction);
1303 if (not defined $pid) {
1304 throw Error::Simple("open failed: $!");
1305 } elsif ($pid == 0) {
1306 if (defined $opts{STDERR}) {
1307 close STDERR;
1308 }
1309 if ($opts{STDERR}) {
1310 open (STDERR, '>&', $opts{STDERR})
1311 or die "dup failed: $!";
1312 }
1313 _cmd_exec($self, $cmd, @args);
d43ba468 1314 }
d79850e1
PB
1315 }
1316 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1317}
1318
b1edc53d
PB
1319# When already in the subprocess, set up the appropriate state
1320# for the given repository and execute the git command.
1321sub _cmd_exec {
1322 my ($self, @args) = @_;
48d9e6ae
MO
1323 _setup_git_cmd_env($self);
1324 _execv_git_cmd(@args);
1325 die qq[exec "@args" failed: $!];
1326}
1327
1328# set up the appropriate state for git command
1329sub _setup_git_cmd_env {
1330 my $self = shift;
b1edc53d 1331 if ($self) {
d5c7721d 1332 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
da159c77
FL
1333 $self->repo_path() and $self->wc_path()
1334 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
d5c7721d
PB
1335 $self->wc_path() and chdir($self->wc_path());
1336 $self->wc_subdir() and chdir($self->wc_subdir());
b1edc53d 1337 }
b1edc53d
PB
1338}
1339
8062f81c
PB
1340# Execute the given Git command ($_[0]) with arguments ($_[1..])
1341# by searching for it at proper places.
18b0fc1c 1342sub _execv_git_cmd { exec('git', @_); }
8062f81c 1343
b1edc53d
PB
1344# Close pipe to a subprocess.
1345sub _cmd_close {
8b9150e3 1346 my ($fh, $ctx) = @_;
b1edc53d
PB
1347 if (not close $fh) {
1348 if ($!) {
1349 # It's just close, no point in fatalities
1350 carp "error closing pipe: $!";
1351 } elsif ($? >> 8) {
8b9150e3
PB
1352 # The caller should pepper this.
1353 throw Git::Error::Command($ctx, $? >> 8);
b1edc53d
PB
1354 }
1355 # else we might e.g. closed a live stream; the command
1356 # dying of SIGPIPE would drive us here.
1357 }
1358}
1359
1360
7182530d
AR
1361sub DESTROY {
1362 my ($self) = @_;
1363 $self->_close_hash_and_insert_object();
1364 $self->_close_cat_blob();
1365}
b1edc53d
PB
1366
1367
a6065b54
PB
1368# Pipe implementation for ActiveState Perl.
1369
1370package Git::activestate_pipe;
1371use strict;
1372
1373sub TIEHANDLE {
1374 my ($class, @params) = @_;
1375 # FIXME: This is probably horrible idea and the thing will explode
1376 # at the moment you give it arguments that require some quoting,
1377 # but I have no ActiveState clue... --pasky
d3b1785f
AR
1378 # Let's just hope ActiveState Perl does at least the quoting
1379 # correctly.
1380 my @data = qx{git @params};
a6065b54
PB
1381 bless { i => 0, data => \@data }, $class;
1382}
1383
1384sub READLINE {
1385 my $self = shift;
1386 if ($self->{i} >= scalar @{$self->{data}}) {
1387 return undef;
1388 }
2f5b3980
AR
1389 my $i = $self->{i};
1390 if (wantarray) {
1391 $self->{i} = $#{$self->{'data'}} + 1;
1392 return splice(@{$self->{'data'}}, $i);
1393 }
1394 $self->{i} = $i + 1;
1395 return $self->{'data'}->[ $i ];
a6065b54
PB
1396}
1397
1398sub CLOSE {
1399 my $self = shift;
1400 delete $self->{data};
1401 delete $self->{i};
1402}
1403
1404sub EOF {
1405 my $self = shift;
1406 return ($self->{i} >= scalar @{$self->{data}});
1407}
1408
1409
b1edc53d 14101; # Famous last words