← Index
NYTProf Performance Profile   « line view »
For /Users/timbo/perl5/perlbrew/perls/perl-5.18.2/bin/perlcritic
  Run on Sat Mar 19 22:12:22 2016
Reported on Sat Mar 19 22:14:12 2016

Filename/Users/timbo/perl5/perlbrew/perls/perl-5.18.2/lib/site_perl/5.18.2/File/HomeDir.pm
StatementsExecuted 109 statements in 1.72ms
Subroutines
Calls P F Exclusive
Time
Inclusive
Time
Subroutine
111633┬Ás867┬ÁsFile::HomeDir::::BEGIN@10 File::HomeDir::BEGIN@10
111508┬Ás2.18msFile::HomeDir::::_DRIVER File::HomeDir::_DRIVER
222181┬Ás127┬ÁsFile::HomeDir::::my_home File::HomeDir::my_home
111156┬Ás515┬ÁsFile::HomeDir::::my_data File::HomeDir::my_data
111155┬Ás482┬ÁsFile::HomeDir::::my_pictures File::HomeDir::my_pictures
111153┬Ás512┬ÁsFile::HomeDir::::my_music File::HomeDir::my_music
111152┬Ás2.35msFile::HomeDir::::my_desktop File::HomeDir::my_desktop
111151┬Ás469┬ÁsFile::HomeDir::::my_videos File::HomeDir::my_videos
11115┬Ás15┬ÁsFile::HomeDir::::BEGIN@5 File::HomeDir::BEGIN@5
11112┬Ás12┬ÁsFile::HomeDir::::BEGIN@14 File::HomeDir::BEGIN@14
1118┬Ás11┬ÁsFile::HomeDir::::_CLASS File::HomeDir::_CLASS
1117┬Ás72┬ÁsFile::HomeDir::::BEGIN@13 File::HomeDir::BEGIN@13
1117┬Ás18┬ÁsFile::HomeDir::::BEGIN@6 File::HomeDir::BEGIN@6
1113┬Ás3┬ÁsFile::HomeDir::::BEGIN@9 File::HomeDir::BEGIN@9
1113┬Ás3┬ÁsFile::HomeDir::::BEGIN@7 File::HomeDir::BEGIN@7
1113┬Ás3┬ÁsFile::HomeDir::::CORE:match File::HomeDir::CORE:match (opcode)
1113┬Ás3┬ÁsFile::HomeDir::::BEGIN@8 File::HomeDir::BEGIN@8
1111┬Ás1┬ÁsFile::HomeDir::TIE::::TIEHASHFile::HomeDir::TIE::TIEHASH
0000s0sFile::HomeDir::TIE::::CLEARFile::HomeDir::TIE::CLEAR
0000s0sFile::HomeDir::TIE::::DELETEFile::HomeDir::TIE::DELETE
0000s0sFile::HomeDir::TIE::::EXISTSFile::HomeDir::TIE::EXISTS
0000s0sFile::HomeDir::TIE::::FETCHFile::HomeDir::TIE::FETCH
0000s0sFile::HomeDir::TIE::::FIRSTKEYFile::HomeDir::TIE::FIRSTKEY
0000s0sFile::HomeDir::TIE::::NEXTKEYFile::HomeDir::TIE::NEXTKEY
0000s0sFile::HomeDir::TIE::::STOREFile::HomeDir::TIE::STORE
0000s0sFile::HomeDir::TIE::::_badFile::HomeDir::TIE::_bad
0000s0sFile::HomeDir::::home File::HomeDir::home
0000s0sFile::HomeDir::::my_dist_config File::HomeDir::my_dist_config
0000s0sFile::HomeDir::::my_dist_data File::HomeDir::my_dist_data
0000s0sFile::HomeDir::::my_documents File::HomeDir::my_documents
0000s0sFile::HomeDir::::users_data File::HomeDir::users_data
0000s0sFile::HomeDir::::users_desktop File::HomeDir::users_desktop
0000s0sFile::HomeDir::::users_documents File::HomeDir::users_documents
0000s0sFile::HomeDir::::users_home File::HomeDir::users_home
0000s0sFile::HomeDir::::users_music File::HomeDir::users_music
0000s0sFile::HomeDir::::users_pictures File::HomeDir::users_pictures
0000s0sFile::HomeDir::::users_videos File::HomeDir::users_videos
Call graph for these subroutines as a Graphviz dot language file.
Line State
ments
Time
on line
Calls Time
in subs
Code
1package File::HomeDir;
2
3# See POD at end for documentation
4
5239┬Ás115┬Ás
# spent 15┬Ás within File::HomeDir::BEGIN@5 which was called: # once (15┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 5
use 5.00503;
# spent 15┬Ás making 1 call to File::HomeDir::BEGIN@5
6219┬Ás230┬Ás
# spent 18┬Ás (7+11) within File::HomeDir::BEGIN@6 which was called: # once (7┬Ás+11┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 6
use strict;
# spent 18┬Ás making 1 call to File::HomeDir::BEGIN@6 # spent 11┬Ás making 1 call to strict::import
7221┬Ás13┬Ás
# spent 3┬Ás within File::HomeDir::BEGIN@7 which was called: # once (3┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 7
use Carp ();
# spent 3┬Ás making 1 call to File::HomeDir::BEGIN@7
8215┬Ás13┬Ás
# spent 3┬Ás within File::HomeDir::BEGIN@8 which was called: # once (3┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 8
use Config ();
# spent 3┬Ás making 1 call to File::HomeDir::BEGIN@8
9218┬Ás13┬Ás
# spent 3┬Ás within File::HomeDir::BEGIN@9 which was called: # once (3┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 9
use File::Spec ();
# spent 3┬Ás making 1 call to File::HomeDir::BEGIN@9
10283┬Ás1867┬Ás
# spent 867┬Ás (633+234) within File::HomeDir::BEGIN@10 which was called: # once (633┬Ás+234┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 10
use File::Which ();
# spent 867┬Ás making 1 call to File::HomeDir::BEGIN@10
11
12# Globals
13254┬Ás2136┬Ás
# spent 72┬Ás (7+65) within File::HomeDir::BEGIN@13 which was called: # once (7┬Ás+65┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 13
use vars qw{$VERSION @ISA @EXPORT @EXPORT_OK $IMPLEMENTED_BY};
# spent 72┬Ás making 1 call to File::HomeDir::BEGIN@13 # spent 65┬Ás making 1 call to vars::import
14
# spent 12┬Ás within File::HomeDir::BEGIN@14 which was called: # once (12┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 43
BEGIN {
151400ns $VERSION = '1.00';
16
17 # Inherit manually
181300ns require Exporter;
1915┬Ás @ISA = qw{ Exporter };
201500ns @EXPORT = qw{ home };
2116┬Ás @EXPORT_OK = qw{
22 home
23 my_home
24 my_desktop
25 my_documents
26 my_music
27 my_pictures
28 my_videos
29 my_data
30 my_dist_config
31 my_dist_data
32 users_home
33 users_desktop
34 users_documents
35 users_music
36 users_pictures
37 users_videos
38 users_data
39 };
40
41 # %~ doesn't need (and won't take) exporting, as it's a magic
42 # symbol name that's always looked for in package 'main'.
431964┬Ás112┬Ás}
# spent 12┬Ás making 1 call to File::HomeDir::BEGIN@14
44
45# Inlined Params::Util functions
46
# spent 11┬Ás (8+3) within File::HomeDir::_CLASS which was called: # once (8┬Ás+3┬Ás) by File::HomeDir::_DRIVER at line 50
sub _CLASS ($) {
47113┬Ás13┬Ás (defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s) ? $_[0] : undef;
# spent 3┬Ás making 1 call to File::HomeDir::CORE:match
48}
49
# spent 2.18ms (508┬Ás+1.67) within File::HomeDir::_DRIVER which was called: # once (508┬Ás+1.67ms) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 81
sub _DRIVER ($$) {
50136┬Ás213┬Ás (defined _CLASS($_[0]) and eval "require $_[0];" and ! $@ and $_[0]->isa($_[1]) and $_[0] ne $_[1]) ? $_[0] : undef;
# spent 11┬Ás making 1 call to File::HomeDir::_CLASS # spent 2┬Ás making 1 call to UNIVERSAL::isa
# spent 64┬Ás executing statements in string eval
51}
52
53# Platform detection
5411┬Ásif ( $IMPLEMENTED_BY ) {
55 # Allow for custom HomeDir classes
56 # Leave it as the existing value
57} elsif ( $^O eq 'MSWin32' ) {
58 # All versions of Windows
59 $IMPLEMENTED_BY = 'File::HomeDir::Windows';
60} elsif ( $^O eq 'darwin') {
61 # 1st: try Mac::SystemDirectory by chansen
62358┬Ás if ( eval { require Mac::SystemDirectory; 1 } ) {
631700ns $IMPLEMENTED_BY = 'File::HomeDir::Darwin::Cocoa';
64 } elsif ( eval { require Mac::Files; 1 } ) {
65 # 2nd try Mac::Files: Carbon - unmaintained since 2006 except some 64bit fixes
66 $IMPLEMENTED_BY = 'File::HomeDir::Darwin::Carbon';
67 } else {
68 # 3rd: fallback: pure perl
69 $IMPLEMENTED_BY = 'File::HomeDir::Darwin';
70 }
71} elsif ( $^O eq 'MacOS' ) {
72 # Legacy Mac OS
73 $IMPLEMENTED_BY = 'File::HomeDir::MacOS9';
74} elsif ( File::Which::which('xdg-user-dir') ) {
75 # freedesktop unixes
76 $IMPLEMENTED_BY = 'File::HomeDir::FreeDesktop';
77} else {
78 # Default to Unix semantics
79 $IMPLEMENTED_BY = 'File::HomeDir::Unix';
80}
8113┬Ás12.18msunless ( _DRIVER($IMPLEMENTED_BY, 'File::HomeDir::Driver') ) {
# spent 2.18ms making 1 call to File::HomeDir::_DRIVER
82 Carp::croak("Missing or invalid File::HomeDir driver $IMPLEMENTED_BY");
83}
84
- -
89#####################################################################
90# Current User Methods
91
92
# spent 127┬Ás (81+46) within File::HomeDir::my_home which was called 22 times, avg 6┬Ás/call: # 11 times (51┬Ás+29┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 54 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 7┬Ás/call # 11 times (30┬Ás+17┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 4┬Ás/call
sub my_home {
932266┬Ás2246┬Ás $IMPLEMENTED_BY->my_home;
# spent 46┬Ás making 22 calls to File::HomeDir::Darwin::Cocoa::my_home, avg 2┬Ás/call
94}
95
96
# spent 2.35ms (52┬Ás+2.30) within File::HomeDir::my_desktop which was called 11 times, avg 213┬Ás/call: # 11 times (52┬Ás+2.30ms) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 213┬Ás/call
sub my_desktop {
971158┬Ás222.30ms $IMPLEMENTED_BY->can('my_desktop')
# spent 2.29ms making 11 calls to File::HomeDir::Darwin::Cocoa::my_desktop, avg 208┬Ás/call # spent 10┬Ás making 11 calls to UNIVERSAL::can, avg 864ns/call
98 ? $IMPLEMENTED_BY->my_desktop
99 : Carp::croak("The my_desktop method is not implemented on this platform");
100}
101
102sub my_documents {
103 $IMPLEMENTED_BY->can('my_documents')
104 ? $IMPLEMENTED_BY->my_documents
105 : Carp::croak("The my_documents method is not implemented on this platform");
106}
107
108
# spent 512┬Ás (53+459) within File::HomeDir::my_music which was called 11 times, avg 47┬Ás/call: # 11 times (53┬Ás+459┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 47┬Ás/call
sub my_music {
1091158┬Ás22459┬Ás $IMPLEMENTED_BY->can('my_music')
# spent 449┬Ás making 11 calls to File::HomeDir::Darwin::Cocoa::my_music, avg 41┬Ás/call # spent 10┬Ás making 11 calls to UNIVERSAL::can, avg 927ns/call
110 ? $IMPLEMENTED_BY->my_music
111 : Carp::croak("The my_music method is not implemented on this platform");
112}
113
114
# spent 482┬Ás (55+427) within File::HomeDir::my_pictures which was called 11 times, avg 44┬Ás/call: # 11 times (55┬Ás+427┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 44┬Ás/call
sub my_pictures {
1151162┬Ás22427┬Ás $IMPLEMENTED_BY->can('my_pictures')
# spent 417┬Ás making 11 calls to File::HomeDir::Darwin::Cocoa::my_pictures, avg 38┬Ás/call # spent 10┬Ás making 11 calls to UNIVERSAL::can, avg 900ns/call
116 ? $IMPLEMENTED_BY->my_pictures
117 : Carp::croak("The my_pictures method is not implemented on this platform");
118}
119
120
# spent 469┬Ás (51+417) within File::HomeDir::my_videos which was called 11 times, avg 43┬Ás/call: # 11 times (51┬Ás+417┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 43┬Ás/call
sub my_videos {
1211157┬Ás22417┬Ás $IMPLEMENTED_BY->can('my_videos')
# spent 407┬Ás making 11 calls to File::HomeDir::Darwin::Cocoa::my_videos, avg 37┬Ás/call # spent 10┬Ás making 11 calls to UNIVERSAL::can, avg 891ns/call
122 ? $IMPLEMENTED_BY->my_videos
123 : Carp::croak("The my_videos method is not implemented on this platform");
124}
125
126
# spent 515┬Ás (56+459) within File::HomeDir::my_data which was called 11 times, avg 47┬Ás/call: # 11 times (56┬Ás+459┬Ás) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 56 of Path/IsDev/NegativeHeuristic/HomeDir.pm, avg 47┬Ás/call
sub my_data {
1271161┬Ás22459┬Ás $IMPLEMENTED_BY->can('my_data')
# spent 448┬Ás making 11 calls to File::HomeDir::Darwin::Cocoa::my_data, avg 41┬Ás/call # spent 10┬Ás making 11 calls to UNIVERSAL::can, avg 909ns/call
128 ? $IMPLEMENTED_BY->my_data
129 : Carp::croak("The my_data method is not implemented on this platform");
130}
131
132
133sub my_dist_data {
134 my $params = ref $_[-1] eq 'HASH' ? pop : {};
135 my $dist = pop or Carp::croak("The my_dist_data method requires an argument");
136 my $data = my_data();
137
138 # If datadir is not defined, there's nothing we can do: bail out
139 # and return nothing...
140 return undef unless defined $data;
141
142 # On traditional unixes, hide the top-level directory
143 my $var = $data eq home()
144 ? File::Spec->catdir( $data, '.perl', 'dist', $dist )
145 : File::Spec->catdir( $data, 'Perl', 'dist', $dist );
146
147 # directory exists: return it
148 return $var if -d $var;
149
150 # directory doesn't exist: check if we need to create it...
151 return undef unless $params->{create};
152
153 # user requested directory creation
154 require File::Path;
155 File::Path::mkpath( $var );
156 return $var;
157}
158
159sub my_dist_config {
160 my $params = ref $_[-1] eq 'HASH' ? pop : {};
161 my $dist = pop or Carp::croak("The my_dist_config method requires an argument");
162
163 # not all platforms support a specific my_config() method
164 my $config = $IMPLEMENTED_BY->can('my_config')
165 ? $IMPLEMENTED_BY->my_config
166 : $IMPLEMENTED_BY->my_documents;
167
168 # If neither configdir nor my_documents is defined, there's
169 # nothing we can do: bail out and return nothing...
170 return undef unless defined $config;
171
172 # On traditional unixes, hide the top-level dir
173 my $etc = $config eq home()
174 ? File::Spec->catdir( $config, '.perl', $dist )
175 : File::Spec->catdir( $config, 'Perl', $dist );
176
177 # directory exists: return it
178 return $etc if -d $etc;
179
180 # directory doesn't exist: check if we need to create it...
181 return undef unless $params->{create};
182
183 # user requested directory creation
184 require File::Path;
185 File::Path::mkpath( $etc );
186 return $etc;
187}
188
- -
192#####################################################################
193# General User Methods
194
195sub users_home {
196 $IMPLEMENTED_BY->can('users_home')
197 ? $IMPLEMENTED_BY->users_home( $_[-1] )
198 : Carp::croak("The users_home method is not implemented on this platform");
199}
200
201sub users_desktop {
202 $IMPLEMENTED_BY->can('users_desktop')
203 ? $IMPLEMENTED_BY->users_desktop( $_[-1] )
204 : Carp::croak("The users_desktop method is not implemented on this platform");
205}
206
207sub users_documents {
208 $IMPLEMENTED_BY->can('users_documents')
209 ? $IMPLEMENTED_BY->users_documents( $_[-1] )
210 : Carp::croak("The users_documents method is not implemented on this platform");
211}
212
213sub users_music {
214 $IMPLEMENTED_BY->can('users_music')
215 ? $IMPLEMENTED_BY->users_music( $_[-1] )
216 : Carp::croak("The users_music method is not implemented on this platform");
217}
218
219sub users_pictures {
220 $IMPLEMENTED_BY->can('users_pictures')
221 ? $IMPLEMENTED_BY->users_pictures( $_[-1] )
222 : Carp::croak("The users_pictures method is not implemented on this platform");
223}
224
225sub users_videos {
226 $IMPLEMENTED_BY->can('users_videos')
227 ? $IMPLEMENTED_BY->users_videos( $_[-1] )
228 : Carp::croak("The users_videos method is not implemented on this platform");
229}
230
231sub users_data {
232 $IMPLEMENTED_BY->can('users_data')
233 ? $IMPLEMENTED_BY->users_data( $_[-1] )
234 : Carp::croak("The users_data method is not implemented on this platform");
235}
236
- -
241#####################################################################
242# Legacy Methods
243
244# Find the home directory of an arbitrary user
245sub home (;$) {
246 # Allow to be called as a method
247 if ( $_[0] and $_[0] eq 'File::HomeDir' ) {
248 shift();
249 }
250
251 # No params means my home
252 return my_home() unless @_;
253
254 # Check the param
255 my $name = shift;
256 if ( ! defined $name ) {
257 Carp::croak("Can't use undef as a username");
258 }
259 if ( ! length $name ) {
260 Carp::croak("Can't use empty-string (\"\") as a username");
261 }
262
263 # A dot also means my home
264 ### Is this meant to mean File::Spec->curdir?
265 if ( $name eq '.' ) {
266 return my_home();
267 }
268
269 # Now hand off to the implementor
270 $IMPLEMENTED_BY->users_home($name);
271}
272
- -
277#####################################################################
278# Tie-Based Interface
279
280# Okay, things below this point get scary
281
282CLASS: {
283 # Make the class for the %~ tied hash:
2841200ns package File::HomeDir::TIE;
285
286 # Make the singleton object.
287 # (We don't use the hash for anything, though)
288 ### THEN WHY MAKE IT???
2891800ns my $SINGLETON = bless {};
290
29114┬Ás
# spent 1┬Ás within File::HomeDir::TIE::TIEHASH which was called: # once (1┬Ás+0s) by Path::IsDev::NegativeHeuristic::HomeDir::paths at line 322
sub TIEHASH { $SINGLETON }
292
293 sub FETCH {
294 # Catch a bad username
295 unless ( defined $_[1] ) {
296 Carp::croak("Can't use undef as a username");
297 }
298
299 # Get our homedir
300 unless ( length $_[1] ) {
301 return File::HomeDir::my_home();
302 }
303
304 # Get a named user's homedir
305 Carp::carp("The tied %~ hash has been deprecated");
306 return File::HomeDir::home($_[1]);
307 }
308
309 sub STORE { _bad('STORE') }
310 sub EXISTS { _bad('EXISTS') }
311 sub DELETE { _bad('DELETE') }
312 sub CLEAR { _bad('CLEAR') }
313 sub FIRSTKEY { _bad('FIRSTKEY') }
314 sub NEXTKEY { _bad('NEXTKEY') }
315
316 sub _bad ($) {
317 Carp::croak("You can't $_[0] with the %~ hash")
318 }
319}
320
321# Do the actual tie of the global %~ variable
32213┬Ás11┬Ástie %~, 'File::HomeDir::TIE';
# spent 1┬Ás making 1 call to File::HomeDir::TIE::TIEHASH
323
32418┬Ás1;
325
326__END__
 
# spent 3┬Ás within File::HomeDir::CORE:match which was called: # once (3┬Ás+0s) by File::HomeDir::_CLASS at line 47
sub File::HomeDir::CORE:match; # opcode