@@ -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
@@ -39,7 +37,6 @@ module Data.FileEmbed
3937 , injectFileWith
4038 -- * Relative path manipulation
4139 , makeRelativeToProject
42− , makeRelativeToLocationPredicate
4340 -- * Internal
4441 , stringToBs
4542 , bsToExp
@@ -48,7 +45,11 @@ module Data.FileEmbed
4845
4946import Language.Haskell.TH.Syntax
5047 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
51− , Lit (..)
48+#if MIN_VERSION_template_haskell(2,5,0)
49+ , Lit (StringL, StringPrimL, IntegerL)
50+#else
51+ , Lit (StringL, IntegerL)
52+#endif
5253 , Q
5354 , runIO
5455 , qLocation, loc_filename
@@ -56,26 +57,19 @@ import Language.Haskell.TH.Syntax
5657 , Quasi(qAddDependentFile)
5758#endif
5859 )
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
6360import System.Directory (doesDirectoryExist, doesFileExist,
6461 getDirectoryContents, canonicalizePath)
65−import Control.Exception (throw, tryJust, ErrorCall(..))
66−import Control.Monad (filterM, guard)
62+import Control.Exception (throw, ErrorCall(..))
63+import Control.Monad (filterM)
6764import qualified Data.ByteString as B
6865import qualified Data.ByteString.Char8 as B8
6966import Control.Arrow ((&&&), second)
7067import Control.Applicative ((<$>))
7168import Data.ByteString.Unsafe (unsafePackAddressLen)
72−import System.IO.Error (isDoesNotExistError)
7369import System.IO.Unsafe (unsafePerformIO)
7470import System.FilePath ((</>), takeDirectory, takeExtension)
7571import Data.String (fromString)
7672import Prelude as P
77−import Data.List (sortBy)
78−import Data.Ord (comparing)
7973
8074-- | Embed a single file in your source code.
8175--
@@ -90,40 +84,13 @@ embedFile fp =
9084#endif
9185 (runIO $ B.readFile fp) >>= bsToExp
9286
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−
12087-- | Embed a single existing file in your source code
12188-- out of list a list of paths supplied.
12289--
12390-- > import qualified Data.ByteString
12491-- >
12592-- > myFile :: Data.ByteString.ByteString
126−-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])
93+-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])
12794embedOneFileOf :: [FilePath] -> Q Exp
12895embedOneFileOf ps =
12996 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
@@ -151,18 +118,6 @@ embedDir fp = do
151118 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
152119 return $ SigE e typ
153120
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−
166121-- | Get a directory tree in the IO monad.
167122--
168123-- This is the workhorse of 'embedDir'
@@ -175,11 +130,7 @@ pairToExp _root (path, bs) = do
175130 qAddDependentFile $ _root ++ '/' : path
176131#endif
177132 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']
133+ return $! TupE [LitE $ StringL path, exp']
183134
184135bsToExp :: B.ByteString -> Q Exp
185136#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -187,11 +138,7 @@ bsToExp bs =
187138 return $ VarE 'unsafePerformIO
188139 `AppE` (VarE 'unsafePackAddressLen
189140 `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)
141+#if MIN_VERSION_template_haskell(2, 8, 0)
195142 `AppE` LitE (StringPrimL $ B.unpack bs))
196143#else
197144 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -266,7 +213,7 @@ fileList' realTop top = do
266213 mapM (liftPair2 . second B.readFile)
267214 dirs <- filterM (doesDirectoryExist . snd) all' >>=
268215 mapM (fileList' realTop . fst)
269− return $ sortBy (comparing fst) $ concat $ files : dirs
216+ return $ concat $ files : dirs
270217
271218liftPair2 :: Monad m => (a, m b) -> m (a, b)
272219liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -405,23 +352,13 @@ available, you can use the non-@With@ variants.
405352-- finds the first parent directory with a .cabal file, and uses that as the
406353-- root directory for fixing the relative path.
407354--
408−-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
355+-- @@@
356+-- $(makeRelativeToProject "data/foo.txt" >>= fileEmbed)
357+-- @@@
409358--
410359-- @since 0.0.10
411360makeRelativeToProject :: 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
361+makeRelativeToProject rel = do
425362 loc <- qLocation
426363 runIO $ do
427364 srcFP <- canonicalizePath $ loc_filename loc
@@ -436,6 +373,8 @@ makeRelativeToLocationPredicate isTargetFile rel = do
436373 then return Nothing
437374 else do
438375 contents <- getDirectoryContents dir
439− if any isTargetFile contents
376+ if any isCabalFile contents
440377 then return (Just dir)
441378 else findProjectDir dir
379+
380+ isCabalFile fp = takeExtension fp == ".cabal"