Filename | /usr/local/lib/perl5/5.24/mach/IO/File.pm |
Statements | Executed 22 statements in 2.25ms |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
1 | 1 | 1 | 1.10ms | 1.81ms | BEGIN@133 | IO::File::
68 | 1 | 1 | 158µs | 158µs | CORE:match (opcode) | IO::File::
1 | 1 | 1 | 56µs | 56µs | BEGIN@127 | IO::File::
1 | 1 | 1 | 39µs | 266µs | BEGIN@131 | IO::File::
1 | 1 | 1 | 28µs | 254µs | BEGIN@130 | IO::File::
1 | 1 | 1 | 24µs | 32µs | BEGIN@128 | IO::File::
1 | 1 | 1 | 22µs | 22µs | BEGIN@132 | IO::File::
0 | 0 | 0 | 0s | 0s | binmode | IO::File::
0 | 0 | 0 | 0s | 0s | new | IO::File::
0 | 0 | 0 | 0s | 0s | open | IO::File::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | # | ||||
2 | |||||
3 | package IO::File; | ||||
4 | |||||
5 | =head1 NAME | ||||
6 | |||||
7 | IO::File - supply object methods for filehandles | ||||
8 | |||||
9 | =head1 SYNOPSIS | ||||
10 | |||||
11 | use IO::File; | ||||
12 | |||||
13 | $fh = IO::File->new(); | ||||
14 | if ($fh->open("< file")) { | ||||
15 | print <$fh>; | ||||
16 | $fh->close; | ||||
17 | } | ||||
18 | |||||
19 | $fh = IO::File->new("> file"); | ||||
20 | if (defined $fh) { | ||||
21 | print $fh "bar\n"; | ||||
22 | $fh->close; | ||||
23 | } | ||||
24 | |||||
25 | $fh = IO::File->new("file", "r"); | ||||
26 | if (defined $fh) { | ||||
27 | print <$fh>; | ||||
28 | undef $fh; # automatically closes the file | ||||
29 | } | ||||
30 | |||||
31 | $fh = IO::File->new("file", O_WRONLY|O_APPEND); | ||||
32 | if (defined $fh) { | ||||
33 | print $fh "corge\n"; | ||||
34 | |||||
35 | $pos = $fh->getpos; | ||||
36 | $fh->setpos($pos); | ||||
37 | |||||
38 | undef $fh; # automatically closes the file | ||||
39 | } | ||||
40 | |||||
41 | autoflush STDOUT 1; | ||||
42 | |||||
43 | =head1 DESCRIPTION | ||||
44 | |||||
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. | ||||
47 | |||||
48 | =head1 CONSTRUCTOR | ||||
49 | |||||
50 | =over 4 | ||||
51 | |||||
52 | =item new ( FILENAME [,MODE [,PERMS]] ) | ||||
53 | |||||
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. | ||||
57 | |||||
58 | =item new_tmpfile | ||||
59 | |||||
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. | ||||
65 | |||||
66 | =back | ||||
67 | |||||
68 | =head1 METHODS | ||||
69 | |||||
70 | =over 4 | ||||
71 | |||||
72 | =item open( FILENAME [,MODE [,PERMS]] ) | ||||
73 | |||||
74 | =item open( FILENAME, IOLAYERS ) | ||||
75 | |||||
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. | ||||
81 | |||||
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). | ||||
85 | |||||
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. | ||||
89 | |||||
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. | ||||
92 | |||||
93 | For convenience, C<IO::File> exports the O_XXX constants from the | ||||
94 | Fcntl module, if this module is available. | ||||
95 | |||||
96 | =item binmode( [LAYER] ) | ||||
97 | |||||
98 | C<binmode> sets C<binmode> on the underlying C<IO> object, as documented | ||||
99 | in C<perldoc -f binmode>. | ||||
100 | |||||
101 | C<binmode> accepts one optional parameter, which is the layer to be | ||||
102 | passed on to the C<binmode> call. | ||||
103 | |||||
104 | =back | ||||
105 | |||||
106 | =head1 NOTE | ||||
107 | |||||
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 | ||||
111 | suggested instead. | ||||
112 | |||||
113 | =head1 SEE ALSO | ||||
114 | |||||
115 | L<perlfunc>, | ||||
116 | L<perlop/"I/O Operators">, | ||||
117 | L<IO::Handle>, | ||||
118 | L<IO::Seekable>, | ||||
119 | L<IO::Dir> | ||||
120 | |||||
121 | =head1 HISTORY | ||||
122 | |||||
123 | Derived from FileHandle.pm by Graham Barr E<lt>F<gbarr@pobox.com>E<gt>. | ||||
124 | |||||
125 | =cut | ||||
126 | |||||
127 | 2 | 110µs | 1 | 56µs | # spent 56µs within IO::File::BEGIN@127 which was called:
# once (56µs+0s) by Razor2::Client::Agent::BEGIN@16 at line 127 # spent 56µs making 1 call to IO::File::BEGIN@127 |
128 | 2 | 120µs | 2 | 40µs | # spent 32µs (24+8) within IO::File::BEGIN@128 which was called:
# once (24µs+8µs) by Razor2::Client::Agent::BEGIN@16 at line 128 # spent 32µs making 1 call to IO::File::BEGIN@128
# spent 8µs making 1 call to strict::import |
129 | our($VERSION, @EXPORT, @EXPORT_OK, @ISA); | ||||
130 | 2 | 67µs | 2 | 480µs | # spent 254µs (28+226) within IO::File::BEGIN@130 which was called:
# once (28µs+226µs) by Razor2::Client::Agent::BEGIN@16 at line 130 # spent 254µs making 1 call to IO::File::BEGIN@130
# spent 226µs making 1 call to Exporter::import |
131 | 2 | 98µs | 2 | 493µs | # spent 266µs (39+227) within IO::File::BEGIN@131 which was called:
# once (39µs+227µs) by Razor2::Client::Agent::BEGIN@16 at line 131 # spent 266µs making 1 call to IO::File::BEGIN@131
# spent 227µs making 1 call to Exporter::import |
132 | 2 | 57µs | 1 | 22µs | # spent 22µs within IO::File::BEGIN@132 which was called:
# once (22µs+0s) by Razor2::Client::Agent::BEGIN@16 at line 132 # spent 22µs making 1 call to IO::File::BEGIN@132 |
133 | 2 | 1.23ms | 2 | 1.97ms | # spent 1.81ms (1.10+711µs) within IO::File::BEGIN@133 which was called:
# once (1.10ms+711µs) by Razor2::Client::Agent::BEGIN@16 at line 133 # spent 1.81ms making 1 call to IO::File::BEGIN@133
# spent 155µs making 1 call to Exporter::import |
134 | |||||
135 | 1 | 2µs | require Exporter; | ||
136 | |||||
137 | 1 | 28µs | @ISA = qw(IO::Handle IO::Seekable Exporter); | ||
138 | |||||
139 | 1 | 2µs | $VERSION = "1.16"; | ||
140 | |||||
141 | 1 | 3µs | @EXPORT = @IO::Seekable::EXPORT; | ||
142 | |||||
143 | 1 | 3µs | eval { | ||
144 | # Make all Fcntl O_XXX constants available for importing | ||||
145 | 1 | 2µs | require Fcntl; | ||
146 | 1 | 471µs | 68 | 158µs | my @O = grep /^O_/, @Fcntl::EXPORT; # spent 158µs making 68 calls to IO::File::CORE:match, avg 2µs/call |
147 | 1 | 8µs | 1 | 1.15ms | Fcntl->import(@O); # first we import what we want to export # spent 1.15ms making 1 call to Exporter::import |
148 | 1 | 22µs | push(@EXPORT, @O); | ||
149 | }; | ||||
150 | |||||
151 | ################################################ | ||||
152 | ## Constructor | ||||
153 | ## | ||||
154 | |||||
155 | sub new { | ||||
156 | my $type = shift; | ||||
157 | my $class = ref($type) || $type || "IO::File"; | ||||
158 | @_ >= 0 && @_ <= 3 | ||||
159 | or croak "usage: $class->new([FILENAME [,MODE [,PERMS]]])"; | ||||
160 | my $fh = $class->SUPER::new(); | ||||
161 | if (@_) { | ||||
162 | $fh->open(@_) | ||||
163 | or return undef; | ||||
164 | } | ||||
165 | $fh; | ||||
166 | } | ||||
167 | |||||
168 | ################################################ | ||||
169 | ## Open | ||||
170 | ## | ||||
171 | |||||
172 | sub open { | ||||
173 | @_ >= 2 && @_ <= 4 or croak 'usage: $fh->open(FILENAME [,MODE [,PERMS]])'; | ||||
174 | my ($fh, $file) = @_; | ||||
175 | if (@_ > 2) { | ||||
176 | my ($mode, $perms) = @_[2, 3]; | ||||
177 | if ($mode =~ /^\d+$/) { | ||||
178 | defined $perms or $perms = 0666; | ||||
179 | return sysopen($fh, $file, $mode, $perms); | ||||
180 | } elsif ($mode =~ /:/) { | ||||
181 | return open($fh, $mode, $file) if @_ == 3; | ||||
182 | croak 'usage: $fh->open(FILENAME, IOLAYERS)'; | ||||
183 | } else { | ||||
184 | return open($fh, IO::Handle::_open_mode_string($mode), $file); | ||||
185 | } | ||||
186 | } | ||||
187 | open($fh, $file); | ||||
188 | } | ||||
189 | |||||
190 | ################################################ | ||||
191 | ## Binmode | ||||
192 | ## | ||||
193 | |||||
194 | sub binmode { | ||||
195 | ( @_ == 1 or @_ == 2 ) or croak 'usage $fh->binmode([LAYER])'; | ||||
196 | |||||
197 | my($fh, $layer) = @_; | ||||
198 | |||||
199 | return binmode $$fh unless $layer; | ||||
200 | return binmode $$fh, $layer; | ||||
201 | } | ||||
202 | |||||
203 | 1 | 30µs | 1; | ||
# spent 158µs within IO::File::CORE:match which was called 68 times, avg 2µs/call:
# 68 times (158µs+0s) by Razor2::Client::Agent::BEGIN@16 at line 146, avg 2µs/call |