<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Darcs.Patch.FileName</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Darcs-Patch-FileName.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Patch-FileName.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Patch.FileName</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>FileName is an abstract type intended to facilitate the input and output of
unicode filenames.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:FileName">FileName</a> </li><li class="src short"><a href="#v:fp2fn">fp2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:fn2fp">fn2fp</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:fn2ps">fn2ps</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:ps2fn">ps2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:niceps2fn">niceps2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:fn2niceps">fn2niceps</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:breakOnDir">breakOnDir</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="Darcs-Patch-FileName.html#t:FileName">FileName</a>, <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a>)</li><li class="src short"><a href="#v:normPath">normPath</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:ownName">ownName</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:superName">superName</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:movedirfilename">movedirfilename</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:encodeWhite">encodeWhite</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:decodeWhite">decodeWhite</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:-47--47--47-">(///)</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></li><li class="src short"><a href="#v:breakup">breakup</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</li><li class="src short"><a href="#v:isParentOrEqOf">isParentOrEqOf</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FileName" class="def">FileName</a> <a href="src/Darcs-Patch-FileName.html#FileName" class="link">Source</a></p><div class="subs instances"><p id="control.i:FileName" class="caption collapser" onclick="toggleSection('i:FileName')">Instances</p><div id="section.i:FileName" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-RepoPath.html#t:FilePathLike">FilePathLike</a> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-RepoPath.html#t:FilePathOrURL">FilePathOrURL</a> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> RestrictedApply</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-MonadProgress.html#t:MonadProgress">MonadProgress</a> FilePathMonad</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Patch-ApplyMonad.html#t:ApplyMonad">ApplyMonad</a> RestrictedApply <a href="/usr/share/doc/ghc/html/libraries/hashed-storage-0.5.9/Storage-Hashed-Tree.html#t:Tree">Tree</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Patch-ApplyMonad.html#t:ApplyMonad">ApplyMonad</a> FilePathMonad <a href="/usr/share/doc/ghc/html/libraries/hashed-storage-0.5.9/Storage-Hashed-Tree.html#t:Tree">Tree</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:fp2fn" class="def">fp2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#fp2fn" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fn2fp" class="def">fn2fp</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a><a href="src/Darcs-Patch-FileName.html#fn2fp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fn2ps" class="def">fn2ps</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/Darcs-Patch-FileName.html#fn2ps" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ps2fn" class="def">ps2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#ps2fn" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:niceps2fn" class="def">niceps2fn</a> :: <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#niceps2fn" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fn2niceps" class="def">fn2niceps</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/Darcs-Patch-FileName.html#fn2niceps" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:breakOnDir" class="def">breakOnDir</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="Darcs-Patch-FileName.html#t:FileName">FileName</a>, <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a>)<a href="src/Darcs-Patch-FileName.html#breakOnDir" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:normPath" class="def">normPath</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#normPath" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ownName" class="def">ownName</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#ownName" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:superName" class="def">superName</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#superName" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:movedirfilename" class="def">movedirfilename</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#movedirfilename" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:encodeWhite" class="def">encodeWhite</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Patch-FileName.html#encodeWhite" class="link">Source</a></p><div class="doc"><p><code><a href="Darcs-Patch-FileName.html#v:encodeWhite">encodeWhite</a></code> translates whitespace in filenames to a darcs-specific
format (numerical representation according to <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Char.html#v:ord">ord</a></code> surrounded by
backslashes). Note that backslashes are also escaped since they are used
in the encoding.
</p><pre> encodeWhite "hello there" == "hello\32\there"
encodeWhite "hello\there" == "hello\92\there"
</pre></div></div><div class="top"><p class="src"><a name="v:decodeWhite" class="def">decodeWhite</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a><a href="src/Darcs-Patch-FileName.html#decodeWhite" class="link">Source</a></p><div class="doc"><p><code><a href="Darcs-Patch-FileName.html#v:decodeWhite">decodeWhite</a></code> interprets the Darcs-specific "encoded" filenames
produced by <code><a href="Darcs-Patch-FileName.html#v:encodeWhite">encodeWhite</a></code>
</p><pre> decodeWhite "hello\32\there" == "hello there"
decodeWhite "hello\92\there" == "hello\there"
decodeWhite "hello\there" == error "malformed filename"
</pre></div></div><div class="top"><p class="src"><a name="v:-47--47--47-" class="def">(///)</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a><a href="src/Darcs-Patch-FileName.html#%2F%2F%2F" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:breakup" class="def">breakup</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]<a href="src/Darcs-Patch-FileName.html#breakup" class="link">Source</a></p><div class="doc"><p>Split a file path at the slashes
</p></div></div><div class="top"><p class="src"><a name="v:isParentOrEqOf" class="def">isParentOrEqOf</a> :: <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="Darcs-Patch-FileName.html#t:FileName">FileName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Darcs-Patch-FileName.html#isParentOrEqOf" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
