7 IO::File - supply object methods for filehandles
13 $fh = IO::File->new();
14 if ($fh->open("< file")) {
19 $fh = IO::File->new("> file");
25 $fh = IO::File->new("file", "r");
28 undef $fh; # automatically closes the file
31 $fh = IO::File->new("file", O_WRONLY|O_APPEND);
38 undef $fh; # automatically closes the file
45 C<IO::File> inherits from C<IO::Handle> and C<IO::Seekable>. It extends
46 these classes with methods that are specific to file handles.
52 =item new ( FILENAME [,MODE [,PERMS]] )
54 Creates an C<IO::File>. If it receives any parameters, they are passed to
55 the method C<open>; if the open fails, the object is destroyed. Otherwise,
56 it is returned to the caller.
60 Creates an C<IO::File> opened for read/write on a newly created temporary
61 file. On systems where this is possible, the temporary file is anonymous
62 (i.e. it is unlinked after creation, but held open). If the temporary
63 file cannot be created or opened, the C<IO::File> object is destroyed.
64 Otherwise, it is returned to the caller.
72 =item open( FILENAME [,MODE [,PERMS]] )
74 =item open( FILENAME, IOLAYERS )
76 C<open> accepts one, two or three parameters. With one parameter,
77 it is just a front end for the built-in C<open> function. With two or three
78 parameters, the first parameter is a filename that may include
79 whitespace or other special characters, and the second parameter is
80 the open mode, optionally followed by a file permission value.
82 If C<IO::File::open> receives a Perl mode string ("E<gt>", "+E<lt>", etc.)
83 or an ANSI C fopen() mode string ("w", "r+", etc.), it uses the basic
84 Perl C<open> operator (but protects any special characters).
86 If C<IO::File::open> is given a numeric mode, it passes that mode
87 and the optional permissions value to the Perl C<sysopen> operator.
88 The permissions default to 0666.
90 If C<IO::File::open> is given a mode that includes the C<:> character,
91 it passes all the three arguments to the three-argument C<open> operator.
93 For convenience, C<IO::File> exports the O_XXX constants from the
94 Fcntl module, if this module is available.
96 =item binmode( [LAYER] )
98 C<binmode> sets C<binmode> on the underlying C<IO> object, as documented
99 in C<perldoc -f binmode>.
101 C<binmode> accepts one optional parameter, which is the layer to be
102 passed on to the C<binmode> call.
108 Some operating systems may perform C<IO::File::new()> or C<IO::File::open()>
109 on a directory without errors. This behavior is not portable and not
110 suggested for use. Using C<opendir()> and C<readdir()> or C<IO::Dir> are
116 L<perlop/"I/O Operators">,
123 Derived from FileHandle.pm by Graham Barr E<lt>F<gbarr@pobox.com>E<gt>.
136 our @ISA = qw(IO::Handle IO::Seekable Exporter);
138 our $VERSION = "1.40";
140 our @EXPORT = @IO::Seekable::EXPORT;
143 # Make all Fcntl O_XXX constants available for importing
145 my @O = grep /^O_/, @Fcntl::EXPORT;
146 Fcntl->import(@O); # first we import what we want to export
150 ################################################
156 my $class = ref($type) || $type || "IO::File";
158 or croak "usage: $class->new([FILENAME [,MODE [,PERMS]]])";
159 my $fh = $class->SUPER::new();
167 ################################################
172 @_ >= 2 && @_ <= 4 or croak 'usage: $fh->open(FILENAME [,MODE [,PERMS]])';
173 my ($fh, $file) = @_;
175 my ($mode, $perms) = @_[2, 3];
176 if ($mode =~ /^\d+$/) {
177 defined $perms or $perms = 0666;
178 return sysopen($fh, $file, $mode, $perms);
179 } elsif ($mode =~ /:/) {
180 return open($fh, $mode, $file) if @_ == 3;
181 croak 'usage: $fh->open(FILENAME, IOLAYERS)';
183 return open($fh, IO::Handle::_open_mode_string($mode), $file);
189 ################################################
194 ( @_ == 1 or @_ == 2 ) or croak 'usage $fh->binmode([LAYER])';
196 my($fh, $layer) = @_;
198 return binmode $$fh unless $layer;
199 return binmode $$fh, $layer;