-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Use Template Haskell to embed file contents directly.
--   
--   Use Template Haskell to read a file or all the files in a directory,
--   and turn them into (path, IsString) pairs embedded in your haskell
--   code. This is a (hopefully temporary) fork of the original file-embed
--   by Micheal Snoyman.
@package file-embed-poly
@version 0.1.0

module Data.FileEmbed.Inject

-- | Allocate the given number of bytes in the generate executable. That
--   space can be filled up with the <a>inject</a> and <a>injectFile</a>
--   functions.
dummySpace :: Int -> Q Exp

-- | Like <a>dummySpace</a>, but takes a postfix for the magic string. In
--   order for this to work, the same postfix must be used by <a>inject</a>
--   / <a>injectFile</a>. This allows an executable to have multiple
--   <tt>ByteString</tt>s injected into it, without encountering
--   collisions.
--   
--   Since 0.0.8
dummySpaceWith :: ByteString -> Int -> Q Exp

-- | Inject some raw data inside a <tt>ByteString</tt> containing empty,
--   dummy space (allocated with <tt>dummySpace</tt>). Typically, the
--   original <tt>ByteString</tt> is an executable read from the
--   filesystem.
inject :: ByteString -> ByteString -> Maybe ByteString

-- | Same as <a>inject</a>, but instead of performing the injecting in
--   memory, read the contents from the filesystem and write back to a
--   different file on the filesystem.
injectFile :: ByteString -> FilePath -> FilePath -> IO ()

-- | Like <a>inject</a>, but takes a postfix for the magic string.
--   
--   Since 0.0.8
injectWith :: ByteString -> ByteString -> ByteString -> Maybe ByteString

-- | Like <a>injectFile</a>, but takes a postfix for the magic string.
--   
--   Since 0.0.8
injectFileWith :: ByteString -> ByteString -> FilePath -> FilePath -> IO ()


-- | This module uses template Haskell. Following is a simplified
--   explanation of usage for those unfamiliar with calling Template
--   Haskell functions.
--   
--   The function <tt>embedFile</tt> in this modules embeds a file into the
--   executable that you can use it at runtime. A file is represented as a
--   <tt>ByteString</tt>. However, as you can see below, the type signature
--   indicates a value of type <tt>Q Exp</tt> will be returned. In order to
--   convert this into a <tt>ByteString</tt>, you must use Template Haskell
--   syntax, e.g.:
--   
--   <pre>
--   $(embedFile "myfile.txt")
--   </pre>
--   
--   This expression will have type <tt>ByteString</tt>. Be certain to
--   enable the TemplateHaskell language extension, usually by adding the
--   following to the top of your module:
--   
--   <pre>
--   {-# LANGUAGE TemplateHaskell #-}
--   </pre>
module Data.FileEmbed

-- | Embed a single file in your source code.
--   
--   <pre>
--   import Data.String
--   
--   myFile :: IsString a =&gt; a
--   myFile = $(embedFile "dirName/fileName")
--   </pre>
embedFile :: FilePath -> Q Exp

-- | Embed a single existing string file in your source code out of list a
--   list of paths supplied.
embedOneFileOf :: [FilePath] -> Q Exp

-- | Embed a directory recursively in your source code.
--   
--   <pre>
--   import Data.String
--   
--   myDir :: IsString a =&gt; [(FilePath, a)]
--   myDir = $(embedDir "dirName")
--   </pre>
embedDir :: FilePath -> Q Exp

-- | Take a relative file path and attach it to the root of the current
--   project.
--   
--   The idea here is that, when building with Stack, the build will always
--   be executed with a current working directory of the root of the
--   project (where your .cabal file is located). However, if you load up
--   multiple projects with <tt>stack ghci</tt>, the working directory may
--   be something else entirely.
--   
--   This function looks at the source location of the Haskell file calling
--   it, finds the first parent directory with a .cabal file, and uses that
--   as the root directory for fixing the relative path.
--   
--   <pre>
--   $(makeRelativeToProject "data/foo.txt" &gt;&gt;= embedFile)
--   </pre>
makeRelativeToProject :: FilePath -> Q FilePath