7 IO::File - supply object methods for filehandles
14 if ($fh->open("< file")) {
19 $fh = new IO::File "> file";
25 $fh = new IO::File "file", "r";
28 undef $fh; # automatically closes the file
31 $fh = new IO::File "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 a 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 C<open> accepts one, two or three parameters. With one parameter,
75 it is just a front end for the built-in C<open> function. With two or three
76 parameters, the first parameter is a filename that may include
77 whitespace or other special characters, and the second parameter is
78 the open mode, optionally followed by a file permission value.
80 If C<IO::File::open> receives a Perl mode string ("E<gt>", "+E<lt>", etc.)
81 or a ANSI C fopen() mode string ("w", "r+", etc.), it uses the basic
82 Perl C<open> operator (but protects any special characters).
84 If C<IO::File::open> is given a numeric mode, it passes that mode
85 and the optional permissions value to the Perl C<sysopen> operator.
86 The permissions default to 0666.
88 For convenience, C<IO::File> exports the O_XXX constants from the
89 Fcntl module, if this module is available.
96 L<perlop/"I/O Operators">,
102 Derived from FileHandle.pm by Graham Barr E<lt>F<gbarr@pobox.com>E<gt>.
108 use vars qw($VERSION @EXPORT @EXPORT_OK @ISA);
118 @ISA = qw(IO::Handle IO::Seekable Exporter DynaLoader);
122 @EXPORT = @IO::Seekable::EXPORT;
125 # Make all Fcntl O_XXX constants available for importing
127 my @O = grep /^O_/, @Fcntl::EXPORT;
128 Fcntl->import(@O); # first we import what we want to export
132 ################################################
138 my $class = ref($type) || $type || "IO::File";
140 or croak "usage: new $class [FILENAME [,MODE [,PERMS]]]";
141 my $fh = $class->SUPER::new();
149 ################################################
154 @_ >= 2 && @_ <= 4 or croak 'usage: $fh->open(FILENAME [,MODE [,PERMS]])';
155 my ($fh, $file) = @_;
157 my ($mode, $perms) = @_[2, 3];
158 if ($mode =~ /^\d+$/) {
159 defined $perms or $perms = 0666;
160 return sysopen($fh, $file, $mode, $perms);
162 if (! File::Spec->file_name_is_absolute($file)) {
163 $file = File::Spec->catfile(File::Spec->curdir(),$file);
165 $file = IO::Handle::_open_mode_string($mode) . " $file\0";