@@ -19,10 +19,8 @@
1919module Data.FileEmbed
2020 ( -- * Embed at compile time
2121 embedFile
22− , embedFileIfExists
2322 , embedOneFileOf
2423 , embedDir
25− , embedDirListing
2624 , getDir
2725 -- * Embed as a IsString
2826 , embedStringFile
@@ -37,9 +35,6 @@ module Data.FileEmbed
3735 , injectFile
3836 , injectWith
3937 , injectFileWith
40− -- * Relative path manipulation
41− , makeRelativeToProject
42− , makeRelativeToLocationPredicate
4338 -- * Internal
4439 , stringToBs
4540 , bsToExp
@@ -48,34 +43,30 @@ module Data.FileEmbed
4843
4944import Language.Haskell.TH.Syntax
5045 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
51− , Lit (..)
46+#if MIN_VERSION_template_haskell(2,5,0)
47+ , Lit (StringL, StringPrimL, IntegerL)
48+#else
49+ , Lit (StringL, IntegerL)
50+#endif
5251 , Q
5352 , runIO
54− , qLocation, loc_filename
5553#if MIN_VERSION_template_haskell(2,7,0)
5654 , Quasi(qAddDependentFile)
5755#endif
5856 )
59−#if MIN_VERSION_template_haskell(2,16,0)
60−import Language.Haskell.TH ( mkBytes, bytesPrimL )
61−import qualified Data.ByteString.Internal as B
62−#endif
6357import System.Directory (doesDirectoryExist, doesFileExist,
64− getDirectoryContents, canonicalizePath)
65−import Control.Exception (throw, tryJust, ErrorCall(..))
66−import Control.Monad (filterM, guard)
58+ getDirectoryContents)
59+import Control.Exception (throw, ErrorCall(..))
60+import Control.Monad (filterM)
6761import qualified Data.ByteString as B
6862import qualified Data.ByteString.Char8 as B8
6963import Control.Arrow ((&&&), second)
7064import Control.Applicative ((<$>))
7165import Data.ByteString.Unsafe (unsafePackAddressLen)
72−import System.IO.Error (isDoesNotExistError)
7366import System.IO.Unsafe (unsafePerformIO)
74−import System.FilePath ((</>), takeDirectory, takeExtension)
67+import System.FilePath ((</>))
7568import Data.String (fromString)
7669import Prelude as P
77−import Data.List (sortBy)
78−import Data.Ord (comparing)
7970
8071-- | Embed a single file in your source code.
8172--
@@ -90,40 +81,13 @@ embedFile fp =
9081#endif
9182 (runIO $ B.readFile fp) >>= bsToExp
9283
93−-- | Maybe embed a single file in your source code depending on whether or not file exists.
94−--
95−-- Warning: When a build is compiled with the file missing, a recompile when the file exists might not trigger an embed of the file.
96−-- You might try to fix this by doing a clean build.
97−--
98−-- > import qualified Data.ByteString
99−-- >
100−-- > maybeMyFile :: Maybe Data.ByteString.ByteString
101−-- > maybeMyFile = $(embedFileIfExists "dirName/fileName")
102−--
103−-- @since 0.0.14.0
104−embedFileIfExists :: FilePath -> Q Exp
105−embedFileIfExists fp = do
106− mbs <- runIO maybeFile
107− case mbs of
108− Nothing -> [| Nothing |]
109− Just bs -> do
110−#if MIN_VERSION_template_haskell(2,7,0)
111− qAddDependentFile fp
112−#endif
113− [| Just $(bsToExp bs) |]
114− where
115− maybeFile :: IO (Maybe B.ByteString)
116− maybeFile =
117− either (const Nothing) Just <$>
118− tryJust (guard . isDoesNotExistError) (B.readFile fp)
119−
12084-- | Embed a single existing file in your source code
12185-- out of list a list of paths supplied.
12286--
12387-- > import qualified Data.ByteString
12488-- >
12589-- > myFile :: Data.ByteString.ByteString
126−-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])
90+-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])
12791embedOneFileOf :: [FilePath] -> Q Exp
12892embedOneFileOf ps =
12993 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
@@ -151,18 +115,6 @@ embedDir fp = do
151115 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
152116 return $ SigE e typ
153117
154−-- | Embed a directory listing recursively in your source code.
155−--
156−-- > myFiles :: [FilePath]
157−-- > myFiles = $(embedDirListing "dirName")
158−--
159−-- @since 0.0.11
160−embedDirListing :: FilePath -> Q Exp
161−embedDirListing fp = do
162− typ <- [t| [FilePath] |]
163− e <- ListE <$> ((runIO $ fmap fst <$> fileList fp) >>= mapM strToExp)
164− return $ SigE e typ
165−
166118-- | Get a directory tree in the IO monad.
167119--
168120-- This is the workhorse of 'embedDir'
@@ -175,11 +127,7 @@ pairToExp _root (path, bs) = do
175127 qAddDependentFile $ _root ++ '/' : path
176128#endif
177129 exp' <- bsToExp bs
178− return $! TupE
179−#if MIN_VERSION_template_haskell(2,16,0)
180− $ map Just
181−#endif
182− [LitE $ StringL path, exp']
130+ return $! TupE [LitE $ StringL path, exp']
183131
184132bsToExp :: B.ByteString -> Q Exp
185133#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -187,11 +135,7 @@ bsToExp bs =
187135 return $ VarE 'unsafePerformIO
188136 `AppE` (VarE 'unsafePackAddressLen
189137 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
190−#if MIN_VERSION_template_haskell(2, 16, 0)
191− `AppE` LitE (bytesPrimL (
192− let B.PS ptr off sz = bs
193− in mkBytes ptr (fromIntegral off) (fromIntegral sz))))
194−#elif MIN_VERSION_template_haskell(2, 8, 0)
138+#if MIN_VERSION_template_haskell(2, 8, 0)
195139 `AppE` LitE (StringPrimL $ B.unpack bs))
196140#else
197141 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -266,7 +210,7 @@ fileList' realTop top = do
266210 mapM (liftPair2 . second B.readFile)
267211 dirs <- filterM (doesDirectoryExist . snd) all' >>=
268212 mapM (fileList' realTop . fst)
269− return $ sortBy (comparing fst) $ concat $ files : dirs
213+ return $ concat $ files : dirs
270214
271215liftPair2 :: Monad m => (a, m b) -> m (a, b)
272216liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -392,50 +336,3 @@ the magic key. If you know for certain that there will only be one dummy space
392336available, you can use the non-@With@ variants.
393337
394338-}
395−
396−-- | Take a relative file path and attach it to the root of the current
397−-- project.
398−--
399−-- The idea here is that, when building with Stack, the build will always be
400−-- executed with a current working directory of the root of the project (where
401−-- your .cabal file is located). However, if you load up multiple projects with
402−-- @stack ghci@, the working directory may be something else entirely.
403−--
404−-- This function looks at the source location of the Haskell file calling it,
405−-- finds the first parent directory with a .cabal file, and uses that as the
406−-- root directory for fixing the relative path.
407−--
408−-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
409−--
410−-- @since 0.0.10
411−makeRelativeToProject :: FilePath -> Q FilePath
412−makeRelativeToProject = makeRelativeToLocationPredicate $ (==) ".cabal" . takeExtension
413−
414−-- | Take a predicate to infer the project root and a relative file path, the given file path is then attached to the inferred project root
415−--
416−-- This function looks at the source location of the Haskell file calling it,
417−-- finds the first parent directory with a file matching the given predicate, and uses that as the
418−-- root directory for fixing the relative path.
419−--
420−-- @$(makeRelativeToLocationPredicate ((==) ".cabal" . takeExtension) "data/foo.txt" >>= embedFile)@
421−--
422−-- @since 0.0.15.0
423−makeRelativeToLocationPredicate :: (FilePath -> Bool) -> FilePath -> Q FilePath
424−makeRelativeToLocationPredicate isTargetFile rel = do
425− loc <- qLocation
426− runIO $ do
427− srcFP <- canonicalizePath $ loc_filename loc
428− mdir <- findProjectDir srcFP
429− case mdir of
430− Nothing -> error $ "Could not find .cabal file for path: " ++ srcFP
431− Just dir -> return $ dir </> rel
432− where
433− findProjectDir x = do
434− let dir = takeDirectory x
435− if dir == x
436− then return Nothing
437− else do
438− contents <- getDirectoryContents dir
439− if any isTargetFile contents
440− then return (Just dir)
441− else findProjectDir dir