← Index
NYTProf Performance Profile   « line view »
For /Users/brian/bin/perls/cpan5.26.1
  Run on Sat Dec 30 01:41:10 2017
Reported on Sat Dec 30 01:44:15 2017

Filename/usr/local/perls/perl-5.26.1/lib/5.26.1/File/Basename.pm
StatementsExecuted 13696 statements in 52.3ms
Subroutines
Calls P F Exclusive
Time		 Inclusive
Time		 Subroutine
5113218.6ms25.1msFile::Basename::::fileparseFile::Basename::fileparse
5013213.3ms52.0msFile::Basename::::dirnameFile::Basename::dirname
502117.49ms7.49msFile::Basename::::CORE:substFile::Basename::CORE:subst (opcode)
511116.52ms6.52msFile::Basename::::CORE:matchFile::Basename::CORE:match (opcode)
502216.41ms13.9msFile::Basename::::_strip_trailing_sepFile::Basename::_strip_trailing_sep
11119µs60µsFile::Basename::::basenameFile::Basename::basename
0000s0sFile::Basename::::BEGINFile::Basename::BEGIN
0000s0sFile::Basename::::fileparse_set_fstypeFile::Basename::fileparse_set_fstype
Call graph for these subroutines as a Graphviz dot language file.
Line State
ments		 Time
on line		 Calls Time
in subs		 Code
1=head1 NAME
2
3File::Basename - Parse file paths into directory, filename and suffix.
4
5=head1 SYNOPSIS
6
7 use File::Basename;
8
9 ($name,$path,$suffix) = fileparse($fullname,@suffixlist);
10 $name = fileparse($fullname,@suffixlist);
11
12 $basename = basename($fullname,@suffixlist);
13 $dirname = dirname($fullname);
14
15
16=head1 DESCRIPTION
17
18These routines allow you to parse file paths into their directory, filename
19and suffix.
20
21B<NOTE>: C<dirname()> and C<basename()> emulate the behaviours, and
22quirks, of the shell and C functions of the same name. See each
23function's documentation for details. If your concern is just parsing
24paths it is safer to use L<File::Spec>'s C<splitpath()> and
25C<splitdir()> methods.
26
27It is guaranteed that
28
29 # Where $path_separator is / for Unix, \ for Windows, etc...
30 dirname($path) . $path_separator . basename($path);
31
32is equivalent to the original path for all systems but VMS.
33
34
35=cut
36
37
38package File::Basename;
39
40# File::Basename is used during the Perl build, when the re extension may
41# not be available, but we only actually need it if running under tainting.
42BEGIN {
43 if (${^TAINT}) {
44 require re;
45 re->import('taint');
46 }
47}
48
49
50use strict;
51use 5.006;
52use warnings;
53our(@ISA, @EXPORT, $VERSION, $Fileparse_fstype, $Fileparse_igncase);
54require Exporter;
55@ISA = qw(Exporter);
56@EXPORT = qw(fileparse fileparse_set_fstype basename dirname);
57$VERSION = "2.85";
58
59fileparse_set_fstype($^O);
60
61
62=over 4
63
64=item C<fileparse>
65X<fileparse>
66
67 my($filename, $dirs, $suffix) = fileparse($path);
68 my($filename, $dirs, $suffix) = fileparse($path, @suffixes);
69 my $filename = fileparse($path, @suffixes);
70
71The C<fileparse()> routine divides a file path into its $dirs, $filename
72and (optionally) the filename $suffix.
73
74$dirs contains everything up to and including the last
75directory separator in the $path including the volume (if applicable).
76The remainder of the $path is the $filename.
77
78 # On Unix returns ("baz", "/foo/bar/", "")
79 fileparse("/foo/bar/baz");
80
81 # On Windows returns ("baz", 'C:\foo\bar\', "")
82 fileparse('C:\foo\bar\baz');
83
84 # On Unix returns ("", "/foo/bar/baz/", "")
85 fileparse("/foo/bar/baz/");
86
87If @suffixes are given each element is a pattern (either a string or a
88C<qr//>) matched against the end of the $filename. The matching
89portion is removed and becomes the $suffix.
90
91 # On Unix returns ("baz", "/foo/bar/", ".txt")
92 fileparse("/foo/bar/baz.txt", qr/\.[^.]*/);
93
94If type is non-Unix (see L</fileparse_set_fstype>) then the pattern
95matching for suffix removal is performed case-insensitively, since
96those systems are not case-sensitive when opening existing files.
97
98You are guaranteed that C<$dirs . $filename . $suffix> will
99denote the same location as the original $path.
100
101=cut
102
103
104
# spent 25.1ms (18.6+6.52) within File::Basename::fileparse which was called 511 times, avg 49µs/call: # 501 times (18.4ms+6.46ms) by File::Basename::dirname at line 294, avg 50µs/call # 9 times (213µs+58µs) by File::Find::_find_opt at line 245 of File/Find.pm, avg 30µs/call # once (14µs+4µs) by File::Basename::basename at line 222
sub fileparse {
105511457µs my($fullname,@suffices) = @_;
106
107511356µs unless (defined $fullname) {
108 require Carp;
109 Carp::croak("fileparse(): need a valid pathname");
110 }
111
112511407µs my $orig_type = '';
113511595µs my($type,$igncase) = ($Fileparse_fstype, $Fileparse_igncase);
114
1155111.27ms my($taint) = substr($fullname,0,0); # Is $fullname tainted?
116
117511465µs if ($type eq "VMS" and $fullname =~ m{/} ) {
118 # We're doing Unix emulation
119 $orig_type = $type;
120 $type = 'Unix';
121 }
122
123511275µs my($dirpath, $basename);
124
1255113.49ms if (grep { $type eq $_ } qw(MSDOS DOS MSWin32 Epoc)) {
126 ($dirpath,$basename) = ($fullname =~ /^((?:.*[:\\\/])?)(.*)/s);
127 $dirpath .= '.\\' unless $dirpath =~ /[\\\/]\z/;
128 }
129 elsif ($type eq "OS2") {
130 ($dirpath,$basename) = ($fullname =~ m#^((?:.*[:\\/])?)(.*)#s);
131 $dirpath = './' unless $dirpath; # Can't be 0
132 $dirpath .= '/' unless $dirpath =~ m#[\\/]\z#;
133 }
134 elsif ($type eq "MacOS") {
135 ($dirpath,$basename) = ($fullname =~ /^(.*:)?(.*)/s);
136 $dirpath = ':' unless $dirpath;
137 }
138 elsif ($type eq "AmigaOS") {
139 ($dirpath,$basename) = ($fullname =~ /(.*[:\/])?(.*)/s);
140 $dirpath = './' unless $dirpath;
141 }
142 elsif ($type eq 'VMS' ) {
143 ($dirpath,$basename) = ($fullname =~ /^(.*[:>\]])?(.*)/s);
144 $dirpath ||= ''; # should always be defined
145 }
146 else { # Default to Unix semantics.
14751110.7ms5116.52ms ($dirpath,$basename) = ($fullname =~ m{^(.*/)?(.*)}s);
# spent 6.52ms making 511 calls to File::Basename::CORE:match, avg 13µs/call
148511491µs if ($orig_type eq 'VMS' and $fullname =~ m{^(/[^/]+/000000(/|$))(.*)}) {
149 # dev:[000000] is top of VMS tree, similar to Unix '/'
150 # so strip it off and treat the rest as "normal"
151 my $devspec = $1;
152 my $remainder = $3;
153 ($dirpath,$basename) = ($remainder =~ m{^(.*/)?(.*)}s);
154 $dirpath ||= ''; # should always be defined
155 $dirpath = $devspec.$dirpath;
156 }
157511426µs $dirpath = './' unless $dirpath;
158 }
159
160
161511376µs my $tail = '';
162511216µs my $suffix = '';
163511562µs if (@suffices) {
164 foreach $suffix (@suffices) {
165 my $pat = ($igncase ? '(?i)' : '') . "($suffix)\$";
166 if ($basename =~ s/$pat//s) {
167 $taint .= substr($suffix,0,0);
168 $tail = $1 . $tail;
169 }
170 }
171 }
172
173 # Ensure taint is propagated from the path to its pieces.
174511599µs $tail .= $taint;
1755115.87ms wantarray ? ($basename .= $taint, $dirpath .= $taint, $tail)
176 : ($basename .= $taint);
177}
178
- -
181=item C<basename>
182X<basename> X<filename>
183
184 my $filename = basename($path);
185 my $filename = basename($path, @suffixes);
186
187This function is provided for compatibility with the Unix shell command
188C<basename(1)>. It does B<NOT> always return the file name portion of a
189path as you might expect. To be safe, if you want the file name portion of
190a path use C<fileparse()>.
191
192C<basename()> returns the last level of a filepath even if the last
193level is clearly directory. In effect, it is acting like C<pop()> for
194paths. This differs from C<fileparse()>'s behaviour.
195
196 # Both return "bar"
197 basename("/foo/bar");
198 basename("/foo/bar/");
199
200@suffixes work as in C<fileparse()> except all regex metacharacters are
201quoted.
202
203 # These two function calls are equivalent.
204 my $filename = basename("/foo/bar/baz.txt", ".txt");
205 my $filename = fileparse("/foo/bar/baz.txt", qr/\Q.txt\E/);
206
207Also note that in order to be compatible with the shell command,
208C<basename()> does not strip off a suffix if it is identical to the
209remaining characters in the filename.
210
211=cut
212
213
214
# spent 60µs (19+41) within File::Basename::basename which was called: # once (19µs+41µs) by CPAN::Distribution::CHECKSUM_check_file at line 1491 of CPAN/Distribution.pm
sub basename {
21511µs my($path) = shift;
216
217 # From BSD basename(1)
218 # The basename utility deletes any prefix ending with the last slash '/'
219 # character present in string (after first stripping trailing slashes)
22012µs123µs _strip_trailing_sep($path);
# spent 23µs making 1 call to File::Basename::_strip_trailing_sep
221
22213µs118µs my($basename, $dirname, $suffix) = fileparse( $path, map("\Q$_\E",@_) );
# spent 18µs making 1 call to File::Basename::fileparse
223
224 # From BSD basename(1)
225 # The suffix is not stripped if it is identical to the remaining
226 # characters in string.
22711µs if( length $suffix and !length $basename ) {
228 $basename = $suffix;
229 }
230
231 # Ensure that basename '/' == '/'
23211µs if( !length $basename ) {
233 $basename = $dirname;
234 }
235
23617µs return $basename;
237}
238
- -
241=item C<dirname>
242X<dirname>
243
244This function is provided for compatibility with the Unix shell
245command C<dirname(1)> and has inherited some of its quirks. In spite of
246its name it does B<NOT> always return the directory name as you might
247expect. To be safe, if you want the directory name of a path use
248C<fileparse()>.
249
250Only on VMS (where there is no ambiguity between the file and directory
251portions of a path) and AmigaOS (possibly due to an implementation quirk in
252this module) does C<dirname()> work like C<fileparse($path)>, returning just the
253$dirs.
254
255 # On VMS and AmigaOS
256 my $dirs = dirname($path);
257
258When using Unix or MSDOS syntax this emulates the C<dirname(1)> shell function
259which is subtly different from how C<fileparse()> works. It returns all but
260the last level of a file path even if the last level is clearly a directory.
261In effect, it is not returning the directory portion but simply the path one
262level up acting like C<chop()> for file paths.
263
264Also unlike C<fileparse()>, C<dirname()> does not include a trailing slash on
265its returned path.
266
267 # returns /foo/bar. fileparse() would return /foo/bar/
268 dirname("/foo/bar/baz");
269
270 # also returns /foo/bar despite the fact that baz is clearly a
271 # directory. fileparse() would return /foo/bar/baz/
272 dirname("/foo/bar/baz/");
273
274 # returns '.'. fileparse() would return 'foo/'
275 dirname("foo/");
276
277Under VMS, if there is no directory information in the $path, then the
278current default device and directory is used.
279
280=cut
281
282
283
# spent 52.0ms (13.3+38.7) within File::Basename::dirname which was called 501 times, avg 104µs/call: # 498 times (13.2ms+38.5ms) by CPAN::CacheMgr::_clean_cache at line 152 of CPAN/CacheMgr.pm, avg 104µs/call # 2 times (51µs+154µs) by CPAN::FTP::localize at line 343 of CPAN/FTP.pm, avg 102µs/call # once (10µs+24µs) by CPAN::FTP::_ftp_statistics at line 31 of CPAN/FTP.pm
sub dirname {
284501613µs my $path = shift;
285
286501687µs my($type) = $Fileparse_fstype;
287
288501613µs if( $type eq 'VMS' and $path =~ m{/} ) {
289 # Parse as Unix
290 local($File::Basename::Fileparse_fstype) = '';
291 return dirname($path);
292 }
293
2945012.65ms50124.8ms my($basename, $dirname) = fileparse($path);
# spent 24.8ms making 501 calls to File::Basename::fileparse, avg 50µs/call
295
2965012.35ms if ($type eq 'VMS') {
297 $dirname ||= $ENV{DEFAULT};
298 }
299 elsif ($type eq 'MacOS') {
300 if( !length($basename) && $dirname !~ /^[^:]+:\z/) {
301 _strip_trailing_sep($dirname);
302 ($basename,$dirname) = fileparse $dirname;
303 }
304 $dirname .= ":" unless $dirname =~ /:\z/;
305 }
306 elsif (grep { $type eq $_ } qw(MSDOS DOS MSWin32 OS2)) {
307 _strip_trailing_sep($dirname);
308 unless( length($basename) ) {
309 ($basename,$dirname) = fileparse $dirname;
310 _strip_trailing_sep($dirname);
311 }
312 }
313 elsif ($type eq 'AmigaOS') {
314 if ( $dirname =~ /:\z/) { return $dirname }
315 chop $dirname;
316 $dirname =~ s{[^:/]+\z}{} unless length($basename);
317 }
318 else {
3195011.91ms50113.9ms _strip_trailing_sep($dirname);
# spent 13.9ms making 501 calls to File::Basename::_strip_trailing_sep, avg 28µs/call
320501441µs unless( length($basename) ) {
321 ($basename,$dirname) = fileparse $dirname;
322 _strip_trailing_sep($dirname);
323 }
324 }
325
3265012.44ms $dirname;
327}
328
329
330# Strip the trailing path separator.
331
# spent 13.9ms (6.41+7.49) within File::Basename::_strip_trailing_sep which was called 502 times, avg 28µs/call: # 501 times (6.40ms+7.48ms) by File::Basename::dirname at line 319, avg 28µs/call # once (7µs+16µs) by File::Basename::basename at line 220
sub _strip_trailing_sep {
332502552µs my $type = $Fileparse_fstype;
333
3345023.03ms if ($type eq 'MacOS') {
335 $_[0] =~ s/([^:]):\z/$1/s;
336 }
337 elsif (grep { $type eq $_ } qw(MSDOS DOS MSWin32 OS2)) {
338 $_[0] =~ s/([^:])[\\\/]*\z/$1/;
339 }
340 else {
34150210.4ms5027.49ms $_[0] =~ s{(.)/*\z}{$1}s;
# spent 7.49ms making 502 calls to File::Basename::CORE:subst, avg 15µs/call
342 }
343}
344
345
346=item C<fileparse_set_fstype>
347X<filesystem>
348
349 my $type = fileparse_set_fstype();
350 my $previous_type = fileparse_set_fstype($type);
351
352Normally File::Basename will assume a file path type native to your current
353operating system (ie. /foo/bar style on Unix, \foo\bar on Windows, etc...).
354With this function you can override that assumption.
355
356Valid $types are "MacOS", "VMS", "AmigaOS", "OS2", "RISCOS",
357"MSWin32", "DOS" (also "MSDOS" for backwards bug compatibility),
358"Epoc" and "Unix" (all case-insensitive). If an unrecognized $type is
359given "Unix" will be assumed.
360
361If you've selected VMS syntax, and the file specification you pass to
362one of these routines contains a "/", they assume you are using Unix
363emulation and apply the Unix syntax rules instead, for that function
364call only.
365
366=back
367
368=cut
369
370
371BEGIN {
372
373my @Ignore_Case = qw(MacOS VMS AmigaOS OS2 RISCOS MSWin32 MSDOS DOS Epoc);
374my @Types = (@Ignore_Case, qw(Unix));
375
376sub fileparse_set_fstype {
377 my $old = $Fileparse_fstype;
378
379 if (@_) {
380 my $new_type = shift;
381
382 $Fileparse_fstype = 'Unix'; # default
383 foreach my $type (@Types) {
384 $Fileparse_fstype = $type if $new_type =~ /^$type/i;
385 }
386
387 $Fileparse_igncase =
388 (grep $Fileparse_fstype eq $_, @Ignore_Case) ? 1 : 0;
389 }
390
391 return $old;
392}
393
394}
395
396
3971;
398
399
400=head1 SEE ALSO
401
402L<dirname(1)>, L<basename(1)>, L<File::Spec>
 
# spent 6.52ms within File::Basename::CORE:match which was called 511 times, avg 13µs/call: # 511 times (6.52ms+0s) by File::Basename::fileparse at line 147, avg 13µs/call
sub File::Basename::CORE:match; # opcode
# spent 7.49ms within File::Basename::CORE:subst which was called 502 times, avg 15µs/call: # 502 times (7.49ms+0s) by File::Basename::_strip_trailing_sep at line 341, avg 15µs/call
sub File::Basename::CORE:subst; # opcode
Report produced by the NYTProf 6.04 Perl profiler, developed by Tim Bunce based on work by Adam Kaplan and Salvador Fandiño García.