home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _c21165477bc6bd12f29dca38152c9f93 < prev    next >
Text File  |  2000-03-23  |  7KB  |  151 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>fileparse - split a pathname into pieces</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> fileparse - split a pathname into pieces</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>fileparse - split a pathname into pieces</P>
  33. <P>basename - extract just the filename from a path</P>
  34. <P>dirname - extract just the directory from a path</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.     use File::Basename;</PRE>
  47. <PRE>
  48.     ($name,$path,$suffix) = fileparse($fullname,@suffixlist)
  49.     fileparse_set_fstype($os_string);
  50.     $basename = basename($fullname,@suffixlist);
  51.     $dirname = dirname($fullname);</PRE>
  52. <PRE>
  53.     ($name,$path,$suffix) = fileparse("lib/File/Basename.pm","\.pm");
  54.     fileparse_set_fstype("VMS");
  55.     $basename = basename("lib/File/Basename.pm",".pm");
  56.     $dirname = dirname("lib/File/Basename.pm");</PRE>
  57. <P>
  58. <HR>
  59. <H1><A NAME="description">DESCRIPTION</A></H1>
  60. <P>These routines allow you to parse file specifications into useful
  61. pieces using the syntax of different operating systems.</P>
  62. <DL>
  63. <DT><STRONG><A NAME="item_fileparse_set_fstype">fileparse_set_fstype</A></STRONG><BR>
  64. <DD>
  65. You select the syntax via the routine fileparse_set_fstype().
  66. <P>If the argument passed to it contains one of the substrings
  67. ``VMS'', ``MSDOS'', ``MacOS'', ``AmigaOS'' or ``MSWin32'', the file specification 
  68. syntax of that operating system is used in future calls to 
  69. fileparse(), basename(), and dirname().  If it contains none of
  70. these substrings, Unix syntax is used.  This pattern matching is
  71. case-insensitive.  If you've selected VMS syntax, and the file
  72. specification you pass to one of these routines contains a ``/'',
  73. they assume you are using Unix emulation and apply the Unix syntax
  74. rules instead, for that function call only.</P>
  75. <P>If the argument passed to it contains one of the substrings ``VMS'',
  76. ``MSDOS'', ``MacOS'', ``AmigaOS'', ``os2'', ``MSWin32'' or ``RISCOS'', then the pattern
  77. matching for suffix removal is performed without regard for case,
  78. since those systems are not case-sensitive when opening existing files
  79. (though some of them preserve case on file creation).</P>
  80. <P>If you haven't called fileparse_set_fstype(), the syntax is chosen
  81. by examining the builtin variable <CODE>$^O</CODE> according to these rules.</P>
  82. <P></P>
  83. <DT><STRONG><A NAME="item_fileparse">fileparse</A></STRONG><BR>
  84. <DD>
  85. The <A HREF="#item_fileparse"><CODE>fileparse()</CODE></A> routine divides a file specification into three
  86. parts: a leading <STRONG>path</STRONG>, a file <STRONG>name</STRONG>, and a <STRONG>suffix</STRONG>.  The
  87. <STRONG>path</STRONG> contains everything up to and including the last directory
  88. separator in the input file specification.  The remainder of the input
  89. file specification is then divided into <STRONG>name</STRONG> and <STRONG>suffix</STRONG> based on
  90. the optional patterns you specify in <CODE>@suffixlist</CODE>.  Each element of
  91. this list is interpreted as a regular expression, and is matched
  92. against the end of <STRONG>name</STRONG>.  If this succeeds, the matching portion of
  93. <STRONG>name</STRONG> is removed and prepended to <STRONG>suffix</STRONG>.  By proper use of
  94. <CODE>@suffixlist</CODE>, you can remove file types or versions for examination.
  95. <P>You are guaranteed that if you concatenate <STRONG>path</STRONG>, <STRONG>name</STRONG>, and
  96. <STRONG>suffix</STRONG> together in that order, the result will denote the same
  97. file as the input file specification.</P>
  98. <P></P></DL>
  99. <P>
  100. <HR>
  101. <H1><A NAME="examples">EXAMPLES</A></H1>
  102. <P>Using Unix file syntax:</P>
  103. <PRE>
  104.     ($base,$path,$type) = fileparse('/virgil/aeneid/draft.book7',
  105.                                     '\.book\d+');</PRE>
  106. <P>would yield</P>
  107. <PRE>
  108.     $base eq 'draft'
  109.     $path eq '/virgil/aeneid/',
  110.     $type eq '.book7'</PRE>
  111. <P>Similarly, using VMS syntax:</P>
  112. <PRE>
  113.     ($name,$dir,$type) = fileparse('Doc_Root:[Help]Rhetoric.Rnh',
  114.                                    '\..*');</PRE>
  115. <P>would yield</P>
  116. <PRE>
  117.     $name eq 'Rhetoric'
  118.     $dir  eq 'Doc_Root:[Help]'
  119.     $type eq '.Rnh'</PRE>
  120. <DL>
  121. <DT><STRONG><A NAME="item_basename"><CODE>basename</CODE></A></STRONG><BR>
  122. <DD>
  123. The <A HREF="#item_basename"><CODE>basename()</CODE></A> routine returns the first element of the list produced
  124. by calling <A HREF="#item_fileparse"><CODE>fileparse()</CODE></A> with the same arguments, except that it always
  125. quotes metacharacters in the given suffixes.  It is provided for
  126. programmer compatibility with the Unix shell command basename(1).
  127. <P></P>
  128. <DT><STRONG><A NAME="item_dirname"><CODE>dirname</CODE></A></STRONG><BR>
  129. <DD>
  130. The <A HREF="#item_dirname"><CODE>dirname()</CODE></A> routine returns the directory portion of the input file
  131. specification.  When using VMS or MacOS syntax, this is identical to the
  132. second element of the list produced by calling <A HREF="#item_fileparse"><CODE>fileparse()</CODE></A> with the same
  133. input file specification.  (Under VMS, if there is no directory information
  134. in the input file specification, then the current default device and
  135. directory are returned.)  When using Unix or MSDOS syntax, the return
  136. value conforms to the behavior of the Unix shell command dirname(1).  This
  137. is usually the same as the behavior of fileparse(), but differs in some
  138. cases.  For example, for the input file specification <EM>lib/</EM>, <A HREF="#item_fileparse"><CODE>fileparse()</CODE></A>
  139. considers the directory name to be <EM>lib/</EM>, while <A HREF="#item_dirname"><CODE>dirname()</CODE></A> considers the
  140. directory name to be <EM>.</EM>).
  141. <P></P></DL>
  142. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  143. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  144. <STRONG><P CLASS=block> fileparse - split a pathname into pieces</P></STRONG>
  145. </TD></TR>
  146. </TABLE>
  147.  
  148. </BODY>
  149.  
  150. </HTML>
  151.