factor out Utility.FileSystemEncoding

Common.hs

@@ -26,5 +26,6 @@ import Utility.SafeCommand as X
 import Utility.Path as X
 import Utility.Directory as X
 import Utility.Monad as X
+import Utility.FileSystemEncoding as X
 
 import Utility.PartialPrelude as X

Utility/FileSystemEncoding.hs

@@ -1,4 +1,4 @@
-{- File system encoding handling.
+{- GHC File system encoding handling.
  -
  - Copyright 2012 Joey Hess <joey@kitenet.net>
  -
@@ -7,8 +7,17 @@
 
 module Utility.FileSystemEncoding where
 
-import GHC.IO.Encoding (getFileSystemEncoding)
+import System.IO
+import Foreign.C
 import GHC.Foreign as GHC
+import GHC.IO.Encoding
+
+{- Sets a Handle to use the filesystem encoding. This causes data
+ - written or read from it to be encoded/decoded the same
+ - as ghc 7.4 does to filenames etc. This special encoding
+ - allows "arbitrary undecodable bytes to be round-tripped through it". -}
+fileEncoding :: Handle -> IO ()
+fileEncoding h = hSetEncoding h =<< getFileSystemEncoding
 
 {- Marshal a Haskell FilePath into a NUL terminated C string using temporary
  - storage. The FilePath is encoded using the filesystem encoding,
@@ -16,3 +25,13 @@ import GHC.Foreign as GHC
  - was obtained. -}
 withFilePath :: FilePath -> (CString -> IO a) -> IO a
 withFilePath fp f = getFileSystemEncoding >>= \enc -> GHC.withCString enc fp f
+
+{- Encodes a FilePath into a String of encoded bytes, applying the
+ - filesystem encoding.
+ -
+ - This does not do any IO, beyond allocating a C buffer. GHC does not
+ - seem to provide a pure way to do this conversion. -}
+encodeFilePath :: FilePath -> IO String
+encodeFilePath fp = do
+	enc <- getFileSystemEncoding
+	GHC.withCString enc fp $ GHC.peekCString enc

Utility/Misc.hs

@@ -9,14 +9,6 @@ module Utility.Misc where
 
 import System.IO
 import Control.Monad
-import GHC.IO.Encoding
-
-{- Sets a Handle to use the filesystem encoding. This causes data
- - written or read from it to be encoded/decoded the same
- - as ghc 7.4 does to filenames et. This special encoding
- - allows "arbitrary undecodable bytes to be round-tripped through it". -}
-fileEncoding :: Handle -> IO ()
-fileEncoding h = hSetEncoding h =<< getFileSystemEncoding
 
 {- A version of hgetContents that is not lazy. Ensures file is 
  - all read before it gets closed. -}

Utility/StatFS.hsc

@@ -47,15 +47,14 @@
 
 module Utility.StatFS ( FileSystemStats(..), getFileSystemStats ) where
 
+import Utility.FileSystemEncoding
+
 import Foreign
 import Foreign.C.Types
 import Foreign.C.String
 import GHC.IO.Encoding (getFileSystemEncoding)
 import GHC.Foreign as GHC
 
-withFilePath :: FilePath -> (CString -> IO a) -> IO a
-withFilePath fp f = getFileSystemEncoding >>= \enc -> GHC.withCString enc fp f
-
 #if defined (__FreeBSD__) || defined (__FreeBSD_kernel__) || defined (__APPLE__)
 # include <sys/param.h>
 # include <sys/mount.h>

Utility/Touch.hsc

@@ -13,15 +13,14 @@ module Utility.Touch (
 	touch
 ) where
 
+import Utility.FileSystemEncoding
+
 import Foreign
 import Foreign.C
 import Control.Monad (when)
 import GHC.IO.Encoding (getFileSystemEncoding)
 import GHC.Foreign as GHC
 
-withFilePath :: FilePath -> (CString -> IO a) -> IO a
-withFilePath fp f = getFileSystemEncoding >>= \enc -> GHC.withCString enc fp f
-
 newtype TimeSpec = TimeSpec CTime
 
 {- Changes the access and modification times of an existing file.