@@ -19,8 +19,10 @@
1919module Data.FileEmbed
2020 ( -- * Embed at compile time
2121 embedFile
22+ , embedFileIfExists
2223 , embedOneFileOf
2324 , embedDir
25+ , embedDirListing
2426 , getDir
2527 -- * Embed as a IsString
2628 , embedStringFile
@@ -37,6 +39,7 @@ module Data.FileEmbed
3739 , injectFileWith
3840 -- * Relative path manipulation
3941 , makeRelativeToProject
42+ , makeRelativeToLocationPredicate
4043 -- * Internal
4144 , stringToBs
4245 , bsToExp
@@ -45,11 +48,7 @@ module Data.FileEmbed
4548
4649import Language.Haskell.TH.Syntax
4750 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
48−#if MIN_VERSION_template_haskell(2,5,0)
49− , Lit (StringL, StringPrimL, IntegerL)
50−#else
51− , Lit (StringL, IntegerL)
52−#endif
51+ , Lit (..)
5352 , Q
5453 , runIO
5554 , qLocation, loc_filename
@@ -57,19 +56,26 @@ import Language.Haskell.TH.Syntax
5756 , Quasi(qAddDependentFile)
5857#endif
5958 )
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
6063import System.Directory (doesDirectoryExist, doesFileExist,
6164 getDirectoryContents, canonicalizePath)
62−import Control.Exception (throw, ErrorCall(..))
63−import Control.Monad (filterM)
65+import Control.Exception (throw, tryJust, ErrorCall(..))
66+import Control.Monad (filterM, guard)
6467import qualified Data.ByteString as B
6568import qualified Data.ByteString.Char8 as B8
6669import Control.Arrow ((&&&), second)
6770import Control.Applicative ((<$>))
6871import Data.ByteString.Unsafe (unsafePackAddressLen)
72+import System.IO.Error (isDoesNotExistError)
6973import System.IO.Unsafe (unsafePerformIO)
7074import System.FilePath ((</>), takeDirectory, takeExtension)
7175import Data.String (fromString)
7276import Prelude as P
77+import Data.List (sortBy)
78+import Data.Ord (comparing)
7379
7480-- | Embed a single file in your source code.
7581--
@@ -84,13 +90,40 @@ embedFile fp =
8490#endif
8591 (runIO $ B.readFile fp) >>= bsToExp
8692
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+
87120-- | Embed a single existing file in your source code
88121-- out of list a list of paths supplied.
89122--
90123-- > import qualified Data.ByteString
91124-- >
92125-- > myFile :: Data.ByteString.ByteString
93−-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])
126+-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])
94127embedOneFileOf :: [FilePath] -> Q Exp
95128embedOneFileOf ps =
96129 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
@@ -118,6 +151,18 @@ embedDir fp = do
118151 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
119152 return $ SigE e typ
120153
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+
121166-- | Get a directory tree in the IO monad.
122167--
123168-- This is the workhorse of 'embedDir'
@@ -130,7 +175,11 @@ pairToExp _root (path, bs) = do
130175 qAddDependentFile $ _root ++ '/' : path
131176#endif
132177 exp' <- bsToExp bs
133− return $! TupE [LitE $ StringL path, exp']
178+ return $! TupE
179+#if MIN_VERSION_template_haskell(2,16,0)
180+ $ map Just
181+#endif
182+ [LitE $ StringL path, exp']
134183
135184bsToExp :: B.ByteString -> Q Exp
136185#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -138,7 +187,11 @@ bsToExp bs =
138187 return $ VarE 'unsafePerformIO
139188 `AppE` (VarE 'unsafePackAddressLen
140189 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
141−#if MIN_VERSION_template_haskell(2, 8, 0)
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)
142195 `AppE` LitE (StringPrimL $ B.unpack bs))
143196#else
144197 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -213,7 +266,7 @@ fileList' realTop top = do
213266 mapM (liftPair2 . second B.readFile)
214267 dirs <- filterM (doesDirectoryExist . snd) all' >>=
215268 mapM (fileList' realTop . fst)
216− return $ concat $ files : dirs
269+ return $ sortBy (comparing fst) $ concat $ files : dirs
217270
218271liftPair2 :: Monad m => (a, m b) -> m (a, b)
219272liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -352,13 +405,23 @@ available, you can use the non-@With@ variants.
352405-- finds the first parent directory with a .cabal file, and uses that as the
353406-- root directory for fixing the relative path.
354407--
355−-- @@@
356−-- $(makeRelativeToProject "data/foo.txt" >>= embedFile)
357−-- @@@
408+-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
358409--
359410-- @since 0.0.10
360411makeRelativeToProject :: FilePath -> Q FilePath
361−makeRelativeToProject rel = do
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
362425 loc <- qLocation
363426 runIO $ do
364427 srcFP <- canonicalizePath $ loc_filename loc
@@ -373,8 +436,6 @@ makeRelativeToProject rel = do
373436 then return Nothing
374437 else do
375438 contents <- getDirectoryContents dir
376− if any isCabalFile contents
439+ if any isTargetFile contents
377440 then return (Just dir)
378441 else findProjectDir dir
379−
380− isCabalFile fp = takeExtension fp == ".cabal"