home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _00a26798af763ad1c8f4125b951183d4 < prev    next >
Text File  |  2000-03-23  |  7KB  |  183 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::Spec::Mac - File::Spec for MacOS</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> File::Spec::Mac - File::Spec for MacOS</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="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27. </UL>
  28. <!-- INDEX END -->
  29.  
  30. <HR>
  31. <P>
  32. <H1><A NAME="name">NAME</A></H1>
  33. <P>File::Spec::Mac - File::Spec for MacOS</P>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Linux</LI>
  39. <LI>Solaris</LI>
  40. <LI>Windows</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.  require File::Spec::Mac; # Done internally by File::Spec if needed</PRE>
  46. <P>
  47. <HR>
  48. <H1><A NAME="description">DESCRIPTION</A></H1>
  49. <P>Methods for manipulating file specifications.</P>
  50. <P>
  51. <HR>
  52. <H1><A NAME="methods">METHODS</A></H1>
  53. <DL>
  54. <DT><STRONG><A NAME="item_canonpath">canonpath</A></STRONG><BR>
  55. <DD>
  56. On MacOS, there's nothing to be done.  Returns what it's given.
  57. <P></P>
  58. <DT><STRONG><A NAME="item_catdir">catdir</A></STRONG><BR>
  59. <DD>
  60. Concatenate two or more directory names to form a complete path ending with 
  61. a directory.  Put a trailing : on the end of the complete path if there 
  62. isn't one, because that's what's done in MacPerl's environment.
  63. <P>The fundamental requirement of this routine is that</P>
  64. <PRE>
  65.           File::Spec->catdir(split(":",$path)) eq $path</PRE>
  66. <P>But because of the nature of Macintosh paths, some additional 
  67. possibilities are allowed to make using this routine give reasonable results 
  68. for some common situations.  Here are the rules that are used.  Each 
  69. argument has its trailing ``:'' removed.  Each argument, except the first,
  70. has its leading ``:'' removed.  They are then joined together by a ``:''.</P>
  71. <P>So</P>
  72. <PRE>
  73.           File::Spec->catdir("a","b") = "a:b:"
  74.           File::Spec->catdir("a:",":b") = "a:b:"
  75.           File::Spec->catdir("a:","b") = "a:b:"
  76.           File::Spec->catdir("a",":b") = "a:b"
  77.           File::Spec->catdir("a","","b") = "a::b"</PRE>
  78. <P>etc.</P>
  79. <P>To get a relative path (one beginning with :), begin the first argument with :
  80. or put a ``'' as the first argument.</P>
  81. <P>If you don't want to worry about these rules, never allow a ``:'' on the ends 
  82. of any of the arguments except at the beginning of the first.</P>
  83. <P>Under MacPerl, there is an additional ambiguity.  Does the user intend that</P>
  84. <PRE>
  85.           File::Spec->catfile("LWP","Protocol","http.pm")</PRE>
  86. <P>be relative or absolute?  There's no way of telling except by checking for the
  87. existence of LWP: or :LWP, and even there he may mean a dismounted volume or
  88. a relative path in a different directory (like in @INC).   So those checks
  89. aren't done here. This routine will treat this as absolute.</P>
  90. <P></P>
  91. <DT><STRONG><A NAME="item_catfile">catfile</A></STRONG><BR>
  92. <DD>
  93. Concatenate one or more directory names and a filename to form a
  94. complete path ending with a filename.  Since this uses catdir, the
  95. same caveats apply.  Note that the leading : is removed from the filename,
  96. so that
  97. <PRE>
  98.           File::Spec->catfile($ENV{HOME},"file");</PRE>
  99. <P>and</P>
  100. <PRE>
  101.           File::Spec->catfile($ENV{HOME},":file");</PRE>
  102. <P>give the same answer, as one might expect.</P>
  103. <P></P>
  104. <DT><STRONG><A NAME="item_curdir">curdir</A></STRONG><BR>
  105. <DD>
  106. Returns a string representing the current directory.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_devnull">devnull</A></STRONG><BR>
  109. <DD>
  110. Returns a string representing the null device.
  111. <P></P>
  112. <DT><STRONG><A NAME="item_rootdir">rootdir</A></STRONG><BR>
  113. <DD>
  114. Returns a string representing the root directory.  Under MacPerl,
  115. returns the name of the startup volume, since that's the closest in
  116. concept, although other volumes aren't rooted there.
  117. <P></P>
  118. <DT><STRONG><A NAME="item_tmpdir">tmpdir</A></STRONG><BR>
  119. <DD>
  120. Returns a string representation of the first existing directory
  121. from the following list or '' if none exist:
  122. <PRE>
  123.     $ENV{TMPDIR}</PRE>
  124. <P></P>
  125. <DT><STRONG><A NAME="item_updir">updir</A></STRONG><BR>
  126. <DD>
  127. Returns a string representing the parent directory.
  128. <P></P>
  129. <DT><STRONG><A NAME="item_file_name_is_absolute">file_name_is_absolute</A></STRONG><BR>
  130. <DD>
  131. Takes as argument a path and returns true, if it is an absolute path.  In 
  132. the case where a name can be either relative or absolute (for example, a 
  133. folder named ``HD'' in the current working directory on a drive named ``HD''), 
  134. relative wins.  Use ``:'' in the appropriate place in the path if you want to
  135. distinguish unambiguously.
  136. <P></P>
  137. <DT><STRONG><A NAME="item_path">path</A></STRONG><BR>
  138. <DD>
  139. Returns the null list for the MacPerl application, since the concept is 
  140. usually meaningless under MacOS. But if you're using the MacPerl tool under 
  141. MPW, it gives back $ENV{Commands} suitably split, as is done in 
  142. :lib:ExtUtils:MM_Mac.pm.
  143. <P></P>
  144. <DT><STRONG><A NAME="item_splitpath">splitpath</A></STRONG><BR>
  145. <DD>
  146. <DT><STRONG><A NAME="item_splitdir">splitdir</A></STRONG><BR>
  147. <DD>
  148. <DT><STRONG><A NAME="item_catpath">catpath</A></STRONG><BR>
  149. <DD>
  150. <DT><STRONG><A NAME="item_abs2rel">abs2rel</A></STRONG><BR>
  151. <DD>
  152. <DT><STRONG><A NAME="item_rel2abs">rel2abs</A></STRONG><BR>
  153. <DD>
  154. Converts a relative path to an absolute path.
  155. <PRE>
  156.     $abs_path = File::Spec->rel2abs( $destination ) ;
  157.     $abs_path = File::Spec->rel2abs( $destination, $base ) ;</PRE>
  158. <P>If $base is not present or '', then <EM>cwd()</EM> is used. If $base is relative, 
  159. then it is converted to absolute form using <A HREF="#rel2abs()">rel2abs()</A>. This means that it
  160. is taken to be relative to <EM>cwd()</EM>.</P>
  161. <P>On systems with the concept of a volume, this assumes that both paths 
  162. are on the $base volume, and ignores the $destination volume.</P>
  163. <P>On systems that have a grammar that indicates filenames, this ignores the 
  164. $base filename as well. Otherwise all path components are assumed to be
  165. directories.</P>
  166. <P>If $path is absolute, it is cleaned up and returned using <A HREF="#canonpath()">canonpath()</A>.</P>
  167. <P>Based on code written by Shigio Yamaguchi.</P>
  168. <P>No checks against the filesystem are made.</P>
  169. <P></P></DL>
  170. <P>
  171. <HR>
  172. <H1><A NAME="see also">SEE ALSO</A></H1>
  173. <P><A HREF="../../../lib/File/Spec.html">the File::Spec manpage</A></P>
  174. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  175. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  176. <STRONG><P CLASS=block> File::Spec::Mac - File::Spec for MacOS</P></STRONG>
  177. </TD></TR>
  178. </TABLE>
  179.  
  180. </BODY>
  181.  
  182. </HTML>
  183.