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.
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.
64 =item open( FILENAME [,MODE [,PERMS]] )
66 C<open> accepts one, two or three parameters. With one parameter,
67 it is just a front end for the built-in C<open> function. With two
68 parameters, the first parameter is a filename that may include
69 whitespace or other special characters, and the second parameter is
70 the open mode, optionally followed by a file permission value.
72 If C<IO::File::open> receives a Perl mode string ("E<gt>", "+E<lt>", etc.)
73 or a POSIX fopen() mode string ("w", "r+", etc.), it uses the basic
74 Perl C<open> operator.
76 If C<IO::File::open> is given a numeric mode, it passes that mode
77 and the optional permissions value to the Perl C<sysopen> operator.
78 For convenience, C<IO::File::import> tries to import the O_XXX
79 constants from the Fcntl module. If dynamic loading is not available,
80 this may fail, but the rest of IO::File will still work.
87 L<perlop/"I/O Operators">,
93 Derived from FileHandle.pm by Graham Barr E<lt>F<bodg@tiuk.ti.com>E<gt>.
99 use vars qw($VERSION @EXPORT @EXPORT_OK $AUTOLOAD @ISA);
103 use IO::Handle qw(_open_mode_string);
109 @ISA = qw(IO::Handle IO::Seekable Exporter DynaLoader);
113 @EXPORT = @IO::Seekable::EXPORT;
117 my $callpkg = caller;
118 Exporter::export $pkg, $callpkg, @_;
121 # If the Fcntl extension is available,
122 # export its constants for sysopen().
126 Exporter::export 'Fcntl', $callpkg, '/^O_/';
131 ################################################
137 my $class = ref($type) || $type || "IO::File";
139 or croak "usage: new $class [FILENAME [,MODE [,PERMS]]]";
140 my $fh = $class->SUPER::new();
148 ################################################
153 @_ >= 2 && @_ <= 4 or croak 'usage: $fh->open(FILENAME [,MODE [,PERMS]])';
154 my ($fh, $file) = @_;
156 my ($mode, $perms) = @_[2, 3];
157 if ($mode =~ /^\d+$/) {
158 defined $perms or $perms = 0666;
159 return sysopen($fh, $file, $mode, $perms);
161 $file = "./" . $file unless $file =~ m#^/#;
162 $file = _open_mode_string($mode) . " $file\0";