1 package File::Basename;
5 fileparse - split a pathname into pieces
7 basename - extract just the filename from a path
9 dirname - extract just the directory from a path
15 ($name,$path,$suffix) = fileparse($fullname,@suffixlist)
16 fileparse_set_fstype($os_string);
17 $basename = basename($fullname,@suffixlist);
18 $dirname = dirname($fullname);
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");
27 These routines allow you to parse file specifications into useful
28 pieces using the syntax of different operating systems.
32 =item fileparse_set_fstype
34 You select the syntax via the routine fileparse_set_fstype().
36 If the argument passed to it contains one of the substrings
37 "VMS", "MSDOS", "MacOS", "AmigaOS" or "MSWin32", the file specification
38 syntax of that operating system is used in future calls to
39 fileparse(), basename(), and dirname(). If it contains none of
40 these substrings, UNIX syntax is used. This pattern matching is
41 case-insensitive. If you've selected VMS syntax, and the file
42 specification you pass to one of these routines contains a "/",
43 they assume you are using UNIX emulation and apply the UNIX syntax
44 rules instead, for that function call only.
46 If the argument passed to it contains one of the substrings "VMS",
47 "MSDOS", "MacOS", "AmigaOS", "os2", "MSWin32" or "RISCOS", then the pattern
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).
52 If you haven't called fileparse_set_fstype(), the syntax is chosen
53 by examining the builtin variable C<$^O> according to these rules.
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.
68 You are guaranteed that if you concatenate B<path>, B<name>, and
69 B<suffix> together in that order, the result will denote the same
70 file as the input file specification.
76 Using UNIX file syntax:
78 ($base,$path,$type) = fileparse('/virgil/aeneid/draft.book7',
84 $path eq '/virgil/aeneid/',
87 Similarly, using VMS syntax:
89 ($name,$dir,$type) = fileparse('Doc_Root:[Help]Rhetoric.Rnh',
95 $dir eq 'Doc_Root:[Help]'
102 The basename() routine returns the first element of the list produced
103 by calling fileparse() with the same arguments, except that it always
104 quotes metacharacters in the given suffixes. It is provided for
105 programmer compatibility with the UNIX shell command basename(1).
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
112 input file specification. (Under VMS, if there is no directory information
113 in the input file specification, then the current default device and
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
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<.>).
128 @EXPORT = qw(fileparse fileparse_set_fstype basename dirname);
130 #use vars qw($VERSION $Fileparse_fstype $Fileparse_igncase);
134 # fileparse_set_fstype() - specify OS-based rules used in future
135 # calls to routines in this package
137 # Currently recognized values: VMS, MSDOS, MacOS, AmigaOS, os2, RISCOS
138 # Any other name uses Unix-style rules and is case-sensitive
140 sub fileparse_set_fstype {
141 my @old = ($Fileparse_fstype, $Fileparse_igncase);
143 $Fileparse_fstype = $_[0];
144 $Fileparse_igncase = ($_[0] =~ /^(?:MacOS|VMS|AmigaOS|os2|RISCOS|MSWin32)/i);
146 wantarray ? @old : $old[0];
149 # fileparse() - parse file specification
151 # Version 2.4 27-Sep-1996 Charles Bailey bailey@genetics.upenn.edu
155 my($fullname,@suffices) = @_;
156 my($fstype,$igncase) = ($Fileparse_fstype, $Fileparse_igncase);
157 my($dirpath,$tail,$suffix,$basename);
159 if ($fstype =~ /^VMS/i) {
160 if ($fullname =~ m#/#) { $fstype = '' } # We're doing Unix emulation
162 ($dirpath,$basename) = ($fullname =~ /^(.*[:>\]])?(.*)/);
165 if ($fstype =~ /^MS(DOS|Win32)/i) {
166 ($dirpath,$basename) = ($fullname =~ /^((?:.*[:\\\/])?)(.*)/);
167 $dirpath .= '.\\' unless $dirpath =~ /[\\\/]$/;
169 elsif ($fstype =~ /^MacOS/i) {
170 ($dirpath,$basename) = ($fullname =~ /^(.*:)?(.*)/);
172 elsif ($fstype =~ /^AmigaOS/i) {
173 ($dirpath,$basename) = ($fullname =~ /(.*[:\/])?(.*)/);
174 $dirpath = './' unless $dirpath;
176 elsif ($fstype !~ /^VMS/i) { # default to Unix
177 ($dirpath,$basename) = ($fullname =~ m#^(.*/)?(.*)#);
178 $dirpath = './' unless $dirpath;
183 foreach $suffix (@suffices) {
184 my $pat = ($igncase ? '(?i)' : '') . "($suffix)\$";
185 if ($basename =~ s/$pat//) {
191 wantarray ? ($basename,$dirpath,$tail) : $basename;
195 # basename() - returns first element of list returned by fileparse()
199 (fileparse($name, map("\Q$_\E",@_)))[0];
203 # dirname() - returns device and directory portion of file specification
204 # Behavior matches that of Unix dirname(1) exactly for Unix and MSDOS
205 # filespecs except for names ending with a separator, e.g., "/xx/yy/".
206 # This differs from the second element of the list returned
207 # by fileparse() in that the trailing '/' (Unix) or '\' (MSDOS) (and
208 # the last directory name if the filespec ends in a '/' or '\'), is lost.
211 my($basename,$dirname) = fileparse($_[0]);
212 my($fstype) = $Fileparse_fstype;
214 if ($fstype =~ /VMS/i) {
215 if ($_[0] =~ m#/#) { $fstype = '' }
216 else { return $dirname || $ENV{DEFAULT} }
218 if ($fstype =~ /MacOS/i) { return $dirname }
219 elsif ($fstype =~ /MSDOS/i) {
220 $dirname =~ s/([^:])[\\\/]*$/$1/;
221 unless( length($basename) ) {
222 ($basename,$dirname) = fileparse $dirname;
223 $dirname =~ s/([^:])[\\\/]*$/$1/;
226 elsif ($fstype =~ /MSWin32/i) {
227 $dirname =~ s/([^:])[\\\/]*$/$1/;
228 unless( length($basename) ) {
229 ($basename,$dirname) = fileparse $dirname;
230 $dirname =~ s/([^:])[\\\/]*$/$1/;
233 elsif ($fstype =~ /AmigaOS/i) {
234 if ( $dirname =~ /:$/) { return $dirname }
236 $dirname =~ s#[^:/]+$## unless length($basename);
239 $dirname =~ s:(.)/*$:$1:;
240 unless( length($basename) ) {
241 local($File::Basename::Fileparse_fstype) = $fstype;
242 ($basename,$dirname) = fileparse $dirname;
243 $dirname =~ s:(.)/*$:$1:;
250 fileparse_set_fstype $^O;