<?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://code.haskell.org/~malcolm/hscolour/ -->
<title>lib/Filesystem/Path/CurrentOS.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'>{-# OPTIONS_GHC -fno-warn-orphans #-}</span>
<a name="line-3"></a>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module: Filesystem.Path.CurrentOS</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright: 2010 John Millikin</span>
<a name="line-7"></a><span class='hs-comment'>-- License: MIT</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer: jmillikin@gmail.com</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability: portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Re&#x2010;exports contents of "Filesystem.Path.Rules", defaulting to the</span>
<a name="line-13"></a><span class='hs-comment'>-- current OS&#x2019;s rules when needed.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- Also enables 'Show' and 'S.IsString' instances for 'F.FilePath'.</span>
<a name="line-16"></a><span class='hs-comment'>--</span>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Filesystem</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span><span class='hs-varop'>.</span><span class='hs-conid'>CurrentOS</span>
<a name="line-18"></a> <span class='hs-layout'>(</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Filesystem</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span>
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>currentOS</span>
<a name="line-20"></a>
<a name="line-21"></a> <span class='hs-comment'>-- * Type conversions</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toText</span>
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromText</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encode</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decode</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeString</span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeString</span>
<a name="line-28"></a>
<a name="line-29"></a> <span class='hs-comment'>-- * Rule&#x2010;specific path properties</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>valid</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>splitSearchPath</span>
<a name="line-32"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-conid'>FilePath</span><span class='hs-layout'>)</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>B</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>S</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>T</span>
<a name="line-39"></a>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Filesystem</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span>
<a name="line-41"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Filesystem</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>F</span>
<a name="line-42"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Filesystem</span><span class='hs-varop'>.</span><span class='hs-conid'>Path</span><span class='hs-varop'>.</span><span class='hs-conid'>Rules</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>R</span>
<a name="line-43"></a>
<a name="line-44"></a><span class='hs-cpp'>#if defined(CABAL_OS_WINDOWS) || defined(CABAL_OS_DARWIN)</span>
<a name="line-45"></a><span class='hs-cpp'>#define PLATFORM_PATH_FORMAT T.Text</span>
<a name="line-46"></a><span class='hs-cpp'>#else</span>
<a name="line-47"></a><span class='hs-cpp'>#define PLATFORM_PATH_FORMAT B.ByteString</span>
<a name="line-48"></a><span class='hs-cpp'>#endif</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="currentOS"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-conid'>Rules</span> <span class='hs-conid'>PLATFORM_PATH_FORMAT</span>
<a name="line-51"></a><span class='hs-cpp'>#if defined(CABAL_OS_WINDOWS)</span>
<a name="line-52"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>windows</span>
<a name="line-53"></a><span class='hs-cpp'>#elif defined(CABAL_OS_DARWIN)</span>
<a name="line-54"></a><span class='hs-cpp'>#if __GLASGOW_HASKELL__ >= 702</span>
<a name="line-55"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>darwin_ghc702</span>
<a name="line-56"></a><span class='hs-cpp'>#else</span>
<a name="line-57"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>darwin</span>
<a name="line-58"></a><span class='hs-cpp'>#endif</span>
<a name="line-59"></a><span class='hs-cpp'>#else</span>
<a name="line-60"></a><span class='hs-cpp'>#if __GLASGOW_HASKELL__ >= 704</span>
<a name="line-61"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>posix_ghc704</span>
<a name="line-62"></a><span class='hs-cpp'>#elif __GLASGOW_HASKELL__ >= 702</span>
<a name="line-63"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>posix_ghc702</span>
<a name="line-64"></a><span class='hs-cpp'>#else</span>
<a name="line-65"></a><span class='hs-definition'>currentOS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>posix</span>
<a name="line-66"></a><span class='hs-cpp'>#endif</span>
<a name="line-67"></a><span class='hs-cpp'>#endif</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="instance%20S.IsString%20F.FilePath"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>IsString</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyword'>where</span>
<a name="line-70"></a> <span class='hs-varid'>fromString</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>fromText</span> <span class='hs-varid'>currentOS</span> <span class='hs-varop'>.</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="instance%20Show%20F.FilePath"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Show</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyword'>where</span>
<a name="line-73"></a> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>d</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>showParen</span> <span class='hs-layout'>(</span><span class='hs-varid'>d</span> <span class='hs-varop'>></span> <span class='hs-num'>10</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss</span> <span class='hs-str'>"FilePath "</span> <span class='hs-varop'>.</span> <span class='hs-varid'>s</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-74"></a> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>shows</span>
<a name="line-75"></a> <span class='hs-varid'>ss</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>showString</span>
<a name="line-76"></a> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>either</span> <span class='hs-varid'>id</span> <span class='hs-varid'>id</span> <span class='hs-layout'>(</span><span class='hs-varid'>toText</span> <span class='hs-varid'>path</span><span class='hs-layout'>)</span>
<a name="line-77"></a>
<a name="line-78"></a><a name="toText"></a><span class='hs-comment'>-- | Attempt to convert a 'F.FilePath' to human&#x2010;readable text.</span>
<a name="line-79"></a><span class='hs-comment'>--</span>
<a name="line-80"></a><span class='hs-comment'>-- If the path is decoded successfully, the result is a 'Right' containing</span>
<a name="line-81"></a><span class='hs-comment'>-- the decoded text. Successfully decoded text can be converted back to the</span>
<a name="line-82"></a><span class='hs-comment'>-- original path using 'fromText'.</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- If the path cannot be decoded, the result is a 'Left' containing an</span>
<a name="line-85"></a><span class='hs-comment'>-- approximation of the original path. If displayed to the user, this value</span>
<a name="line-86"></a><span class='hs-comment'>-- should be accompanied by some warning that the path has an invalid</span>
<a name="line-87"></a><span class='hs-comment'>-- encoding. Approximated text cannot be converted back to the original path.</span>
<a name="line-88"></a><span class='hs-comment'>--</span>
<a name="line-89"></a><span class='hs-comment'>-- This function ignores the user&#x2019;s locale, and assumes all file paths</span>
<a name="line-90"></a><span class='hs-comment'>-- are encoded in UTF8. If you need to display file paths with an unusual or</span>
<a name="line-91"></a><span class='hs-comment'>-- obscure encoding, use 'encode' and then decode them manually.</span>
<a name="line-92"></a><span class='hs-comment'>--</span>
<a name="line-93"></a><span class='hs-comment'>-- Since: 0.2</span>
<a name="line-94"></a><span class='hs-definition'>toText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span>
<a name="line-95"></a><span class='hs-definition'>toText</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>toText</span> <span class='hs-varid'>currentOS</span>
<a name="line-96"></a>
<a name="line-97"></a><a name="fromText"></a><span class='hs-comment'>-- | Convert human&#x2010;readable text into a 'FilePath'.</span>
<a name="line-98"></a><span class='hs-comment'>--</span>
<a name="line-99"></a><span class='hs-comment'>-- This function ignores the user&#x2019;s locale, and assumes all file paths</span>
<a name="line-100"></a><span class='hs-comment'>-- are encoded in UTF8. If you need to create file paths with an unusual or</span>
<a name="line-101"></a><span class='hs-comment'>-- obscure encoding, encode them manually and then use 'decode'.</span>
<a name="line-102"></a><span class='hs-comment'>--</span>
<a name="line-103"></a><span class='hs-comment'>-- Since: 0.2</span>
<a name="line-104"></a><span class='hs-definition'>fromText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span>
<a name="line-105"></a><span class='hs-definition'>fromText</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>fromText</span> <span class='hs-varid'>currentOS</span>
<a name="line-106"></a>
<a name="line-107"></a><a name="valid"></a><span class='hs-comment'>-- | Check if a 'FilePath' is valid; it must not contain any illegal</span>
<a name="line-108"></a><span class='hs-comment'>-- characters, and must have a root appropriate to the current 'R.Rules'.</span>
<a name="line-109"></a><span class='hs-definition'>valid</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-110"></a><span class='hs-definition'>valid</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>valid</span> <span class='hs-varid'>currentOS</span>
<a name="line-111"></a>
<a name="line-112"></a><a name="splitSearchPath"></a><span class='hs-comment'>-- | Split a search path, such as @$PATH@ or @$PYTHONPATH@, into a list</span>
<a name="line-113"></a><span class='hs-comment'>-- of 'FilePath's.</span>
<a name="line-114"></a><span class='hs-definition'>splitSearchPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PLATFORM_PATH_FORMAT</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span><span class='hs-keyglyph'>]</span>
<a name="line-115"></a><span class='hs-definition'>splitSearchPath</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>splitSearchPath</span> <span class='hs-varid'>currentOS</span>
<a name="line-116"></a>
<a name="line-117"></a><a name="encode"></a><span class='hs-comment'>-- | Convert a 'F.FilePath' to a platform&#x2010;specific format, suitable</span>
<a name="line-118"></a><span class='hs-comment'>-- for use with external OS functions.</span>
<a name="line-119"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><span class='hs-comment'>-- Since: 0.3</span>
<a name="line-121"></a><span class='hs-definition'>encode</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PLATFORM_PATH_FORMAT</span>
<a name="line-122"></a><span class='hs-definition'>encode</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>encode</span> <span class='hs-varid'>currentOS</span>
<a name="line-123"></a>
<a name="line-124"></a><a name="decode"></a><span class='hs-comment'>-- | Convert a 'F.FilePath' from a platform&#x2010;specific format, suitable</span>
<a name="line-125"></a><span class='hs-comment'>-- for use with external OS functions.</span>
<a name="line-126"></a><span class='hs-comment'>--</span>
<a name="line-127"></a><span class='hs-comment'>-- Since: 0.3</span>
<a name="line-128"></a><span class='hs-definition'>decode</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PLATFORM_PATH_FORMAT</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span>
<a name="line-129"></a><span class='hs-definition'>decode</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>decode</span> <span class='hs-varid'>currentOS</span>
<a name="line-130"></a>
<a name="line-131"></a><a name="encodeString"></a><span class='hs-comment'>-- | Attempt to convert a 'F.FilePath' to a string suitable for use with</span>
<a name="line-132"></a><span class='hs-comment'>-- functions in @System.IO@. The contents of this string are</span>
<a name="line-133"></a><span class='hs-comment'>-- platform&#x2010;dependent, and are not guaranteed to be</span>
<a name="line-134"></a><span class='hs-comment'>-- human&#x2010;readable. For converting 'F.FilePath's to a</span>
<a name="line-135"></a><span class='hs-comment'>-- human&#x2010;readable format, use 'toText'.</span>
<a name="line-136"></a><span class='hs-comment'>--</span>
<a name="line-137"></a><span class='hs-comment'>-- Since: 0.3.1</span>
<a name="line-138"></a><span class='hs-definition'>encodeString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-139"></a><span class='hs-definition'>encodeString</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>encodeString</span> <span class='hs-varid'>currentOS</span>
<a name="line-140"></a>
<a name="line-141"></a><a name="decodeString"></a><span class='hs-comment'>-- | Attempt to parse a 'F.FilePath' from a string suitable for use with</span>
<a name="line-142"></a><span class='hs-comment'>-- functions in @System.IO@. Do not use this function for parsing</span>
<a name="line-143"></a><span class='hs-comment'>-- human&#x2010;readable paths, as the character set decoding is</span>
<a name="line-144"></a><span class='hs-comment'>-- platform&#x2010;dependent. For converting human&#x2010;readable text to a</span>
<a name="line-145"></a><span class='hs-comment'>-- 'F.FilePath', use 'fromText'.</span>
<a name="line-146"></a><span class='hs-comment'>--</span>
<a name="line-147"></a><span class='hs-comment'>-- Since: 0.3.1</span>
<a name="line-148"></a><span class='hs-definition'>decodeString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>F</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span>
<a name="line-149"></a><span class='hs-definition'>decodeString</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>decodeString</span> <span class='hs-varid'>currentOS</span>
</pre></body>
</html>
