@@ -19,8 +19,10 @@
19module Data.FileEmbed
19module Data.FileEmbed
20 ( -- * Embed at compile time
20 ( -- * Embed at compile time
22 , embedOneFileOf
23 , embedOneFileOf
23 , embedDir
24 , embedDir
25 -- * Embed as a IsString
27 -- * Embed as a IsString
26 , embedStringFile
28 , embedStringFile
@@ -35,6 +37,9 @@ module Data.FileEmbed
35 , injectFile
37 , injectFile
36 , injectWith
38 , injectWith
37 , injectFileWith
39 , injectFileWith
40+ -- * Relative path manipulation
41+ , makeRelativeToProject
42+ , makeRelativeToLocationPredicate
38 -- * Internal
43 -- * Internal
39 , stringToBs
44 , stringToBs
@@ -43,30 +48,34 @@ module Data.FileEmbed
44import Language.Haskell.TH.Syntax
49import Language.Haskell.TH.Syntax
45 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
50 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
46−#if MIN_VERSION_template_haskell(2,5,0)
51+ , Lit (..)
47− , Lit (StringL, StringPrimL, IntegerL)
49− , Lit (StringL, IntegerL)
54+ , qLocation, loc_filename
53#if MIN_VERSION_template_haskell(2,7,0)
55#if MIN_VERSION_template_haskell(2,7,0)
54 , Quasi(qAddDependentFile)
56 , Quasi(qAddDependentFile)
59+#if MIN_VERSION_template_haskell(2,16,0)
60+import Language.Haskell.TH ( mkBytes, bytesPrimL )
61+import qualified Data.ByteString.Internal as B
57import System.Directory (doesDirectoryExist, doesFileExist,
63import System.Directory (doesDirectoryExist, doesFileExist,
58− getDirectoryContents)
64+ getDirectoryContents, canonicalizePath)
59−import Control.Exception (throw, ErrorCall(..))
65+import Control.Exception (throw, tryJust, ErrorCall(..))
60−import Control.Monad (filterM)
66+import Control.Monad (filterM, guard)
61import qualified Data.ByteString as B
67import qualified Data.ByteString as B
62import qualified Data.ByteString.Char8 as B8
68import qualified Data.ByteString.Char8 as B8
63import Control.Arrow ((&&&), second)
69import Control.Arrow ((&&&), second)
64import Control.Applicative ((<$>))
70import Control.Applicative ((<$>))
65import Data.ByteString.Unsafe (unsafePackAddressLen)
71import Data.ByteString.Unsafe (unsafePackAddressLen)
72+import System.IO.Error (isDoesNotExistError)
66import System.IO.Unsafe (unsafePerformIO)
73import System.IO.Unsafe (unsafePerformIO)
67−import System.FilePath ((</>))
74+import System.FilePath ((</>), takeDirectory, takeExtension)
68import Data.String (fromString)
75import Data.String (fromString)
69import Prelude as P
76import Prelude as P
77+import Data.List (sortBy)
78+import Data.Ord (comparing)
71-- | Embed a single file in your source code.
80-- | Embed a single file in your source code.
@@ -81,13 +90,40 @@ embedFile fp =
82 (runIO $ B.readFile fp) >>= bsToExp
91 (runIO $ B.readFile fp) >>= bsToExp
93+-- | Maybe embed a single file in your source code depending on whether or not file exists.
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.
98+-- > import qualified Data.ByteString
100+-- > maybeMyFile :: Maybe Data.ByteString.ByteString
101+-- > maybeMyFile = $(embedFileIfExists "dirName/fileName")
104+embedFileIfExists :: FilePath -> Q Exp
105+embedFileIfExists fp = do
106+ mbs <- runIO maybeFile
108+ Nothing -> [| Nothing |]
110+#if MIN_VERSION_template_haskell(2,7,0)
111+ qAddDependentFile fp
113+ [| Just $(bsToExp bs) |]
115+ maybeFile :: IO (Maybe B.ByteString)
117+ either (const Nothing) Just <$>
118+ tryJust (guard . isDoesNotExistError) (B.readFile fp)
84-- | Embed a single existing file in your source code
120-- | Embed a single existing file in your source code
85-- out of list a list of paths supplied.
121-- out of list a list of paths supplied.
87-- > import qualified Data.ByteString
123-- > import qualified Data.ByteString
89-- > myFile :: Data.ByteString.ByteString
125-- > myFile :: Data.ByteString.ByteString
90−-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])
126+-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])
91embedOneFileOf :: [FilePath] -> Q Exp
127embedOneFileOf :: [FilePath] -> Q Exp
92embedOneFileOf ps =
128embedOneFileOf ps =
93 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
129 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
@@ -115,6 +151,18 @@ embedDir fp = do
115 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
151 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
116 return $ SigE e typ
152 return $ SigE e typ
154+-- | Embed a directory listing recursively in your source code.
156+-- > myFiles :: [FilePath]
157+-- > myFiles = $(embedDirListing "dirName")
160+embedDirListing :: FilePath -> Q Exp
161+embedDirListing fp = do
162+ typ <- [t| [FilePath] |]
163+ e <- ListE <$> ((runIO $ fmap fst <$> fileList fp) >>= mapM strToExp)
118-- | Get a directory tree in the IO monad.
166-- | Get a directory tree in the IO monad.
120-- This is the workhorse of 'embedDir'
168-- This is the workhorse of 'embedDir'
@@ -127,7 +175,11 @@ pairToExp _root (path, bs) = do
127 qAddDependentFile $ _root ++ '/' : path
175 qAddDependentFile $ _root ++ '/' : path
129 exp' <- bsToExp bs
177 exp' <- bsToExp bs
179+#if MIN_VERSION_template_haskell(2,16,0)
130− return $! TupE [LitE $ StringL path, exp']
182+ [LitE $ StringL path, exp']
132bsToExp :: B.ByteString -> Q Exp
184bsToExp :: B.ByteString -> Q Exp
133#if MIN_VERSION_template_haskell(2, 5, 0)
185#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -135,7 +187,11 @@ bsToExp bs =
135 return $ VarE 'unsafePerformIO
187 return $ VarE 'unsafePerformIO
136 `AppE` (VarE 'unsafePackAddressLen
188 `AppE` (VarE 'unsafePackAddressLen
137 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
189 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
138−#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)
139 `AppE` LitE (StringPrimL $ B.unpack bs))
195 `AppE` LitE (StringPrimL $ B.unpack bs))
141 `AppE` LitE (StringPrimL $ B8.unpack bs))
197 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -210,7 +266,7 @@ fileList' realTop top = do
210 mapM (liftPair2 . second B.readFile)
266 mapM (liftPair2 . second B.readFile)
211 dirs <- filterM (doesDirectoryExist . snd) all' >>=
267 dirs <- filterM (doesDirectoryExist . snd) all' >>=
212 mapM (fileList' realTop . fst)
268 mapM (fileList' realTop . fst)
213− return $ concat $ files : dirs
269+ return $ sortBy (comparing fst) $ concat $ files : dirs
215liftPair2 :: Monad m => (a, m b) -> m (a, b)
271liftPair2 :: Monad m => (a, m b) -> m (a, b)
216liftPair2 (a, b) = b >>= \b' -> return (a, b')
272liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -336,3 +392,50 @@ the magic key. If you know for certain that there will only be one dummy space
336available, you can use the non-@With@ variants.
392available, you can use the non-@With@ variants.
396+-- | Take a relative file path and attach it to the root of the current
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.
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.
408+-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
411+makeRelativeToProject :: FilePath -> Q FilePath
412+makeRelativeToProject = makeRelativeToLocationPredicate $ (==) ".cabal" . takeExtension
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
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.
420+-- @$(makeRelativeToLocationPredicate ((==) ".cabal" . takeExtension) "data/foo.txt" >>= embedFile)@
423+makeRelativeToLocationPredicate :: (FilePath -> Bool) -> FilePath -> Q FilePath
424+makeRelativeToLocationPredicate isTargetFile rel = do
427+ srcFP <- canonicalizePath $ loc_filename loc
428+ mdir <- findProjectDir srcFP
430+ Nothing -> error $ "Could not find .cabal file for path: " ++ srcFP
431+ Just dir -> return $ dir </> rel
433+ findProjectDir x = do
434+ let dir = takeDirectory x
438+ contents <- getDirectoryContents dir
439+ if any isTargetFile contents
440+ then return (Just dir)
441+ else findProjectDir dir