Commit | Line | Data |
a0d0e21e |
1 | package File::Basename; |
2 | |
f06db76b |
3 | =head1 NAME |
4 | |
f06db76b |
5 | fileparse - split a pathname into pieces |
6 | |
7 | basename - extract just the filename from a path |
8 | |
9 | dirname - extract just the directory from a path |
10 | |
11 | =head1 SYNOPSIS |
12 | |
13 | use File::Basename; |
14 | |
15 | ($name,$path,$suffix) = fileparse($fullname,@suffixlist) |
16 | fileparse_set_fstype($os_string); |
17 | $basename = basename($fullname,@suffixlist); |
18 | $dirname = dirname($fullname); |
19 | |
20 | ($name,$path,$suffix) = fileparse("lib/File/Basename.pm","\.pm"); |
21 | fileparse_set_fstype("VMS"); |
22 | $basename = basename("lib/File/Basename.pm",".pm"); |
23 | $dirname = dirname("lib/File/Basename.pm"); |
24 | |
25 | =head1 DESCRIPTION |
26 | |
27 | These routines allow you to parse file specifications into useful |
28 | pieces using the syntax of different operating systems. |
29 | |
30 | =over 4 |
31 | |
32 | =item fileparse_set_fstype |
33 | |
34 | You select the syntax via the routine fileparse_set_fstype(). |
ee2ff9ea |
35 | |
f06db76b |
36 | If the argument passed to it contains one of the substrings |
68dc0745 |
37 | "VMS", "MSDOS", "MacOS", "AmigaOS" or "MSWin32", the file specification |
55497cff |
38 | syntax of that operating system is used in future calls to |
39 | fileparse(), basename(), and dirname(). If it contains none of |
c7b9dd21 |
40 | these substrings, Unix syntax is used. This pattern matching is |
f06db76b |
41 | case-insensitive. If you've selected VMS syntax, and the file |
42 | specification you pass to one of these routines contains a "/", |
c7b9dd21 |
43 | they assume you are using Unix emulation and apply the Unix syntax |
f06db76b |
44 | rules instead, for that function call only. |
45 | |
ee2ff9ea |
46 | If the argument passed to it contains one of the substrings "VMS", |
68dc0745 |
47 | "MSDOS", "MacOS", "AmigaOS", "os2", "MSWin32" or "RISCOS", then the pattern |
ee2ff9ea |
48 | matching for suffix removal is performed without regard for case, |
49 | since those systems are not case-sensitive when opening existing files |
50 | (though some of them preserve case on file creation). |
51 | |
f06db76b |
52 | If you haven't called fileparse_set_fstype(), the syntax is chosen |
f0c6ccdf |
53 | by examining the builtin variable C<$^O> according to these rules. |
f06db76b |
54 | |
55 | =item fileparse |
56 | |
57 | The fileparse() routine divides a file specification into three |
58 | parts: a leading B<path>, a file B<name>, and a B<suffix>. The |
59 | B<path> contains everything up to and including the last directory |
60 | separator in the input file specification. The remainder of the input |
61 | file specification is then divided into B<name> and B<suffix> based on |
62 | the optional patterns you specify in C<@suffixlist>. Each element of |
63 | this list is interpreted as a regular expression, and is matched |
64 | against the end of B<name>. If this succeeds, the matching portion of |
65 | B<name> is removed and prepended to B<suffix>. By proper use of |
66 | C<@suffixlist>, you can remove file types or versions for examination. |
67 | |
68 | You are guaranteed that if you concatenate B<path>, B<name>, and |
7e2183d3 |
69 | B<suffix> together in that order, the result will denote the same |
70 | file as the input file specification. |
f06db76b |
71 | |
72 | =back |
73 | |
74 | =head1 EXAMPLES |
75 | |
c7b9dd21 |
76 | Using Unix file syntax: |
f06db76b |
77 | |
7e2183d3 |
78 | ($base,$path,$type) = fileparse('/virgil/aeneid/draft.book7', |
f06db76b |
79 | '\.book\d+'); |
80 | |
81 | would yield |
82 | |
83 | $base eq 'draft' |
7e2183d3 |
84 | $path eq '/virgil/aeneid/', |
f0542300 |
85 | $type eq '.book7' |
f06db76b |
86 | |
87 | Similarly, using VMS syntax: |
88 | |
89 | ($name,$dir,$type) = fileparse('Doc_Root:[Help]Rhetoric.Rnh', |
90 | '\..*'); |
91 | |
92 | would yield |
93 | |
94 | $name eq 'Rhetoric' |
95 | $dir eq 'Doc_Root:[Help]' |
96 | $type eq '.Rnh' |
97 | |
95e8664e |
98 | =over |
2ae324a7 |
99 | |
f06db76b |
100 | =item C<basename> |
101 | |
102 | The basename() routine returns the first element of the list produced |
44a8e56a |
103 | by calling fileparse() with the same arguments, except that it always |
104 | quotes metacharacters in the given suffixes. It is provided for |
c7b9dd21 |
105 | programmer compatibility with the Unix shell command basename(1). |
f06db76b |
106 | |
107 | =item C<dirname> |
108 | |
109 | The dirname() routine returns the directory portion of the input file |
110 | specification. When using VMS or MacOS syntax, this is identical to the |
111 | second element of the list produced by calling fileparse() with the same |
7e2183d3 |
112 | input file specification. (Under VMS, if there is no directory information |
113 | in the input file specification, then the current default device and |
c7b9dd21 |
114 | directory are returned.) When using Unix or MSDOS syntax, the return |
115 | value conforms to the behavior of the Unix shell command dirname(1). This |
f06db76b |
116 | is usually the same as the behavior of fileparse(), but differs in some |
117 | cases. For example, for the input file specification F<lib/>, fileparse() |
118 | considers the directory name to be F<lib/>, while dirname() considers the |
119 | directory name to be F<.>). |
120 | |
2ae324a7 |
121 | =back |
122 | |
f06db76b |
123 | =cut |
124 | |
b3eb6a9b |
125 | |
126 | ## use strict; |
1f47e8e2 |
127 | # A bit of juggling to insure that C<use re 'taint';> always works, since |
918c0b2d |
128 | # File::Basename is used during the Perl build, when the re extension may |
129 | # not be available. |
130 | BEGIN { |
131 | unless (eval { require re; }) |
132 | { eval ' sub re::import { $^H |= 0x00100000; } ' } |
133 | import re 'taint'; |
134 | } |
135 | |
136 | |
137 | |
3b825e41 |
138 | use 5.006; |
b395063c |
139 | use warnings; |
17f410f9 |
140 | our(@ISA, @EXPORT, $VERSION, $Fileparse_fstype, $Fileparse_igncase); |
a0d0e21e |
141 | require Exporter; |
142 | @ISA = qw(Exporter); |
748a9306 |
143 | @EXPORT = qw(fileparse fileparse_set_fstype basename dirname); |
88d01e8d |
144 | $VERSION = "2.71"; |
7e2183d3 |
145 | |
a0d0e21e |
146 | |
147 | # fileparse_set_fstype() - specify OS-based rules used in future |
148 | # calls to routines in this package |
149 | # |
ee2ff9ea |
150 | # Currently recognized values: VMS, MSDOS, MacOS, AmigaOS, os2, RISCOS |
151 | # Any other name uses Unix-style rules and is case-sensitive |
a0d0e21e |
152 | |
153 | sub fileparse_set_fstype { |
ee2ff9ea |
154 | my @old = ($Fileparse_fstype, $Fileparse_igncase); |
44a8e56a |
155 | if (@_) { |
156 | $Fileparse_fstype = $_[0]; |
39e571d4 |
157 | $Fileparse_igncase = ($_[0] =~ /^(?:MacOS|VMS|AmigaOS|os2|RISCOS|MSWin32|MSDOS)/i); |
44a8e56a |
158 | } |
159 | wantarray ? @old : $old[0]; |
a0d0e21e |
160 | } |
161 | |
162 | # fileparse() - parse file specification |
163 | # |
f0542300 |
164 | # Version 2.4 27-Sep-1996 Charles Bailey bailey@genetics.upenn.edu |
a0d0e21e |
165 | |
166 | |
167 | sub fileparse { |
168 | my($fullname,@suffices) = @_; |
ee2ff9ea |
169 | my($fstype,$igncase) = ($Fileparse_fstype, $Fileparse_igncase); |
7e2183d3 |
170 | my($dirpath,$tail,$suffix,$basename); |
12cbd720 |
171 | my($taint) = substr($fullname,0,0); # Is $fullname tainted? |
a0d0e21e |
172 | |
173 | if ($fstype =~ /^VMS/i) { |
174 | if ($fullname =~ m#/#) { $fstype = '' } # We're doing Unix emulation |
175 | else { |
c7b9dd21 |
176 | ($dirpath,$basename) = ($fullname =~ /^(.*[:>\]])?(.*)/s); |
12cbd720 |
177 | $dirpath ||= ''; # should always be defined |
a0d0e21e |
178 | } |
179 | } |
fa6a1c44 |
180 | if ($fstype =~ /^MS(DOS|Win32)|epoc/i) { |
c7b9dd21 |
181 | ($dirpath,$basename) = ($fullname =~ /^((?:.*[:\\\/])?)(.*)/s); |
182 | $dirpath .= '.\\' unless $dirpath =~ /[\\\/]\z/; |
a0d0e21e |
183 | } |
c7b9dd21 |
184 | elsif ($fstype =~ /^MacOS/si) { |
185 | ($dirpath,$basename) = ($fullname =~ /^(.*:)?(.*)/s); |
95e8664e |
186 | $dirpath = ':' unless $dirpath; |
a0d0e21e |
187 | } |
55497cff |
188 | elsif ($fstype =~ /^AmigaOS/i) { |
c7b9dd21 |
189 | ($dirpath,$basename) = ($fullname =~ /(.*[:\/])?(.*)/s); |
a3156fc3 |
190 | $dirpath = './' unless $dirpath; |
55497cff |
191 | } |
748a9306 |
192 | elsif ($fstype !~ /^VMS/i) { # default to Unix |
c7b9dd21 |
193 | ($dirpath,$basename) = ($fullname =~ m#^(.*/)?(.*)#s); |
e3830a4e |
194 | if ($^O eq 'VMS' and $fullname =~ m:^(/[^/]+/000000(/|$))(.*):) { |
491527d0 |
195 | # dev:[000000] is top of VMS tree, similar to Unix '/' |
e3830a4e |
196 | # so strip it off and treat the rest as "normal" |
197 | my $devspec = $1; |
198 | my $remainder = $3; |
199 | ($dirpath,$basename) = ($remainder =~ m#^(.*/)?(.*)#s); |
200 | $dirpath = $devspec.$dirpath; |
491527d0 |
201 | } |
f0c6ccdf |
202 | $dirpath = './' unless $dirpath; |
a0d0e21e |
203 | } |
204 | |
205 | if (@suffices) { |
f06db76b |
206 | $tail = ''; |
a0d0e21e |
207 | foreach $suffix (@suffices) { |
ee2ff9ea |
208 | my $pat = ($igncase ? '(?i)' : '') . "($suffix)\$"; |
c7b9dd21 |
209 | if ($basename =~ s/$pat//s) { |
12cbd720 |
210 | $taint .= substr($suffix,0,0); |
44a8e56a |
211 | $tail = $1 . $tail; |
a0d0e21e |
212 | } |
213 | } |
214 | } |
215 | |
12cbd720 |
216 | $tail .= $taint if defined $tail; # avoid warning if $tail == undef |
8d6d96c1 |
217 | wantarray ? ($basename .= $taint, $dirpath .= $taint, $tail) |
218 | : $basename .= $taint; |
a0d0e21e |
219 | } |
220 | |
221 | |
222 | # basename() - returns first element of list returned by fileparse() |
223 | |
224 | sub basename { |
748a9306 |
225 | my($name) = shift; |
226 | (fileparse($name, map("\Q$_\E",@_)))[0]; |
a0d0e21e |
227 | } |
7e2183d3 |
228 | |
a0d0e21e |
229 | |
230 | # dirname() - returns device and directory portion of file specification |
231 | # Behavior matches that of Unix dirname(1) exactly for Unix and MSDOS |
748a9306 |
232 | # filespecs except for names ending with a separator, e.g., "/xx/yy/". |
233 | # This differs from the second element of the list returned |
a0d0e21e |
234 | # by fileparse() in that the trailing '/' (Unix) or '\' (MSDOS) (and |
235 | # the last directory name if the filespec ends in a '/' or '\'), is lost. |
236 | |
237 | sub dirname { |
238 | my($basename,$dirname) = fileparse($_[0]); |
239 | my($fstype) = $Fileparse_fstype; |
240 | |
241 | if ($fstype =~ /VMS/i) { |
748a9306 |
242 | if ($_[0] =~ m#/#) { $fstype = '' } |
7e2183d3 |
243 | else { return $dirname || $ENV{DEFAULT} } |
a0d0e21e |
244 | } |
084592ab |
245 | if ($fstype =~ /MacOS/i) { |
246 | if( !length($basename) && $dirname !~ /^[^:]+:\z/) { |
247 | $dirname =~ s/([^:]):\z/$1/s; |
248 | ($basename,$dirname) = fileparse $dirname; |
249 | } |
250 | $dirname .= ":" unless $dirname =~ /:\z/; |
251 | } |
a0d0e21e |
252 | elsif ($fstype =~ /MSDOS/i) { |
c7b9dd21 |
253 | $dirname =~ s/([^:])[\\\/]*\z/$1/; |
42568e28 |
254 | unless( length($basename) ) { |
255 | ($basename,$dirname) = fileparse $dirname; |
c7b9dd21 |
256 | $dirname =~ s/([^:])[\\\/]*\z/$1/; |
42568e28 |
257 | } |
a0d0e21e |
258 | } |
68dc0745 |
259 | elsif ($fstype =~ /MSWin32/i) { |
c7b9dd21 |
260 | $dirname =~ s/([^:])[\\\/]*\z/$1/; |
68dc0745 |
261 | unless( length($basename) ) { |
262 | ($basename,$dirname) = fileparse $dirname; |
c7b9dd21 |
263 | $dirname =~ s/([^:])[\\\/]*\z/$1/; |
68dc0745 |
264 | } |
265 | } |
55497cff |
266 | elsif ($fstype =~ /AmigaOS/i) { |
c7b9dd21 |
267 | if ( $dirname =~ /:\z/) { return $dirname } |
55497cff |
268 | chop $dirname; |
c7b9dd21 |
269 | $dirname =~ s#[^:/]+\z## unless length($basename); |
55497cff |
270 | } |
084592ab |
271 | else { |
c7b9dd21 |
272 | $dirname =~ s:(.)/*\z:$1:s; |
42568e28 |
273 | unless( length($basename) ) { |
274 | local($File::Basename::Fileparse_fstype) = $fstype; |
275 | ($basename,$dirname) = fileparse $dirname; |
c7b9dd21 |
276 | $dirname =~ s:(.)/*\z:$1:s; |
42568e28 |
277 | } |
a0d0e21e |
278 | } |
279 | |
280 | $dirname; |
281 | } |
282 | |
44a8e56a |
283 | fileparse_set_fstype $^O; |
a0d0e21e |
284 | |
285 | 1; |