<?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/Internal.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'>{-# LANGUAGE DeriveDataTypeable #-}</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.Internal</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-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'>Internal</span> <span class='hs-keyword'>where</span>
<a name="line-13"></a>
<a name="line-14"></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-15"></a>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>DeepSeq</span> <span class='hs-layout'>(</span><span class='hs-conid'>NFData</span><span class='hs-layout'>,</span> <span class='hs-varid'>rnf</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Exc</span>
<a name="line-18"></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-19"></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-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>B8</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Char</span> <span class='hs-layout'>(</span><span class='hs-varid'>chr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ord</span><span class='hs-layout'>)</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span> <span class='hs-layout'>(</span><span class='hs-conid'>Data</span><span class='hs-layout'>)</span>
<a name="line-22"></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-layout'>(</span><span class='hs-varid'>intersperse</span><span class='hs-layout'>)</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Ord</span> <span class='hs-layout'>(</span><span class='hs-varid'>comparing</span><span class='hs-layout'>)</span>
<a name="line-24"></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-25"></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-varop'>.</span><span class='hs-conid'>Encoding</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TE</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Encoding</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span> <span class='hs-layout'>(</span><span class='hs-conid'>UnicodeException</span><span class='hs-layout'>)</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-28"></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'>Unsafe</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafePerformIO</span><span class='hs-layout'>)</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-31"></a><span class='hs-comment'>-- File Paths</span>
<a name="line-32"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-33"></a>
<a name="line-34"></a><a name="Chunk"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Chunk</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-35"></a><a name="Directory"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Directory</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Chunk</span>
<a name="line-36"></a><a name="Basename"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Basename</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Chunk</span>
<a name="line-37"></a><a name="Extension"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Extension</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Chunk</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="Root"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Root</span>
<a name="line-40"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>RootPosix</span>
<a name="line-41"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>RootWindowsVolume</span> <span class='hs-conid'>Char</span>
<a name="line-42"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>RootWindowsCurrentVolume</span>
<a name="line-43"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Data</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-44"></a>
<a name="line-45"></a><a name="FilePath"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FilePath</span>
<a name="line-46"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>pathRoot</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Root</span>
<a name="line-47"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>pathDirectories</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Directory</span><span class='hs-keyglyph'>]</span>
<a name="line-48"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>pathBasename</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Basename</span>
<a name="line-49"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>pathExtensions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Extension</span><span class='hs-keyglyph'>]</span>
<a name="line-50"></a> <span class='hs-layout'>}</span>
<a name="line-51"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Data</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="instance%20Eq%20FilePath"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Eq</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyword'>where</span>
<a name="line-54"></a> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>compare</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-varop'>==</span> <span class='hs-conid'>EQ</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="instance%20Ord%20FilePath"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Ord</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyword'>where</span>
<a name="line-57"></a> <span class='hs-varid'>compare</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>comparing</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>p</span> <span class='hs-keyglyph'>-></span>
<a name="line-58"></a> <span class='hs-layout'>(</span><span class='hs-varid'>pathRoot</span> <span class='hs-varid'>p</span>
<a name="line-59"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unescape'</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathDirectories</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unescape'</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathBasename</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-61"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unescape'</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathExtensions</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-62"></a> <span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="instance%20NFData%20Root"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>NFData</span> <span class='hs-conid'>Root</span> <span class='hs-keyword'>where</span>
<a name="line-65"></a> <span class='hs-varid'>rnf</span> <span class='hs-layout'>(</span><span class='hs-conid'>RootWindowsVolume</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rnf</span> <span class='hs-varid'>c</span>
<a name="line-66"></a> <span class='hs-varid'>rnf</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>()</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="instance%20NFData%20FilePath"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>NFData</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyword'>where</span>
<a name="line-69"></a> <span class='hs-varid'>rnf</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rnf</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathRoot</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varop'>`seq`</span> <span class='hs-varid'>rnf</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathDirectories</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varop'>`seq`</span> <span class='hs-varid'>rnf</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathBasename</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varop'>`seq`</span> <span class='hs-varid'>rnf</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathExtensions</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="empty"></a><span class='hs-comment'>-- | A file path with no root, directory, or filename</span>
<a name="line-72"></a><span class='hs-definition'>empty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span>
<a name="line-73"></a><span class='hs-definition'>empty</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FilePath</span> <span class='hs-conid'>Nothing</span> <span class='hs-conid'>[]</span> <span class='hs-conid'>Nothing</span> <span class='hs-conid'>[]</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="dot"></a><span class='hs-definition'>dot</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span>
<a name="line-76"></a><span class='hs-definition'>dot</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"."</span>
<a name="line-77"></a>
<a name="line-78"></a><a name="dots"></a><span class='hs-definition'>dots</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span>
<a name="line-79"></a><span class='hs-definition'>dots</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>".."</span>
<a name="line-80"></a>
<a name="line-81"></a><a name="filenameChunk"></a><span class='hs-definition'>filenameChunk</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Chunk</span>
<a name="line-82"></a><span class='hs-definition'>filenameChunk</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>concat</span> <span class='hs-layout'>(</span><span class='hs-varid'>name</span><span class='hs-conop'>:</span><span class='hs-varid'>exts</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-83"></a> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-str'>""</span> <span class='hs-varid'>id</span> <span class='hs-layout'>(</span><span class='hs-varid'>pathBasename</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-84"></a> <span class='hs-varid'>exts</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>pathExtensions</span> <span class='hs-varid'>p</span> <span class='hs-keyword'>of</span>
<a name="line-85"></a> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>[]</span>
<a name="line-86"></a> <span class='hs-varid'>exts'</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>intersperse</span> <span class='hs-varid'>dot</span> <span class='hs-layout'>(</span><span class='hs-str'>""</span><span class='hs-conop'>:</span><span class='hs-varid'>exts'</span><span class='hs-layout'>)</span>
<a name="line-87"></a>
<a name="line-88"></a><a name="rootChunk"></a><span class='hs-definition'>rootChunk</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Root</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Chunk</span>
<a name="line-89"></a><span class='hs-definition'>rootChunk</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>flip</span> <span class='hs-layout'>(</span><span class='hs-varid'>maybe</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span> <span class='hs-varid'>r</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>r'</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>case</span> <span class='hs-varid'>r'</span> <span class='hs-keyword'>of</span>
<a name="line-90"></a> <span class='hs-conid'>RootPosix</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"/"</span>
<a name="line-91"></a> <span class='hs-conid'>RootWindowsVolume</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>c</span> <span class='hs-conop'>:</span> <span class='hs-str'>":\\"</span>
<a name="line-92"></a> <span class='hs-conid'>RootWindowsCurrentVolume</span> <span class='hs-keyglyph'>-></span> <span class='hs-str'>"\\"</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="rootText"></a><span class='hs-definition'>rootText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Root</span> <span class='hs-keyglyph'>-></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'>rootText</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varop'>.</span> <span class='hs-varid'>rootChunk</span>
<a name="line-96"></a>
<a name="line-97"></a><a name="directoryChunks"></a><span class='hs-definition'>directoryChunks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Chunk</span><span class='hs-keyglyph'>]</span>
<a name="line-98"></a><span class='hs-definition'>directoryChunks</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>pathDirectories</span> <span class='hs-varid'>path</span> <span class='hs-varop'>++</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>filenameChunk</span> <span class='hs-varid'>path</span><span class='hs-keyglyph'>]</span>
<a name="line-99"></a>
<a name="line-100"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-101"></a><span class='hs-comment'>-- Rules</span>
<a name="line-102"></a><span class='hs-comment'>-------------------------------------------------------------------------------</span>
<a name="line-103"></a>
<a name="line-104"></a><a name="Rules"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Rules</span> <span class='hs-varid'>platformFormat</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Rules</span>
<a name="line-105"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>rulesName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span>
<a name="line-106"></a>
<a name="line-107"></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</span>
<a name="line-109"></a> <span class='hs-comment'>-- 'Rules'.</span>
<a name="line-110"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>valid</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-111"></a>
<a name="line-112"></a> <span class='hs-comment'>-- | Split a search path, such as @$PATH@ or @$PYTHONPATH@, into</span>
<a name="line-113"></a> <span class='hs-comment'>-- a list of 'FilePath's.</span>
<a name="line-114"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>splitSearchPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>platformFormat</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FilePath</span><span class='hs-keyglyph'>]</span>
<a name="line-115"></a>
<a name="line-116"></a> <span class='hs-comment'>-- | Attempt to convert a 'FilePath' to human&#x2010;readable text.</span>
<a name="line-117"></a> <span class='hs-comment'>--</span>
<a name="line-118"></a> <span class='hs-comment'>-- If the path is decoded successfully, the result is a 'Right'</span>
<a name="line-119"></a> <span class='hs-comment'>-- containing the decoded text. Successfully decoded text can be</span>
<a name="line-120"></a> <span class='hs-comment'>-- converted back to the original path using 'fromText'.</span>
<a name="line-121"></a> <span class='hs-comment'>--</span>
<a name="line-122"></a> <span class='hs-comment'>-- If the path cannot be decoded, the result is a 'Left' containing an</span>
<a name="line-123"></a> <span class='hs-comment'>-- approximation of the original path. If displayed to the user, this</span>
<a name="line-124"></a> <span class='hs-comment'>-- value should be accompanied by some warning that the path has an</span>
<a name="line-125"></a> <span class='hs-comment'>-- invalid encoding. Approximated text cannot be converted back to the</span>
<a name="line-126"></a> <span class='hs-comment'>-- original path.</span>
<a name="line-127"></a> <span class='hs-comment'>--</span>
<a name="line-128"></a> <span class='hs-comment'>-- This function ignores the user&#x2019;s locale, and assumes all</span>
<a name="line-129"></a> <span class='hs-comment'>-- file paths are encoded in UTF8. If you need to display file paths</span>
<a name="line-130"></a> <span class='hs-comment'>-- with an unusual or obscure encoding, use 'encode' and then decode</span>
<a name="line-131"></a> <span class='hs-comment'>-- them manually.</span>
<a name="line-132"></a> <span class='hs-comment'>--</span>
<a name="line-133"></a> <span class='hs-comment'>-- Since: 0.2</span>
<a name="line-134"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toText</span> <span class='hs-keyglyph'>::</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-135"></a>
<a name="line-136"></a> <span class='hs-comment'>-- | Convert human&#x2010;readable text into a 'FilePath'.</span>
<a name="line-137"></a> <span class='hs-comment'>--</span>
<a name="line-138"></a> <span class='hs-comment'>-- This function ignores the user&#x2019;s locale, and assumes all</span>
<a name="line-139"></a> <span class='hs-comment'>-- file paths are encoded in UTF8. If you need to create file paths</span>
<a name="line-140"></a> <span class='hs-comment'>-- with an unusual or obscure encoding, encode them manually and then</span>
<a name="line-141"></a> <span class='hs-comment'>-- use 'decode'.</span>
<a name="line-142"></a> <span class='hs-comment'>--</span>
<a name="line-143"></a> <span class='hs-comment'>-- Since: 0.2</span>
<a name="line-144"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>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'>FilePath</span>
<a name="line-145"></a>
<a name="line-146"></a> <span class='hs-comment'>-- | Convert a 'FilePath' to a platform&#x2010;specific format,</span>
<a name="line-147"></a> <span class='hs-comment'>-- suitable for use with external OS functions.</span>
<a name="line-148"></a> <span class='hs-comment'>--</span>
<a name="line-149"></a> <span class='hs-comment'>-- Since: 0.3</span>
<a name="line-150"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encode</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>platformFormat</span>
<a name="line-151"></a>
<a name="line-152"></a> <span class='hs-comment'>-- | Convert a 'FilePath' from a platform&#x2010;specific format,</span>
<a name="line-153"></a> <span class='hs-comment'>-- suitable for use with external OS functions.</span>
<a name="line-154"></a> <span class='hs-comment'>--</span>
<a name="line-155"></a> <span class='hs-comment'>-- Since: 0.3</span>
<a name="line-156"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decode</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>platformFormat</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span>
<a name="line-157"></a>
<a name="line-158"></a> <span class='hs-comment'>-- | Attempt to convert a 'FilePath' to a string suitable for use with</span>
<a name="line-159"></a> <span class='hs-comment'>-- functions in @System.IO@. The contents of this string are</span>
<a name="line-160"></a> <span class='hs-comment'>-- platform&#x2010;dependent, and are not guaranteed to be</span>
<a name="line-161"></a> <span class='hs-comment'>-- human&#x2010;readable. For converting 'FilePath's to a</span>
<a name="line-162"></a> <span class='hs-comment'>-- human&#x2010;readable format, use 'toText'.</span>
<a name="line-163"></a> <span class='hs-comment'>--</span>
<a name="line-164"></a> <span class='hs-comment'>-- Since: 0.3.1</span>
<a name="line-165"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>encodeString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-166"></a>
<a name="line-167"></a> <span class='hs-comment'>-- | Attempt to parse a 'FilePath' from a string suitable for use</span>
<a name="line-168"></a> <span class='hs-comment'>-- with functions in @System.IO@. Do not use this function for parsing</span>
<a name="line-169"></a> <span class='hs-comment'>-- human&#x2010;readable paths, as the character set decoding is</span>
<a name="line-170"></a> <span class='hs-comment'>-- platform&#x2010;dependent. For converting human&#x2010;readable</span>
<a name="line-171"></a> <span class='hs-comment'>-- text to a 'FilePath', use 'fromText'.</span>
<a name="line-172"></a> <span class='hs-comment'>--</span>
<a name="line-173"></a> <span class='hs-comment'>-- Since: 0.3.1</span>
<a name="line-174"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decodeString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span>
<a name="line-175"></a> <span class='hs-layout'>}</span>
<a name="line-176"></a>
<a name="line-177"></a><a name="instance%20Show%20(Rules%20a)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Show</span> <span class='hs-layout'>(</span><span class='hs-conid'>Rules</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-178"></a> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>d</span> <span class='hs-varid'>r</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>
<a name="line-179"></a> <span class='hs-layout'>(</span><span class='hs-varid'>showString</span> <span class='hs-str'>"Rules "</span> <span class='hs-varop'>.</span> <span class='hs-varid'>shows</span> <span class='hs-layout'>(</span><span class='hs-varid'>rulesName</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-180"></a>
<a name="line-181"></a><a name="escape"></a><span class='hs-definition'>escape</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'>Chunk</span>
<a name="line-182"></a><span class='hs-definition'>escape</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span> <span class='hs-varid'>t</span>
<a name="line-183"></a>
<a name="line-184"></a><a name="unescape"></a><span class='hs-definition'>unescape</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span>
<a name="line-185"></a><span class='hs-definition'>unescape</span> <span class='hs-varid'>cs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>any</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0xDC80</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'><=</span> <span class='hs-num'>0xDCFF</span><span class='hs-layout'>)</span> <span class='hs-varid'>cs</span>
<a name="line-186"></a> <span class='hs-keyword'>then</span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>if</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0xDC80</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'><=</span> <span class='hs-num'>0xDCFF</span>
<a name="line-187"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>chr</span> <span class='hs-layout'>(</span><span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-comment'>-</span> <span class='hs-num'>0xDC00</span><span class='hs-layout'>)</span>
<a name="line-188"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>cs</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>False</span><span class='hs-layout'>)</span>
<a name="line-189"></a> <span class='hs-keyword'>else</span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varid'>cs</span><span class='hs-layout'>,</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span>
<a name="line-190"></a>
<a name="line-191"></a><a name="unescape'"></a><span class='hs-definition'>unescape'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span>
<a name="line-192"></a><span class='hs-definition'>unescape'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fst</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unescape</span>
<a name="line-193"></a>
<a name="line-194"></a><a name="unescapeBytes'"></a><span class='hs-definition'>unescapeBytes'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-195"></a><span class='hs-definition'>unescapeBytes'</span> <span class='hs-varid'>cs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>any</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0xDC80</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'><=</span> <span class='hs-num'>0xDCFF</span><span class='hs-layout'>)</span> <span class='hs-varid'>cs</span>
<a name="line-196"></a> <span class='hs-keyword'>then</span> <span class='hs-conid'>B8</span><span class='hs-varop'>.</span><span class='hs-varid'>concat</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>if</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0xDC80</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-varop'><=</span> <span class='hs-num'>0xDCFF</span>
<a name="line-197"></a> <span class='hs-keyword'>then</span> <span class='hs-conid'>B8</span><span class='hs-varop'>.</span><span class='hs-varid'>singleton</span> <span class='hs-layout'>(</span><span class='hs-varid'>chr</span> <span class='hs-layout'>(</span><span class='hs-varid'>ord</span> <span class='hs-varid'>c</span> <span class='hs-comment'>-</span> <span class='hs-num'>0xDC00</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-198"></a> <span class='hs-keyword'>else</span> <span class='hs-conid'>TE</span><span class='hs-varop'>.</span><span class='hs-varid'>encodeUtf8</span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>singleton</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>cs</span><span class='hs-layout'>)</span>
<a name="line-199"></a> <span class='hs-keyword'>else</span> <span class='hs-conid'>TE</span><span class='hs-varop'>.</span><span class='hs-varid'>encodeUtf8</span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varid'>cs</span><span class='hs-layout'>)</span>
<a name="line-200"></a>
<a name="line-201"></a><a name="splitBy"></a><span class='hs-definition'>splitBy</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-202"></a><span class='hs-definition'>splitBy</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>loop</span> <span class='hs-keyword'>where</span>
<a name="line-203"></a> <span class='hs-varid'>loop</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>let</span>
<a name="line-204"></a> <span class='hs-layout'>(</span><span class='hs-varid'>chunk</span><span class='hs-layout'>,</span> <span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>break</span> <span class='hs-varid'>p</span> <span class='hs-varid'>xs</span>
<a name="line-205"></a> <span class='hs-varid'>cont</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>chunk</span> <span class='hs-conop'>:</span> <span class='hs-varid'>loop</span> <span class='hs-layout'>(</span><span class='hs-varid'>tail</span> <span class='hs-varid'>rest</span><span class='hs-layout'>)</span>
<a name="line-206"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>rest</span> <span class='hs-keyword'>then</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>chunk</span><span class='hs-keyglyph'>]</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>cont</span>
<a name="line-207"></a>
<a name="line-208"></a><a name="textSplitBy"></a><span class='hs-definition'>textSplitBy</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</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-keyglyph'>[</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-keyglyph'>]</span>
<a name="line-209"></a><span class='hs-cpp'>#if MIN_VERSION_text(0,11,0)</span>
<a name="line-210"></a><span class='hs-definition'>textSplitBy</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>split</span>
<a name="line-211"></a><span class='hs-cpp'>#else</span>
<a name="line-212"></a><span class='hs-definition'>textSplitBy</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>splitBy</span>
<a name="line-213"></a><span class='hs-cpp'>#endif</span>
<a name="line-214"></a>
<a name="line-215"></a><a name="parseFilename"></a><span class='hs-definition'>parseFilename</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Chunk</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Basename</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Extension</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-216"></a><span class='hs-definition'>parseFilename</span> <span class='hs-varid'>filename</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>parsed</span> <span class='hs-keyword'>where</span>
<a name="line-217"></a> <span class='hs-varid'>parsed</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>filename</span>
<a name="line-218"></a> <span class='hs-keyword'>then</span> <span class='hs-layout'>(</span><span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
<a name="line-219"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>splitBy</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span> <span class='hs-chr'>'.'</span><span class='hs-layout'>)</span> <span class='hs-varid'>filename</span> <span class='hs-keyword'>of</span>
<a name="line-220"></a> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
<a name="line-221"></a> <span class='hs-layout'>(</span><span class='hs-varid'>name'</span><span class='hs-conop'>:</span><span class='hs-varid'>exts'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>name'</span><span class='hs-layout'>,</span> <span class='hs-varid'>exts'</span><span class='hs-layout'>)</span>
<a name="line-222"></a>
<a name="line-223"></a><a name="maybeDecodeUtf8"></a><span class='hs-definition'>maybeDecodeUtf8</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span>
<a name="line-224"></a><span class='hs-definition'>maybeDecodeUtf8</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>excToMaybe</span> <span class='hs-varop'>.</span> <span class='hs-conid'>TE</span><span class='hs-varop'>.</span><span class='hs-varid'>decodeUtf8</span> <span class='hs-keyword'>where</span>
<a name="line-225"></a> <span class='hs-varid'>excToMaybe</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span>
<a name="line-226"></a> <span class='hs-varid'>excToMaybe</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafePerformIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Exc</span><span class='hs-varop'>.</span><span class='hs-varid'>catch</span>
<a name="line-227"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>Exc</span><span class='hs-varop'>.</span><span class='hs-varid'>evaluate</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-228"></a> <span class='hs-varid'>unicodeError</span>
<a name="line-229"></a>
<a name="line-230"></a> <span class='hs-varid'>unicodeError</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>UnicodeException</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-231"></a> <span class='hs-varid'>unicodeError</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
</pre></body>
</html>
