📄 spec.pm
字号:
package File::Spec;use strict;use vars qw(@ISA $VERSION);$VERSION = '3.27';$VERSION = eval $VERSION;my %module = (MacOS => 'Mac', MSWin32 => 'Win32', os2 => 'OS2', VMS => 'VMS', epoc => 'Epoc', NetWare => 'Win32', # Yes, File::Spec::Win32 works on NetWare. symbian => 'Win32', # Yes, File::Spec::Win32 works on symbian. dos => 'OS2', # Yes, File::Spec::OS2 works on DJGPP. cygwin => 'Cygwin');my $module = $module{$^O} || 'Unix';require "File/Spec/$module.pm";@ISA = ("File::Spec::$module");1;__END__=head1 NAMEFile::Spec - portably perform operations on file names=head1 SYNOPSIS use File::Spec; $x=File::Spec->catfile('a', 'b', 'c');which returns 'a/b/c' under Unix. Or: use File::Spec::Functions; $x = catfile('a', 'b', 'c');=head1 DESCRIPTIONThis module is designed to support operations commonly performed on filespecifications (usually called "file names", but not to be confused with thecontents of a file, or Perl's file handles), such as concatenating severaldirectory and file names into a single path, or determining whether a pathis rooted. It is based on code directly taken from MakeMaker 5.17, codewritten by Andreas KE<ouml>nig, Andy Dougherty, Charles Bailey, IlyaZakharevich, Paul Schinder, and others.Since these functions are different for most operating systems, each set ofOS specific routines is available in a separate module, including: File::Spec::Unix File::Spec::Mac File::Spec::OS2 File::Spec::Win32 File::Spec::VMSThe module appropriate for the current OS is automatically loaded byFile::Spec. Since some modules (like VMS) make use of facilities availableonly under that OS, it may not be possible to load all modules under alloperating systems.Since File::Spec is object oriented, subroutines should not be called directly,as in: File::Spec::catfile('a','b');but rather as class methods: File::Spec->catfile('a','b');For simple uses, L<File::Spec::Functions> provides convenient functionalforms of these methods.=head1 METHODS=over 2=item canonpathX<canonpath>No physical check on the filesystem, but a logical cleanup of apath. $cpath = File::Spec->canonpath( $path ) ;Note that this does *not* collapse F<x/../y> sections into F<y>. Thisis by design. If F</foo> on your system is a symlink to F</bar/baz>,then F</foo/../quux> is actually F</bar/quux>, not F</quux> as a naiveF<../>-removal would give you. If you want to do this kind ofprocessing, you probably want C<Cwd>'s C<realpath()> function toactually traverse the filesystem cleaning up paths like this.=item catdirX<catdir>Concatenate two or more directory names to form a complete path endingwith a directory. But remove the trailing slash from the resultingstring, because it doesn't look good, isn't necessary and confusesOS/2. Of course, if this is the root directory, don't cut off thetrailing slash :-) $path = File::Spec->catdir( @directories );=item catfileX<catfile>Concatenate one or more directory names and a filename to form acomplete path ending with a filename $path = File::Spec->catfile( @directories, $filename );=item curdirX<curdir>Returns a string representation of the current directory. $curdir = File::Spec->curdir();=item devnullX<devnull>Returns a string representation of the null device. $devnull = File::Spec->devnull();=item rootdirX<rootdir>Returns a string representation of the root directory. $rootdir = File::Spec->rootdir();=item tmpdirX<tmpdir>Returns a string representation of the first writable directory from alist of possible temporary directories. Returns the current directoryif no writable temporary directories are found. The list of directorieschecked depends on the platform; e.g. File::Spec::Unix checks C<$ENV{TMPDIR}>(unless taint is on) and F</tmp>. $tmpdir = File::Spec->tmpdir();=item updirX<updir>Returns a string representation of the parent directory. $updir = File::Spec->updir();=item no_upwardsGiven a list of file names, strip out those that refer to a parentdirectory. (Does not strip symlinks, only '.', '..', and equivalents.) @paths = File::Spec->no_upwards( @paths );=item case_tolerantReturns a true or false value indicating, respectively, that alphabeticcase is not or is significant when comparing file specifications. $is_case_tolerant = File::Spec->case_tolerant();=item file_name_is_absoluteTakes as its argument a path, and returns true if it is an absolute path. $is_absolute = File::Spec->file_name_is_absolute( $path );This does not consult the local filesystem on Unix, Win32, OS/2, orMac OS (Classic). It does consult the working environment for VMS(see L<File::Spec::VMS/file_name_is_absolute>).=item pathX<path>Takes no argument. Returns the environment variable C<PATH> (or the localplatform's equivalent) as a list. @PATH = File::Spec->path();=item joinX<join, path>join is the same as catfile.=item splitpathX<splitpath> X<split, path>Splits a path in to volume, directory, and filename portions. On systemswith no concept of volume, returns '' for volume. ($volume,$directories,$file) = File::Spec->splitpath( $path ); ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );For systems with no syntax differentiating filenames from directories, assumes that the last file is a path unless C<$no_file> is true or atrailing separator or F</.> or F</..> is present. On Unix, this means that C<$no_file>true makes this return ( '', $path, '' ).The directory portion may or may not be returned with a trailing '/'.The results can be passed to L</catpath()> to get back a path equivalent to(usually identical to) the original path.=item splitdirX<splitdir> X<split, dir>The opposite of L</catdir()>. @dirs = File::Spec->splitdir( $directories );C<$directories> must be only the directory portion of the path on systems that have the concept of a volume or that have path syntax that differentiatesfiles from directories.Unlike just splitting the directories on the separator, emptydirectory names (C<''>) can be returned, because these are significanton some OSes.=item catpath()Takes volume, directory and file portions and returns an entire path. UnderUnix, C<$volume> is ignored, and directory and file are concatenated. A '/' isinserted if need be. On other OSes, C<$volume> is significant. $full_path = File::Spec->catpath( $volume, $directory, $file );=item abs2relX<abs2rel> X<absolute, path> X<relative, path>Takes a destination path and an optional base path returns a relative pathfrom the base path to the destination path: $rel_path = File::Spec->abs2rel( $path ) ; $rel_path = File::Spec->abs2rel( $path, $base ) ;If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> isrelative, then it is converted to absolute form usingL</rel2abs()>. This means that it is taken to be relative toL<Cwd::cwd()|Cwd>.On systems with the concept of volume, if C<$path> and C<$base> appear to beon two different volumes, we will not attempt to resolve the twopaths, and we will instead simply return C<$path>. Note that previousversions of this module ignored the volume of C<$base>, which resulted ingarbage results part of the time.On systems that have a grammar that indicates filenames, this ignores the C<$base> filename as well. Otherwise all path components are assumed to bedirectories.If C<$path> is relative, it is converted to absolute form using L</rel2abs()>.This means that it is taken to be relative to L<Cwd::cwd()|Cwd>.No checks against the filesystem are made. On VMS, there isinteraction with the working environment, as logicals andmacros are expanded.Based on code written by Shigio Yamaguchi.=item rel2abs()X<rel2abs> X<absolute, path> X<relative, path>Converts a relative path to an absolute path. $abs_path = File::Spec->rel2abs( $path ) ; $abs_path = File::Spec->rel2abs( $path, $base ) ;If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is relative,then it is converted to absolute form using L</rel2abs()>. This means that itis taken to be relative to L<Cwd::cwd()|Cwd>.On systems with the concept of volume, if C<$path> and C<$base> appear to beon two different volumes, we will not attempt to resolve the twopaths, and we will instead simply return C<$path>. Note that previousversions of this module ignored the volume of C<$base>, which resulted ingarbage results part of the time.On systems that have a grammar that indicates filenames, this ignores the C<$base> filename as well. Otherwise all path components are assumed to bedirectories.If C<$path> is absolute, it is cleaned up and returned using L</canonpath()>.No checks against the filesystem are made. On VMS, there isinteraction with the working environment, as logicals andmacros are expanded.Based on code written by Shigio Yamaguchi.=backFor further information, please see L<File::Spec::Unix>,L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, orL<File::Spec::VMS>.=head1 SEE ALSOL<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,L<ExtUtils::MakeMaker>=head1 AUTHORCurrently maintained by Ken Williams C<< <KWILLIAMS@cpan.org> >>.The vast majority of the code was written byKenneth Albanowski C<< <kjahds@kjahds.com> >>,Andy Dougherty C<< <doughera@lafayette.edu> >>,Andreas KE<ouml>nig C<< <A.Koenig@franz.ww.TU-Berlin.DE> >>,Tim Bunce C<< <Tim.Bunce@ig.co.uk> >>.VMS support by Charles Bailey C<< <bailey@newman.upenn.edu> >>.OS/2 support by Ilya Zakharevich C<< <ilya@math.ohio-state.edu> >>.Mac support by Paul Schinder C<< <schinder@pobox.com> >>, andThomas Wegner C<< <wegner_thomas@yahoo.com> >>.abs2rel() and rel2abs() written by Shigio Yamaguchi C<< <shigio@tamacom.com> >>,modified by Barrie Slaymaker C<< <barries@slaysys.com> >>.splitpath(), splitdir(), catpath() and catdir() by Barrie Slaymaker.=head1 COPYRIGHTCopyright (c) 2004 by the Perl 5 Porters. All rights reserved.This program is free software; you can redistribute it and/or modifyit under the same terms as Perl itself.=cut
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -