Commit | Line | Data |
8add82fc |
1 | # |
2 | |
3 | package IO::Seekable; |
4 | |
5 | =head1 NAME |
6 | |
7 | IO::Seekable - supply seek based methods for I/O objects |
8 | |
9 | =head1 DESCRIPTION |
10 | |
11 | C<IO::Seekable> does not have a constuctor of its own as is intended to |
12 | be inherited by other C<IO::Handle> based objects. It provides methods |
13 | which allow seeking of the file descriptors. |
14 | |
15 | If the C functions fgetpos() and fsetpos() are available, then |
16 | C<IO::File::getpos> returns an opaque value that represents the |
17 | current position of the IO::File, and C<IO::File::setpos> uses |
18 | that value to return to a previously visited position. |
19 | |
20 | See L<perlfunc> for complete descriptions of each of the following |
21 | supported C<IO::Seekable> methods, which are just front ends for the |
22 | corresponding built-in functions: |
23 | |
24 | clearerr |
25 | seek |
26 | tell |
27 | |
28 | =head1 SEE ALSO |
29 | |
30 | L<perlfunc>, |
31 | L<perlop/"I/O Operators">, |
32 | L<"IO::Handle"> |
33 | L<"IO::File"> |
34 | |
35 | =head1 HISTORY |
36 | |
37 | Derived from FileHandle.pm by Graham Barr <bodg@tiuk.ti.com> |
38 | |
39 | =head1 REVISION |
40 | |
41 | $Revision: 1.4 $ |
42 | |
43 | =cut |
44 | |
45 | require 5.000; |
46 | use Carp; |
47 | use vars qw($VERSION @EXPORT @ISA); |
48 | use IO::Handle qw(SEEK_SET SEEK_CUR SEEK_END); |
49 | require Exporter; |
50 | |
51 | @EXPORT = qw(SEEK_SET SEEK_CUR SEEK_END); |
52 | @ISA = qw(Exporter); |
53 | |
54 | $VERSION = sprintf("%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/); |
55 | |
56 | sub clearerr { |
57 | @_ == 1 or croak 'usage: $fh->clearerr()'; |
58 | seek($_[0], 0, SEEK_CUR); |
59 | } |
60 | |
61 | sub seek { |
62 | @_ == 3 or croak 'usage: $fh->seek(POS, WHENCE)'; |
63 | seek($_[0], $_[1], $_[2]); |
64 | } |
65 | |
66 | sub tell { |
67 | @_ == 1 or croak 'usage: $fh->tell()'; |
68 | tell($_[0]); |
69 | } |
70 | |
71 | 1; |