Documentation/git-log.txt: capitalize section names
[git.git] / perl / Git.pm
blob7a252ef872c92213c8dcd2144a84cdcf787e586a
1 =head1 NAME
3 Git - Perl interface to the Git version control system
5 =cut
8 package Git;
10 use 5.008;
11 use strict;
14 BEGIN {
16 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
18 # Totally unstable API.
19 $VERSION = '0.01';
22 =head1 SYNOPSIS
24 use Git;
26 my $version = Git::command_oneline('version');
28 git_cmd_try { Git::command_noisy('update-server-info') }
29 '%s failed w/ code %d';
31 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
34 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
36 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
37 my $lastrev = <$fh>; chomp $lastrev;
38 $repo->command_close_pipe($fh, $c);
40 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
41 STDERR => 0 );
43 my $sha1 = $repo->hash_and_insert_object('file.txt');
44 my $tempfile = tempfile();
45 my $size = $repo->cat_blob($sha1, $tempfile);
47 =cut
50 require Exporter;
52 @ISA = qw(Exporter);
54 @EXPORT = qw(git_cmd_try);
56 # Methods which can be called as standalone functions as well:
57 @EXPORT_OK = qw(command command_oneline command_noisy
58 command_output_pipe command_input_pipe command_close_pipe
59 command_bidi_pipe command_close_bidi_pipe
60 version exec_path html_path hash_object git_cmd_try
61 remote_refs prompt
62 get_tz_offset
63 credential credential_read credential_write
64 temp_acquire temp_release temp_reset temp_path);
67 =head1 DESCRIPTION
69 This module provides Perl scripts easy way to interface the Git version control
70 system. The modules have an easy and well-tested way to call arbitrary Git
71 commands; in the future, the interface will also provide specialized methods
72 for doing easily operations which are not totally trivial to do over
73 the generic command interface.
75 While some commands can be executed outside of any context (e.g. 'version'
76 or 'init'), most operations require a repository context, which in practice
77 means getting an instance of the Git object using the repository() constructor.
78 (In the future, we will also get a new_repository() constructor.) All commands
79 called as methods of the object are then executed in the context of the
80 repository.
82 Part of the "repository state" is also information about path to the attached
83 working copy (unless you work with a bare repository). You can also navigate
84 inside of the working copy using the C<wc_chdir()> method. (Note that
85 the repository object is self-contained and will not change working directory
86 of your process.)
88 TODO: In the future, we might also do
90 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
91 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
92 my @refs = $remoterepo->refs();
94 Currently, the module merely wraps calls to external Git tools. In the future,
95 it will provide a much faster way to interact with Git by linking directly
96 to libgit. This should be completely opaque to the user, though (performance
97 increase notwithstanding).
99 =cut
102 use Carp qw(carp croak); # but croak is bad - throw instead
103 use Error qw(:try);
104 use Cwd qw(abs_path cwd);
105 use IPC::Open2 qw(open2);
106 use Fcntl qw(SEEK_SET SEEK_CUR);
107 use Time::Local qw(timegm);
111 =head1 CONSTRUCTORS
113 =over 4
115 =item repository ( OPTIONS )
117 =item repository ( DIRECTORY )
119 =item repository ()
121 Construct a new repository object.
122 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
123 Possible options are:
125 B<Repository> - Path to the Git repository.
127 B<WorkingCopy> - Path to the associated working copy; not strictly required
128 as many commands will happily crunch on a bare repository.
130 B<WorkingSubdir> - Subdirectory in the working copy to work inside.
131 Just left undefined if you do not want to limit the scope of operations.
133 B<Directory> - Path to the Git working directory in its usual setup.
134 The C<.git> directory is searched in the directory and all the parent
135 directories; if found, C<WorkingCopy> is set to the directory containing
136 it and C<Repository> to the C<.git> directory itself. If no C<.git>
137 directory was found, the C<Directory> is assumed to be a bare repository,
138 C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
139 If the C<$GIT_DIR> environment variable is set, things behave as expected
140 as well.
142 You should not use both C<Directory> and either of C<Repository> and
143 C<WorkingCopy> - the results of that are undefined.
145 Alternatively, a directory path may be passed as a single scalar argument
146 to the constructor; it is equivalent to setting only the C<Directory> option
147 field.
149 Calling the constructor with no options whatsoever is equivalent to
150 calling it with C<< Directory => '.' >>. In general, if you are building
151 a standard porcelain command, simply doing C<< Git->repository() >> should
152 do the right thing and setup the object to reflect exactly where the user
153 is right now.
155 =cut
157 sub repository {
158 my $class = shift;
159 my @args = @_;
160 my %opts = ();
161 my $self;
163 if (defined $args[0]) {
164 if ($#args % 2 != 1) {
165 # Not a hash.
166 $#args == 0 or throw Error::Simple("bad usage");
167 %opts = ( Directory => $args[0] );
168 } else {
169 %opts = @args;
173 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
174 and not defined $opts{Directory}) {
175 $opts{Directory} = '.';
178 if (defined $opts{Directory}) {
179 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
181 my $search = Git->repository(WorkingCopy => $opts{Directory});
182 my $dir;
183 try {
184 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
185 STDERR => 0);
186 } catch Git::Error::Command with {
187 $dir = undef;
190 if ($dir) {
191 $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir;
192 $opts{Repository} = abs_path($dir);
194 # If --git-dir went ok, this shouldn't die either.
195 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
196 $dir = abs_path($opts{Directory}) . '/';
197 if ($prefix) {
198 if (substr($dir, -length($prefix)) ne $prefix) {
199 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
201 substr($dir, -length($prefix)) = '';
203 $opts{WorkingCopy} = $dir;
204 $opts{WorkingSubdir} = $prefix;
206 } else {
207 # A bare repository? Let's see...
208 $dir = $opts{Directory};
210 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
211 # Mimic git-rev-parse --git-dir error message:
212 throw Error::Simple("fatal: Not a git repository: $dir");
214 my $search = Git->repository(Repository => $dir);
215 try {
216 $search->command('symbolic-ref', 'HEAD');
217 } catch Git::Error::Command with {
218 # Mimic git-rev-parse --git-dir error message:
219 throw Error::Simple("fatal: Not a git repository: $dir");
222 $opts{Repository} = abs_path($dir);
225 delete $opts{Directory};
228 $self = { opts => \%opts };
229 bless $self, $class;
232 =back
234 =head1 METHODS
236 =over 4
238 =item command ( COMMAND [, ARGUMENTS... ] )
240 =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
242 Execute the given Git C<COMMAND> (specify it without the 'git-'
243 prefix), optionally with the specified extra C<ARGUMENTS>.
245 The second more elaborate form can be used if you want to further adjust
246 the command execution. Currently, only one option is supported:
248 B<STDERR> - How to deal with the command's error output. By default (C<undef>)
249 it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
250 it to be thrown away. If you want to process it, you can get it in a filehandle
251 you specify, but you must be extremely careful; if the error output is not
252 very short and you want to read it in the same process as where you called
253 C<command()>, you are set up for a nice deadlock!
255 The method can be called without any instance or on a specified Git repository
256 (in that case the command will be run in the repository context).
258 In scalar context, it returns all the command output in a single string
259 (verbatim).
261 In array context, it returns an array containing lines printed to the
262 command's stdout (without trailing newlines).
264 In both cases, the command's stdin and stderr are the same as the caller's.
266 =cut
268 sub command {
269 my ($fh, $ctx) = command_output_pipe(@_);
271 if (not defined wantarray) {
272 # Nothing to pepper the possible exception with.
273 _cmd_close($ctx, $fh);
275 } elsif (not wantarray) {
276 local $/;
277 my $text = <$fh>;
278 try {
279 _cmd_close($ctx, $fh);
280 } catch Git::Error::Command with {
281 # Pepper with the output:
282 my $E = shift;
283 $E->{'-outputref'} = \$text;
284 throw $E;
286 return $text;
288 } else {
289 my @lines = <$fh>;
290 defined and chomp for @lines;
291 try {
292 _cmd_close($ctx, $fh);
293 } catch Git::Error::Command with {
294 my $E = shift;
295 $E->{'-outputref'} = \@lines;
296 throw $E;
298 return @lines;
303 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
305 =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
307 Execute the given C<COMMAND> in the same way as command()
308 does but always return a scalar string containing the first line
309 of the command's standard output.
311 =cut
313 sub command_oneline {
314 my ($fh, $ctx) = command_output_pipe(@_);
316 my $line = <$fh>;
317 defined $line and chomp $line;
318 try {
319 _cmd_close($ctx, $fh);
320 } catch Git::Error::Command with {
321 # Pepper with the output:
322 my $E = shift;
323 $E->{'-outputref'} = \$line;
324 throw $E;
326 return $line;
330 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
332 =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
334 Execute the given C<COMMAND> in the same way as command()
335 does but return a pipe filehandle from which the command output can be
336 read.
338 The function can return C<($pipe, $ctx)> in array context.
339 See C<command_close_pipe()> for details.
341 =cut
343 sub command_output_pipe {
344 _command_common_pipe('-|', @_);
348 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
350 =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
352 Execute the given C<COMMAND> in the same way as command_output_pipe()
353 does but return an input pipe filehandle instead; the command output
354 is not captured.
356 The function can return C<($pipe, $ctx)> in array context.
357 See C<command_close_pipe()> for details.
359 =cut
361 sub command_input_pipe {
362 _command_common_pipe('|-', @_);
366 =item command_close_pipe ( PIPE [, CTX ] )
368 Close the C<PIPE> as returned from C<command_*_pipe()>, checking
369 whether the command finished successfully. The optional C<CTX> argument
370 is required if you want to see the command name in the error message,
371 and it is the second value returned by C<command_*_pipe()> when
372 called in array context. The call idiom is:
374 my ($fh, $ctx) = $r->command_output_pipe('status');
375 while (<$fh>) { ... }
376 $r->command_close_pipe($fh, $ctx);
378 Note that you should not rely on whatever actually is in C<CTX>;
379 currently it is simply the command name but in future the context might
380 have more complicated structure.
382 =cut
384 sub command_close_pipe {
385 my ($self, $fh, $ctx) = _maybe_self(@_);
386 $ctx ||= '<unknown>';
387 _cmd_close($ctx, $fh);
390 =item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
392 Execute the given C<COMMAND> in the same way as command_output_pipe()
393 does but return both an input pipe filehandle and an output pipe filehandle.
395 The function will return return C<($pid, $pipe_in, $pipe_out, $ctx)>.
396 See C<command_close_bidi_pipe()> for details.
398 =cut
400 sub command_bidi_pipe {
401 my ($pid, $in, $out);
402 my ($self) = _maybe_self(@_);
403 local %ENV = %ENV;
404 my $cwd_save = undef;
405 if ($self) {
406 shift;
407 $cwd_save = cwd();
408 _setup_git_cmd_env($self);
410 $pid = open2($in, $out, 'git', @_);
411 chdir($cwd_save) if $cwd_save;
412 return ($pid, $in, $out, join(' ', @_));
415 =item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
417 Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
418 checking whether the command finished successfully. The optional C<CTX>
419 argument is required if you want to see the command name in the error message,
420 and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
423 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
424 print $out "000000000\n";
425 while (<$in>) { ... }
426 $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
428 Note that you should not rely on whatever actually is in C<CTX>;
429 currently it is simply the command name but in future the context might
430 have more complicated structure.
432 C<PIPE_IN> and C<PIPE_OUT> may be C<undef> if they have been closed prior to
433 calling this function. This may be useful in a query-response type of
434 commands where caller first writes a query and later reads response, eg:
436 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
437 print $out "000000000\n";
438 close $out;
439 while (<$in>) { ... }
440 $r->command_close_bidi_pipe($pid, $in, undef, $ctx);
442 This idiom may prevent potential dead locks caused by data sent to the output
443 pipe not being flushed and thus not reaching the executed command.
445 =cut
447 sub command_close_bidi_pipe {
448 local $?;
449 my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_);
450 _cmd_close($ctx, (grep { defined } ($in, $out)));
451 waitpid $pid, 0;
452 if ($? >> 8) {
453 throw Git::Error::Command($ctx, $? >>8);
458 =item command_noisy ( COMMAND [, ARGUMENTS... ] )
460 Execute the given C<COMMAND> in the same way as command() does but do not
461 capture the command output - the standard output is not redirected and goes
462 to the standard output of the caller application.
464 While the method is called command_noisy(), you might want to as well use
465 it for the most silent Git commands which you know will never pollute your
466 stdout but you want to avoid the overhead of the pipe setup when calling them.
468 The function returns only after the command has finished running.
470 =cut
472 sub command_noisy {
473 my ($self, $cmd, @args) = _maybe_self(@_);
474 _check_valid_cmd($cmd);
476 my $pid = fork;
477 if (not defined $pid) {
478 throw Error::Simple("fork failed: $!");
479 } elsif ($pid == 0) {
480 _cmd_exec($self, $cmd, @args);
482 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
483 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
488 =item version ()
490 Return the Git version in use.
492 =cut
494 sub version {
495 my $verstr = command_oneline('--version');
496 $verstr =~ s/^git version //;
497 $verstr;
501 =item exec_path ()
503 Return path to the Git sub-command executables (the same as
504 C<git --exec-path>). Useful mostly only internally.
506 =cut
508 sub exec_path { command_oneline('--exec-path') }
511 =item html_path ()
513 Return path to the Git html documentation (the same as
514 C<git --html-path>). Useful mostly only internally.
516 =cut
518 sub html_path { command_oneline('--html-path') }
521 =item get_tz_offset ( TIME )
523 Return the time zone offset from GMT in the form +/-HHMM where HH is
524 the number of hours from GMT and MM is the number of minutes. This is
525 the equivalent of what strftime("%z", ...) would provide on a GNU
526 platform.
528 If TIME is not supplied, the current local time is used.
530 =cut
532 sub get_tz_offset {
533 # some systmes don't handle or mishandle %z, so be creative.
534 my $t = shift || time;
535 my $gm = timegm(localtime($t));
536 my $sign = qw( + + - )[ $gm <=> $t ];
537 return sprintf("%s%02d%02d", $sign, (gmtime(abs($t - $gm)))[2,1]);
541 =item prompt ( PROMPT , ISPASSWORD )
543 Query user C<PROMPT> and return answer from user.
545 Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
546 the user. If no *_ASKPASS variable is set or an error occoured,
547 the terminal is tried as a fallback.
548 If C<ISPASSWORD> is set and true, the terminal disables echo.
550 =cut
552 sub prompt {
553 my ($prompt, $isPassword) = @_;
554 my $ret;
555 if (exists $ENV{'GIT_ASKPASS'}) {
556 $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt);
558 if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
559 $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt);
561 if (!defined $ret) {
562 print STDERR $prompt;
563 STDERR->flush;
564 if (defined $isPassword && $isPassword) {
565 require Term::ReadKey;
566 Term::ReadKey::ReadMode('noecho');
567 $ret = '';
568 while (defined(my $key = Term::ReadKey::ReadKey(0))) {
569 last if $key =~ /[\012\015]/; # \n\r
570 $ret .= $key;
572 Term::ReadKey::ReadMode('restore');
573 print STDERR "\n";
574 STDERR->flush;
575 } else {
576 chomp($ret = <STDIN>);
579 return $ret;
582 sub _prompt {
583 my ($askpass, $prompt) = @_;
584 return unless length $askpass;
585 $prompt =~ s/\n/ /g;
586 my $ret;
587 open my $fh, "-|", $askpass, $prompt or return;
588 $ret = <$fh>;
589 $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
590 close ($fh);
591 return $ret;
594 =item repo_path ()
596 Return path to the git repository. Must be called on a repository instance.
598 =cut
600 sub repo_path { $_[0]->{opts}->{Repository} }
603 =item wc_path ()
605 Return path to the working copy. Must be called on a repository instance.
607 =cut
609 sub wc_path { $_[0]->{opts}->{WorkingCopy} }
612 =item wc_subdir ()
614 Return path to the subdirectory inside of a working copy. Must be called
615 on a repository instance.
617 =cut
619 sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
622 =item wc_chdir ( SUBDIR )
624 Change the working copy subdirectory to work within. The C<SUBDIR> is
625 relative to the working copy root directory (not the current subdirectory).
626 Must be called on a repository instance attached to a working copy
627 and the directory must exist.
629 =cut
631 sub wc_chdir {
632 my ($self, $subdir) = @_;
633 $self->wc_path()
634 or throw Error::Simple("bare repository");
636 -d $self->wc_path().'/'.$subdir
637 or throw Error::Simple("subdir not found: $subdir $!");
638 # Of course we will not "hold" the subdirectory so anyone
639 # can delete it now and we will never know. But at least we tried.
641 $self->{opts}->{WorkingSubdir} = $subdir;
645 =item config ( VARIABLE )
647 Retrieve the configuration C<VARIABLE> in the same manner as C<config>
648 does. In scalar context requires the variable to be set only one time
649 (exception is thrown otherwise), in array context returns allows the
650 variable to be set multiple times and returns all the values.
652 =cut
654 sub config {
655 return _config_common({}, @_);
659 =item config_bool ( VARIABLE )
661 Retrieve the bool configuration C<VARIABLE>. The return value
662 is usable as a boolean in perl (and C<undef> if it's not defined,
663 of course).
665 =cut
667 sub config_bool {
668 my $val = scalar _config_common({'kind' => '--bool'}, @_);
670 # Do not rewrite this as return (defined $val && $val eq 'true')
671 # as some callers do care what kind of falsehood they receive.
672 if (!defined $val) {
673 return undef;
674 } else {
675 return $val eq 'true';
680 =item config_path ( VARIABLE )
682 Retrieve the path configuration C<VARIABLE>. The return value
683 is an expanded path or C<undef> if it's not defined.
685 =cut
687 sub config_path {
688 return _config_common({'kind' => '--path'}, @_);
692 =item config_int ( VARIABLE )
694 Retrieve the integer configuration C<VARIABLE>. The return value
695 is simple decimal number. An optional value suffix of 'k', 'm',
696 or 'g' in the config file will cause the value to be multiplied
697 by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
698 It would return C<undef> if configuration variable is not defined,
700 =cut
702 sub config_int {
703 return scalar _config_common({'kind' => '--int'}, @_);
706 # Common subroutine to implement bulk of what the config* family of methods
707 # do. This curently wraps command('config') so it is not so fast.
708 sub _config_common {
709 my ($opts) = shift @_;
710 my ($self, $var) = _maybe_self(@_);
712 try {
713 my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ());
714 unshift @cmd, $self if $self;
715 if (wantarray) {
716 return command(@cmd, '--get-all', $var);
717 } else {
718 return command_oneline(@cmd, '--get', $var);
720 } catch Git::Error::Command with {
721 my $E = shift;
722 if ($E->value() == 1) {
723 # Key not found.
724 return;
725 } else {
726 throw $E;
731 =item get_colorbool ( NAME )
733 Finds if color should be used for NAMEd operation from the configuration,
734 and returns boolean (true for "use color", false for "do not use color").
736 =cut
738 sub get_colorbool {
739 my ($self, $var) = @_;
740 my $stdout_to_tty = (-t STDOUT) ? "true" : "false";
741 my $use_color = $self->command_oneline('config', '--get-colorbool',
742 $var, $stdout_to_tty);
743 return ($use_color eq 'true');
746 =item get_color ( SLOT, COLOR )
748 Finds color for SLOT from the configuration, while defaulting to COLOR,
749 and returns the ANSI color escape sequence:
751 print $repo->get_color("color.interactive.prompt", "underline blue white");
752 print "some text";
753 print $repo->get_color("", "normal");
755 =cut
757 sub get_color {
758 my ($self, $slot, $default) = @_;
759 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
760 if (!defined $color) {
761 $color = "";
763 return $color;
766 =item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
768 This function returns a hashref of refs stored in a given remote repository.
769 The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
770 contains the tag object while a C<refname^{}> entry gives the tagged objects.
772 C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
773 argument; either a URL or a remote name (if called on a repository instance).
774 C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
775 tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
776 of strings containing a shell-like glob to further limit the refs returned in
777 the hash; the meaning is again the same as the appropriate C<git-ls-remote>
778 argument.
780 This function may or may not be called on a repository instance. In the former
781 case, remote names as defined in the repository are recognized as repository
782 specifiers.
784 =cut
786 sub remote_refs {
787 my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
788 my @args;
789 if (ref $groups eq 'ARRAY') {
790 foreach (@$groups) {
791 if ($_ eq 'heads') {
792 push (@args, '--heads');
793 } elsif ($_ eq 'tags') {
794 push (@args, '--tags');
795 } else {
796 # Ignore unknown groups for future
797 # compatibility
801 push (@args, $repo);
802 if (ref $refglobs eq 'ARRAY') {
803 push (@args, @$refglobs);
806 my @self = $self ? ($self) : (); # Ultra trickery
807 my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
808 my %refs;
809 while (<$fh>) {
810 chomp;
811 my ($hash, $ref) = split(/\t/, $_, 2);
812 $refs{$ref} = $hash;
814 Git::command_close_pipe(@self, $fh, $ctx);
815 return \%refs;
819 =item ident ( TYPE | IDENTSTR )
821 =item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
823 This suite of functions retrieves and parses ident information, as stored
824 in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
825 C<TYPE> can be either I<author> or I<committer>; case is insignificant).
827 The C<ident> method retrieves the ident information from C<git var>
828 and either returns it as a scalar string or as an array with the fields parsed.
829 Alternatively, it can take a prepared ident string (e.g. from the commit
830 object) and just parse it.
832 C<ident_person> returns the person part of the ident - name and email;
833 it can take the same arguments as C<ident> or the array returned by C<ident>.
835 The synopsis is like:
837 my ($name, $email, $time_tz) = ident('author');
838 "$name <$email>" eq ident_person('author');
839 "$name <$email>" eq ident_person($name);
840 $time_tz =~ /^\d+ [+-]\d{4}$/;
842 =cut
844 sub ident {
845 my ($self, $type) = _maybe_self(@_);
846 my $identstr;
847 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
848 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
849 unshift @cmd, $self if $self;
850 $identstr = command_oneline(@cmd);
851 } else {
852 $identstr = $type;
854 if (wantarray) {
855 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
856 } else {
857 return $identstr;
861 sub ident_person {
862 my ($self, @ident) = _maybe_self(@_);
863 $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
864 return "$ident[0] <$ident[1]>";
868 =item hash_object ( TYPE, FILENAME )
870 Compute the SHA1 object id of the given C<FILENAME> considering it is
871 of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
873 The method can be called without any instance or on a specified Git repository,
874 it makes zero difference.
876 The function returns the SHA1 hash.
878 =cut
880 # TODO: Support for passing FILEHANDLE instead of FILENAME
881 sub hash_object {
882 my ($self, $type, $file) = _maybe_self(@_);
883 command_oneline('hash-object', '-t', $type, $file);
887 =item hash_and_insert_object ( FILENAME )
889 Compute the SHA1 object id of the given C<FILENAME> and add the object to the
890 object database.
892 The function returns the SHA1 hash.
894 =cut
896 # TODO: Support for passing FILEHANDLE instead of FILENAME
897 sub hash_and_insert_object {
898 my ($self, $filename) = @_;
900 carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
902 $self->_open_hash_and_insert_object_if_needed();
903 my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
905 unless (print $out $filename, "\n") {
906 $self->_close_hash_and_insert_object();
907 throw Error::Simple("out pipe went bad");
910 chomp(my $hash = <$in>);
911 unless (defined($hash)) {
912 $self->_close_hash_and_insert_object();
913 throw Error::Simple("in pipe went bad");
916 return $hash;
919 sub _open_hash_and_insert_object_if_needed {
920 my ($self) = @_;
922 return if defined($self->{hash_object_pid});
924 ($self->{hash_object_pid}, $self->{hash_object_in},
925 $self->{hash_object_out}, $self->{hash_object_ctx}) =
926 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
929 sub _close_hash_and_insert_object {
930 my ($self) = @_;
932 return unless defined($self->{hash_object_pid});
934 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
936 command_close_bidi_pipe(@$self{@vars});
937 delete @$self{@vars};
940 =item cat_blob ( SHA1, FILEHANDLE )
942 Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
943 returns the number of bytes printed.
945 =cut
947 sub cat_blob {
948 my ($self, $sha1, $fh) = @_;
950 $self->_open_cat_blob_if_needed();
951 my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
953 unless (print $out $sha1, "\n") {
954 $self->_close_cat_blob();
955 throw Error::Simple("out pipe went bad");
958 my $description = <$in>;
959 if ($description =~ / missing$/) {
960 carp "$sha1 doesn't exist in the repository";
961 return -1;
964 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
965 carp "Unexpected result returned from git cat-file";
966 return -1;
969 my $size = $1;
971 my $blob;
972 my $bytesLeft = $size;
974 while (1) {
975 last unless $bytesLeft;
977 my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024;
978 my $read = read($in, $blob, $bytesToRead);
979 unless (defined($read)) {
980 $self->_close_cat_blob();
981 throw Error::Simple("in pipe went bad");
983 unless (print $fh $blob) {
984 $self->_close_cat_blob();
985 throw Error::Simple("couldn't write to passed in filehandle");
987 $bytesLeft -= $read;
990 # Skip past the trailing newline.
991 my $newline;
992 my $read = read($in, $newline, 1);
993 unless (defined($read)) {
994 $self->_close_cat_blob();
995 throw Error::Simple("in pipe went bad");
997 unless ($read == 1 && $newline eq "\n") {
998 $self->_close_cat_blob();
999 throw Error::Simple("didn't find newline after blob");
1002 return $size;
1005 sub _open_cat_blob_if_needed {
1006 my ($self) = @_;
1008 return if defined($self->{cat_blob_pid});
1010 ($self->{cat_blob_pid}, $self->{cat_blob_in},
1011 $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
1012 $self->command_bidi_pipe(qw(cat-file --batch));
1015 sub _close_cat_blob {
1016 my ($self) = @_;
1018 return unless defined($self->{cat_blob_pid});
1020 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
1022 command_close_bidi_pipe(@$self{@vars});
1023 delete @$self{@vars};
1027 =item credential_read( FILEHANDLE )
1029 Reads credential key-value pairs from C<FILEHANDLE>. Reading stops at EOF or
1030 when an empty line is encountered. Each line must be of the form C<key=value>
1031 with a non-empty key. Function returns hash with all read values. Any white
1032 space (other than new-line character) is preserved.
1034 =cut
1036 sub credential_read {
1037 my ($self, $reader) = _maybe_self(@_);
1038 my %credential;
1039 while (<$reader>) {
1040 chomp;
1041 if ($_ eq '') {
1042 last;
1043 } elsif (!/^([^=]+)=(.*)$/) {
1044 throw Error::Simple("unable to parse git credential data:\n$_");
1046 $credential{$1} = $2;
1048 return %credential;
1051 =item credential_write( FILEHANDLE, CREDENTIAL_HASHREF )
1053 Writes credential key-value pairs from hash referenced by
1054 C<CREDENTIAL_HASHREF> to C<FILEHANDLE>. Keys and values cannot contain
1055 new-lines or NUL bytes characters, and key cannot contain equal signs nor be
1056 empty (if they do Error::Simple is thrown). Any white space is preserved. If
1057 value for a key is C<undef>, it will be skipped.
1059 If C<'url'> key exists it will be written first. (All the other key-value
1060 pairs are written in sorted order but you should not depend on that). Once
1061 all lines are written, an empty line is printed.
1063 =cut
1065 sub credential_write {
1066 my ($self, $writer, $credential) = _maybe_self(@_);
1067 my ($key, $value);
1069 # Check if $credential is valid prior to writing anything
1070 while (($key, $value) = each %$credential) {
1071 if (!defined $key || !length $key) {
1072 throw Error::Simple("credential key empty or undefined");
1073 } elsif ($key =~ /[=\n\0]/) {
1074 throw Error::Simple("credential key contains invalid characters: $key");
1075 } elsif (defined $value && $value =~ /[\n\0]/) {
1076 throw Error::Simple("credential value for key=$key contains invalid characters: $value");
1080 for $key (sort {
1081 # url overwrites other fields, so it must come first
1082 return -1 if $a eq 'url';
1083 return 1 if $b eq 'url';
1084 return $a cmp $b;
1085 } keys %$credential) {
1086 if (defined $credential->{$key}) {
1087 print $writer $key, '=', $credential->{$key}, "\n";
1090 print $writer "\n";
1093 sub _credential_run {
1094 my ($self, $credential, $op) = _maybe_self(@_);
1095 my ($pid, $reader, $writer, $ctx) = command_bidi_pipe('credential', $op);
1097 credential_write $writer, $credential;
1098 close $writer;
1100 if ($op eq "fill") {
1101 %$credential = credential_read $reader;
1103 if (<$reader>) {
1104 throw Error::Simple("unexpected output from git credential $op response:\n$_\n");
1107 command_close_bidi_pipe($pid, $reader, undef, $ctx);
1110 =item credential( CREDENTIAL_HASHREF [, OPERATION ] )
1112 =item credential( CREDENTIAL_HASHREF, CODE )
1114 Executes C<git credential> for a given set of credentials and specified
1115 operation. In both forms C<CREDENTIAL_HASHREF> needs to be a reference to
1116 a hash which stores credentials. Under certain conditions the hash can
1117 change.
1119 In the first form, C<OPERATION> can be C<'fill'>, C<'approve'> or C<'reject'>,
1120 and function will execute corresponding C<git credential> sub-command. If
1121 it's omitted C<'fill'> is assumed. In case of C<'fill'> the values stored in
1122 C<CREDENTIAL_HASHREF> will be changed to the ones returned by the C<git
1123 credential fill> command. The usual usage would look something like:
1125 my %cred = (
1126 'protocol' => 'https',
1127 'host' => 'example.com',
1128 'username' => 'bob'
1130 Git::credential \%cred;
1131 if (try_to_authenticate($cred{'username'}, $cred{'password'})) {
1132 Git::credential \%cred, 'approve';
1133 ... do more stuff ...
1134 } else {
1135 Git::credential \%cred, 'reject';
1138 In the second form, C<CODE> needs to be a reference to a subroutine. The
1139 function will execute C<git credential fill> to fill the provided credential
1140 hash, then call C<CODE> with C<CREDENTIAL_HASHREF> as the sole argument. If
1141 C<CODE>'s return value is defined, the function will execute C<git credential
1142 approve> (if return value yields true) or C<git credential reject> (if return
1143 value is false). If the return value is undef, nothing at all is executed;
1144 this is useful, for example, if the credential could neither be verified nor
1145 rejected due to an unrelated network error. The return value is the same as
1146 what C<CODE> returns. With this form, the usage might look as follows:
1148 if (Git::credential {
1149 'protocol' => 'https',
1150 'host' => 'example.com',
1151 'username' => 'bob'
1152 }, sub {
1153 my $cred = shift;
1154 return !!try_to_authenticate($cred->{'username'},
1155 $cred->{'password'});
1156 }) {
1157 ... do more stuff ...
1160 =cut
1162 sub credential {
1163 my ($self, $credential, $op_or_code) = (_maybe_self(@_), 'fill');
1165 if ('CODE' eq ref $op_or_code) {
1166 _credential_run $credential, 'fill';
1167 my $ret = $op_or_code->($credential);
1168 if (defined $ret) {
1169 _credential_run $credential, $ret ? 'approve' : 'reject';
1171 return $ret;
1172 } else {
1173 _credential_run $credential, $op_or_code;
1177 { # %TEMP_* Lexical Context
1179 my (%TEMP_FILEMAP, %TEMP_FILES);
1181 =item temp_acquire ( NAME )
1183 Attempts to retrieve the temporary file mapped to the string C<NAME>. If an
1184 associated temp file has not been created this session or was closed, it is
1185 created, cached, and set for autoflush and binmode.
1187 Internally locks the file mapped to C<NAME>. This lock must be released with
1188 C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1189 to retrieve temporary files mapped to the same C<NAME> while still locked will
1190 cause an error. This locking mechanism provides a weak guarantee and is not
1191 threadsafe. It does provide some error checking to help prevent temp file refs
1192 writing over one another.
1194 In general, the L<File::Handle> returned should not be closed by consumers as
1195 it defeats the purpose of this caching mechanism. If you need to close the temp
1196 file handle, then you should use L<File::Temp> or another temp file faculty
1197 directly. If a handle is closed and then requested again, then a warning will
1198 issue.
1200 =cut
1202 sub temp_acquire {
1203 my $temp_fd = _temp_cache(@_);
1205 $TEMP_FILES{$temp_fd}{locked} = 1;
1206 $temp_fd;
1209 =item temp_release ( NAME )
1211 =item temp_release ( FILEHANDLE )
1213 Releases a lock acquired through C<temp_acquire()>. Can be called either with
1214 the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1215 referencing a locked temp file.
1217 Warns if an attempt is made to release a file that is not locked.
1219 The temp file will be truncated before being released. This can help to reduce
1220 disk I/O where the system is smart enough to detect the truncation while data
1221 is in the output buffers. Beware that after the temp file is released and
1222 truncated, any operations on that file may fail miserably until it is
1223 re-acquired. All contents are lost between each release and acquire mapped to
1224 the same string.
1226 =cut
1228 sub temp_release {
1229 my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1231 if (exists $TEMP_FILEMAP{$temp_fd}) {
1232 $temp_fd = $TEMP_FILES{$temp_fd};
1234 unless ($TEMP_FILES{$temp_fd}{locked}) {
1235 carp "Attempt to release temp file '",
1236 $temp_fd, "' that has not been locked";
1238 temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1240 $TEMP_FILES{$temp_fd}{locked} = 0;
1241 undef;
1244 sub _temp_cache {
1245 my ($self, $name) = _maybe_self(@_);
1247 _verify_require();
1249 my $temp_fd = \$TEMP_FILEMAP{$name};
1250 if (defined $$temp_fd and $$temp_fd->opened) {
1251 if ($TEMP_FILES{$$temp_fd}{locked}) {
1252 throw Error::Simple("Temp file with moniker '" .
1253 $name . "' already in use");
1255 } else {
1256 if (defined $$temp_fd) {
1257 # then we're here because of a closed handle.
1258 carp "Temp file '", $name,
1259 "' was closed. Opening replacement.";
1261 my $fname;
1263 my $tmpdir;
1264 if (defined $self) {
1265 $tmpdir = $self->repo_path();
1268 ($$temp_fd, $fname) = File::Temp::tempfile(
1269 'Git_XXXXXX', UNLINK => 1, DIR => $tmpdir,
1270 ) or throw Error::Simple("couldn't open new temp file");
1272 $$temp_fd->autoflush;
1273 binmode $$temp_fd;
1274 $TEMP_FILES{$$temp_fd}{fname} = $fname;
1276 $$temp_fd;
1279 sub _verify_require {
1280 eval { require File::Temp; require File::Spec; };
1281 $@ and throw Error::Simple($@);
1284 =item temp_reset ( FILEHANDLE )
1286 Truncates and resets the position of the C<FILEHANDLE>.
1288 =cut
1290 sub temp_reset {
1291 my ($self, $temp_fd) = _maybe_self(@_);
1293 truncate $temp_fd, 0
1294 or throw Error::Simple("couldn't truncate file");
1295 sysseek($temp_fd, 0, SEEK_SET) and seek($temp_fd, 0, SEEK_SET)
1296 or throw Error::Simple("couldn't seek to beginning of file");
1297 sysseek($temp_fd, 0, SEEK_CUR) == 0 and tell($temp_fd) == 0
1298 or throw Error::Simple("expected file position to be reset");
1301 =item temp_path ( NAME )
1303 =item temp_path ( FILEHANDLE )
1305 Returns the filename associated with the given tempfile.
1307 =cut
1309 sub temp_path {
1310 my ($self, $temp_fd) = _maybe_self(@_);
1312 if (exists $TEMP_FILEMAP{$temp_fd}) {
1313 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1315 $TEMP_FILES{$temp_fd}{fname};
1318 sub END {
1319 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
1322 } # %TEMP_* Lexical Context
1324 =back
1326 =head1 ERROR HANDLING
1328 All functions are supposed to throw Perl exceptions in case of errors.
1329 See the L<Error> module on how to catch those. Most exceptions are mere
1330 L<Error::Simple> instances.
1332 However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1333 functions suite can throw C<Git::Error::Command> exceptions as well: those are
1334 thrown when the external command returns an error code and contain the error
1335 code as well as access to the captured command's output. The exception class
1336 provides the usual C<stringify> and C<value> (command's exit code) methods and
1337 in addition also a C<cmd_output> method that returns either an array or a
1338 string with the captured command output (depending on the original function
1339 call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1340 returns the command and its arguments (but without proper quoting).
1342 Note that the C<command_*_pipe()> functions cannot throw this exception since
1343 it has no idea whether the command failed or not. You will only find out
1344 at the time you C<close> the pipe; if you want to have that automated,
1345 use C<command_close_pipe()>, which can throw the exception.
1347 =cut
1350 package Git::Error::Command;
1352 @Git::Error::Command::ISA = qw(Error);
1354 sub new {
1355 my $self = shift;
1356 my $cmdline = '' . shift;
1357 my $value = 0 + shift;
1358 my $outputref = shift;
1359 my(@args) = ();
1361 local $Error::Depth = $Error::Depth + 1;
1363 push(@args, '-cmdline', $cmdline);
1364 push(@args, '-value', $value);
1365 push(@args, '-outputref', $outputref);
1367 $self->SUPER::new(-text => 'command returned error', @args);
1370 sub stringify {
1371 my $self = shift;
1372 my $text = $self->SUPER::stringify;
1373 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1376 sub cmdline {
1377 my $self = shift;
1378 $self->{'-cmdline'};
1381 sub cmd_output {
1382 my $self = shift;
1383 my $ref = $self->{'-outputref'};
1384 defined $ref or undef;
1385 if (ref $ref eq 'ARRAY') {
1386 return @$ref;
1387 } else { # SCALAR
1388 return $$ref;
1393 =over 4
1395 =item git_cmd_try { CODE } ERRMSG
1397 This magical statement will automatically catch any C<Git::Error::Command>
1398 exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1399 on its lips; the message will have %s substituted for the command line
1400 and %d for the exit status. This statement is useful mostly for producing
1401 more user-friendly error messages.
1403 In case of no exception caught the statement returns C<CODE>'s return value.
1405 Note that this is the only auto-exported function.
1407 =cut
1409 sub git_cmd_try(&$) {
1410 my ($code, $errmsg) = @_;
1411 my @result;
1412 my $err;
1413 my $array = wantarray;
1414 try {
1415 if ($array) {
1416 @result = &$code;
1417 } else {
1418 $result[0] = &$code;
1420 } catch Git::Error::Command with {
1421 my $E = shift;
1422 $err = $errmsg;
1423 $err =~ s/\%s/$E->cmdline()/ge;
1424 $err =~ s/\%d/$E->value()/ge;
1425 # We can't croak here since Error.pm would mangle
1426 # that to Error::Simple.
1428 $err and croak $err;
1429 return $array ? @result : $result[0];
1433 =back
1435 =head1 COPYRIGHT
1437 Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1439 This module is free software; it may be used, copied, modified
1440 and distributed under the terms of the GNU General Public Licence,
1441 either version 2, or (at your option) any later version.
1443 =cut
1446 # Take raw method argument list and return ($obj, @args) in case
1447 # the method was called upon an instance and (undef, @args) if
1448 # it was called directly.
1449 sub _maybe_self {
1450 UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
1453 # Check if the command id is something reasonable.
1454 sub _check_valid_cmd {
1455 my ($cmd) = @_;
1456 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1459 # Common backend for the pipe creators.
1460 sub _command_common_pipe {
1461 my $direction = shift;
1462 my ($self, @p) = _maybe_self(@_);
1463 my (%opts, $cmd, @args);
1464 if (ref $p[0]) {
1465 ($cmd, @args) = @{shift @p};
1466 %opts = ref $p[0] ? %{$p[0]} : @p;
1467 } else {
1468 ($cmd, @args) = @p;
1470 _check_valid_cmd($cmd);
1472 my $fh;
1473 if ($^O eq 'MSWin32') {
1474 # ActiveState Perl
1475 #defined $opts{STDERR} and
1476 # warn 'ignoring STDERR option - running w/ ActiveState';
1477 $direction eq '-|' or
1478 die 'input pipe for ActiveState not implemented';
1479 # the strange construction with *ACPIPE is just to
1480 # explain the tie below that we want to bind to
1481 # a handle class, not scalar. It is not known if
1482 # it is something specific to ActiveState Perl or
1483 # just a Perl quirk.
1484 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
1485 $fh = *ACPIPE;
1487 } else {
1488 my $pid = open($fh, $direction);
1489 if (not defined $pid) {
1490 throw Error::Simple("open failed: $!");
1491 } elsif ($pid == 0) {
1492 if ($opts{STDERR}) {
1493 open (STDERR, '>&', $opts{STDERR})
1494 or die "dup failed: $!";
1495 } elsif (defined $opts{STDERR}) {
1496 open (STDERR, '>', '/dev/null')
1497 or die "opening /dev/null failed: $!";
1499 _cmd_exec($self, $cmd, @args);
1502 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1505 # When already in the subprocess, set up the appropriate state
1506 # for the given repository and execute the git command.
1507 sub _cmd_exec {
1508 my ($self, @args) = @_;
1509 _setup_git_cmd_env($self);
1510 _execv_git_cmd(@args);
1511 die qq[exec "@args" failed: $!];
1514 # set up the appropriate state for git command
1515 sub _setup_git_cmd_env {
1516 my $self = shift;
1517 if ($self) {
1518 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
1519 $self->repo_path() and $self->wc_path()
1520 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
1521 $self->wc_path() and chdir($self->wc_path());
1522 $self->wc_subdir() and chdir($self->wc_subdir());
1526 # Execute the given Git command ($_[0]) with arguments ($_[1..])
1527 # by searching for it at proper places.
1528 sub _execv_git_cmd { exec('git', @_); }
1530 # Close pipe to a subprocess.
1531 sub _cmd_close {
1532 my $ctx = shift @_;
1533 foreach my $fh (@_) {
1534 if (close $fh) {
1535 # nop
1536 } elsif ($!) {
1537 # It's just close, no point in fatalities
1538 carp "error closing pipe: $!";
1539 } elsif ($? >> 8) {
1540 # The caller should pepper this.
1541 throw Git::Error::Command($ctx, $? >> 8);
1543 # else we might e.g. closed a live stream; the command
1544 # dying of SIGPIPE would drive us here.
1549 sub DESTROY {
1550 my ($self) = @_;
1551 $self->_close_hash_and_insert_object();
1552 $self->_close_cat_blob();
1556 # Pipe implementation for ActiveState Perl.
1558 package Git::activestate_pipe;
1559 use strict;
1561 sub TIEHANDLE {
1562 my ($class, @params) = @_;
1563 # FIXME: This is probably horrible idea and the thing will explode
1564 # at the moment you give it arguments that require some quoting,
1565 # but I have no ActiveState clue... --pasky
1566 # Let's just hope ActiveState Perl does at least the quoting
1567 # correctly.
1568 my @data = qx{git @params};
1569 bless { i => 0, data => \@data }, $class;
1572 sub READLINE {
1573 my $self = shift;
1574 if ($self->{i} >= scalar @{$self->{data}}) {
1575 return undef;
1577 my $i = $self->{i};
1578 if (wantarray) {
1579 $self->{i} = $#{$self->{'data'}} + 1;
1580 return splice(@{$self->{'data'}}, $i);
1582 $self->{i} = $i + 1;
1583 return $self->{'data'}->[ $i ];
1586 sub CLOSE {
1587 my $self = shift;
1588 delete $self->{data};
1589 delete $self->{i};
1592 sub EOF {
1593 my $self = shift;
1594 return ($self->{i} >= scalar @{$self->{data}});
1598 1; # Famous last words