<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/System/Path.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-comment'>{- arch-tag: Path utilities main file
<a name="line-3"></a>Copyright (C) 2004-2005 John Goerzen <jgoerzen@complete.org>
<a name="line-4"></a>
<a name="line-5"></a>This program is free software; you can redistribute it and/or modify
<a name="line-6"></a>it under the terms of the GNU General Public License as published by
<a name="line-7"></a>the Free Software Foundation; either version 2 of the License, or
<a name="line-8"></a>(at your option) any later version.
<a name="line-9"></a>
<a name="line-10"></a>This program is distributed in the hope that it will be useful,
<a name="line-11"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-12"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<a name="line-13"></a>GNU General Public License for more details.
<a name="line-14"></a>
<a name="line-15"></a>You should have received a copy of the GNU General Public License
<a name="line-16"></a>along with this program; if not, write to the Free Software
<a name="line-17"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<a name="line-18"></a>-}</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-comment'>{- |
<a name="line-21"></a> Module : System.Path
<a name="line-22"></a> Copyright : Copyright (C) 2004-2005 John Goerzen
<a name="line-23"></a> License : GNU GPL, version 2 or above
<a name="line-24"></a>
<a name="line-25"></a> Maintainer : John Goerzen <jgoerzen@complete.org>
<a name="line-26"></a> Stability : provisional
<a name="line-27"></a> Portability: portable
<a name="line-28"></a>
<a name="line-29"></a>This module provides various helpful utilities for dealing with path and
<a name="line-30"></a>file names, directories, and related support.
<a name="line-31"></a>
<a name="line-32"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-33"></a>-}</span>
<a name="line-34"></a>
<a name="line-35"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span><span class='hs-layout'>(</span><span class='hs-comment'>-- * Name processing</span>
<a name="line-36"></a> <span class='hs-varid'>splitExt</span><span class='hs-layout'>,</span> <span class='hs-varid'>absNormPath</span><span class='hs-layout'>,</span> <span class='hs-varid'>secureAbsNormPath</span><span class='hs-layout'>,</span>
<a name="line-37"></a> <span class='hs-comment'>-- * Directory Processing</span>
<a name="line-38"></a> <span class='hs-varid'>recurseDir</span><span class='hs-layout'>,</span> <span class='hs-varid'>recurseDirStat</span><span class='hs-layout'>,</span> <span class='hs-varid'>recursiveRemove</span><span class='hs-layout'>,</span>
<a name="line-39"></a> <span class='hs-varid'>bracketCWD</span><span class='hs-layout'>,</span>
<a name="line-40"></a> <span class='hs-comment'>-- * Temporary Directories</span>
<a name="line-41"></a> <span class='hs-varid'>mktmpdir</span><span class='hs-layout'>,</span> <span class='hs-varid'>brackettmpdir</span><span class='hs-layout'>,</span> <span class='hs-varid'>brackettmpdirCWD</span>
<a name="line-42"></a> <span class='hs-layout'>)</span>
<a name="line-43"></a><span class='hs-keyword'>where</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span>
<a name="line-45"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-46"></a><span class='hs-cpp'>#if !(defined(mingw32_HOST_OS) || defined(mingw32_TARGET_OS) || defined(__MINGW32__))</span>
<a name="line-47"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Posix</span><span class='hs-varop'>.</span><span class='hs-conid'>Files</span>
<a name="line-48"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Posix</span><span class='hs-varop'>.</span><span class='hs-conid'>Directory</span> <span class='hs-layout'>(</span><span class='hs-varid'>createDirectory</span><span class='hs-layout'>)</span>
<a name="line-49"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Posix</span><span class='hs-varop'>.</span><span class='hs-conid'>Temp</span>
<a name="line-50"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Directory</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>createDirectory</span><span class='hs-layout'>)</span>
<a name="line-51"></a><span class='hs-cpp'>#else</span>
<a name="line-52"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Directory</span>
<a name="line-53"></a><span class='hs-cpp'>#endif</span>
<a name="line-54"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span>
<a name="line-55"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-56"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span><span class='hs-varop'>.</span><span class='hs-conid'>NameManip</span>
<a name="line-57"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>HVFS</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="splitExt"></a><span class='hs-comment'>{- | Splits a pathname into a tuple representing the root of the name and
<a name="line-60"></a>the extension. The extension is considered to be all characters from the last
<a name="line-61"></a>dot after the last slash to the end. Either returned string may be empty. -}</span>
<a name="line-62"></a><span class='hs-comment'>-- FIXME: See 6.4 API when released.</span>
<a name="line-63"></a><span class='hs-definition'>splitExt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-64"></a><span class='hs-definition'>splitExt</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span>
<a name="line-65"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>dotindex</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>alwaysElemRIndex</span> <span class='hs-chr'>'.'</span> <span class='hs-varid'>path</span>
<a name="line-66"></a> <span class='hs-varid'>slashindex</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>alwaysElemRIndex</span> <span class='hs-chr'>'/'</span> <span class='hs-varid'>path</span>
<a name="line-67"></a> <span class='hs-keyword'>in</span>
<a name="line-68"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>dotindex</span> <span class='hs-varop'><=</span> <span class='hs-varid'>slashindex</span>
<a name="line-69"></a> <span class='hs-keyword'>then</span> <span class='hs-layout'>(</span><span class='hs-varid'>path</span><span class='hs-layout'>,</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-70"></a> <span class='hs-keyword'>else</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>take</span> <span class='hs-varid'>dotindex</span> <span class='hs-varid'>path</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>drop</span> <span class='hs-varid'>dotindex</span> <span class='hs-varid'>path</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="absNormPath"></a><span class='hs-comment'>{- | Make an absolute, normalized version of a path with all double slashes,
<a name="line-73"></a>dot, and dotdot entries removed.
<a name="line-74"></a>
<a name="line-75"></a>The first parameter is the base for the absolut calculation; in many cases,
<a name="line-76"></a>it would correspond to the current working directory.
<a name="line-77"></a>
<a name="line-78"></a>The second parameter is the pathname to transform. If it is already absolute,
<a name="line-79"></a>the first parameter is ignored.
<a name="line-80"></a>
<a name="line-81"></a>Nothing may be returned if there's an error; for instance, too many @..@ entries
<a name="line-82"></a>for the given path.
<a name="line-83"></a>-}</span>
<a name="line-84"></a><span class='hs-definition'>absNormPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Absolute path for use with starting directory</span>
<a name="line-85"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The path name to make absolute</span>
<a name="line-86"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Result</span>
<a name="line-87"></a><span class='hs-definition'>absNormPath</span> <span class='hs-varid'>base</span> <span class='hs-varid'>thepath</span> <span class='hs-keyglyph'>=</span>
<a name="line-88"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>abs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>absolute_path_by</span> <span class='hs-varid'>base</span> <span class='hs-varid'>thepath</span>
<a name="line-89"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>guess_dotdot</span> <span class='hs-layout'>(</span><span class='hs-varid'>normalise_path</span> <span class='hs-varid'>abs</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-90"></a> <span class='hs-conid'>Just</span> <span class='hs-str'>"."</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-str'>"/"</span>
<a name="line-91"></a> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>x</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="secureAbsNormPath"></a><span class='hs-comment'>{- | Like absNormPath, but returns Nothing if the generated result is not
<a name="line-94"></a>the passed base path or a subdirectory thereof. -}</span>
<a name="line-95"></a><span class='hs-definition'>secureAbsNormPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ Absolute path for use with starting directory</span>
<a name="line-96"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The path to make absolute</span>
<a name="line-97"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span>
<a name="line-98"></a><span class='hs-definition'>secureAbsNormPath</span> <span class='hs-varid'>base</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>absNormPath</span> <span class='hs-varid'>base</span> <span class='hs-varid'>s</span>
<a name="line-99"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>startswith</span> <span class='hs-varid'>base</span> <span class='hs-varid'>p</span>
<a name="line-100"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-varid'>p</span>
<a name="line-101"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>fail</span> <span class='hs-str'>""</span>
<a name="line-102"></a>
<a name="line-103"></a><a name="mktmpdir"></a><span class='hs-comment'>{- | Creates a temporary directory for your use.
<a name="line-104"></a>
<a name="line-105"></a>The passed string should be a template suitable for mkstemp; that is, end with
<a name="line-106"></a>@\"XXXXXX\"@.
<a name="line-107"></a>
<a name="line-108"></a>Your string should probably start with the value returned from
<a name="line-109"></a>System.Directory.getTemporaryDirectory.
<a name="line-110"></a>
<a name="line-111"></a>The name of the directory created will be returned.
<a name="line-112"></a>-}</span>
<a name="line-113"></a><span class='hs-definition'>mktmpdir</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-114"></a><span class='hs-cpp'>#if !(defined(mingw32_HOST_OS) || defined(mingw32_TARGET_OS) || defined(__MINGW32__))</span>
<a name="line-115"></a><span class='hs-definition'>mktmpdir</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span>
<a name="line-116"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mkstemp</span> <span class='hs-varid'>x</span>
<a name="line-117"></a> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>dirname</span><span class='hs-layout'>,</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>y</span>
<a name="line-118"></a> <span class='hs-varid'>hClose</span> <span class='hs-varid'>h</span>
<a name="line-119"></a> <span class='hs-varid'>removeFile</span> <span class='hs-varid'>dirname</span>
<a name="line-120"></a> <span class='hs-varid'>createDirectory</span> <span class='hs-varid'>dirname</span> <span class='hs-num'>0o700</span>
<a name="line-121"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>dirname</span>
<a name="line-122"></a><span class='hs-cpp'>#else</span>
<a name="line-123"></a><span class='hs-cpp'>#ifdef __GLASGOW_HASKELL__</span>
<a name="line-124"></a><span class='hs-definition'>mktmpdir</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span>
<a name="line-125"></a> <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-varid'>fp</span><span class='hs-layout'>,</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>openTempFile</span> <span class='hs-str'>""</span> <span class='hs-varid'>x</span>
<a name="line-126"></a> <span class='hs-varid'>hClose</span> <span class='hs-varid'>h</span>
<a name="line-127"></a> <span class='hs-varid'>removeFile</span> <span class='hs-varid'>fp</span>
<a name="line-128"></a> <span class='hs-varid'>createDirectory</span> <span class='hs-varid'>fp</span>
<a name="line-129"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>fp</span>
<a name="line-130"></a><span class='hs-cpp'>#else</span>
<a name="line-131"></a><span class='hs-definition'>mktmpdir</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fail</span> <span class='hs-str'>"mktmpdir not supported on Windows unless you have GHC"</span>
<a name="line-132"></a><span class='hs-cpp'>#endif</span>
<a name="line-133"></a><span class='hs-cpp'>#endif</span>
<a name="line-134"></a>
<a name="line-135"></a><a name="brackettmpdir"></a><span class='hs-comment'>{- | Creates a temporary directory for your use via 'mktmpdir',
<a name="line-136"></a>runs the specified action (passing in the directory name), then
<a name="line-137"></a>removes the directory and all its contents when the action completes (or raises
<a name="line-138"></a>an exception. -}</span>
<a name="line-139"></a><span class='hs-definition'>brackettmpdir</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-140"></a><span class='hs-definition'>brackettmpdir</span> <span class='hs-varid'>x</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>tmpdir</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mktmpdir</span> <span class='hs-varid'>x</span>
<a name="line-141"></a> <span class='hs-varid'>finally</span> <span class='hs-layout'>(</span><span class='hs-varid'>action</span> <span class='hs-varid'>tmpdir</span><span class='hs-layout'>)</span>
<a name="line-142"></a> <span class='hs-layout'>(</span><span class='hs-varid'>recursiveRemove</span> <span class='hs-conid'>SystemFS</span> <span class='hs-varid'>tmpdir</span><span class='hs-layout'>)</span>
<a name="line-143"></a>
<a name="line-144"></a><a name="bracketCWD"></a><span class='hs-comment'>{- | Changes the current working directory to the given path,
<a name="line-145"></a>executes the given I\/O action, then changes back to the original directory,
<a name="line-146"></a>even if the I\/O action raised an exception. -}</span>
<a name="line-147"></a><span class='hs-definition'>bracketCWD</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-148"></a><span class='hs-definition'>bracketCWD</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span>
<a name="line-149"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>oldcwd</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getCurrentDirectory</span>
<a name="line-150"></a> <span class='hs-varid'>setCurrentDirectory</span> <span class='hs-varid'>fp</span>
<a name="line-151"></a> <span class='hs-varid'>finally</span> <span class='hs-varid'>action</span> <span class='hs-layout'>(</span><span class='hs-varid'>setCurrentDirectory</span> <span class='hs-varid'>oldcwd</span><span class='hs-layout'>)</span>
<a name="line-152"></a>
<a name="line-153"></a><a name="brackettmpdirCWD"></a><span class='hs-comment'>{- | Runs the given I\/O action with the CWD set to the given tmp dir,
<a name="line-154"></a>removing the tmp dir and changing CWD back afterwards, even if there
<a name="line-155"></a>was an exception. -}</span>
<a name="line-156"></a><span class='hs-definition'>brackettmpdirCWD</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-157"></a><span class='hs-definition'>brackettmpdirCWD</span> <span class='hs-varid'>template</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span>
<a name="line-158"></a> <span class='hs-varid'>brackettmpdir</span> <span class='hs-varid'>template</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>newdir</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>bracketCWD</span> <span class='hs-varid'>newdir</span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ec5844e219498f2057da8f8f3070d4a1
>
files
>
305
