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


-- | Please see the README on GitHub at
--   <a>https://github.com/ChrisPenner/slick#readme</a>
@package slick
@version 0.2.0.0

module Slick.Caching

-- | A wrapper around <a>jsonCache</a> which simplifies caching of values
--   which do NOT depend on an input parameter. Unfortunately Shake still
--   requires that the key type implement several typeclasses, however this
--   is easily accomplished using <tt>GeneralizedNewtypeDeriving</tt> and a
--   wrapper around <tt>()</tt>. example usage:
--   
--   <pre>
--   {-# LANGUAGE GeneralizedNewtypeDeriving #-}
--   module Main where
--   newtype ProjectList = ProjectList ()
--     deriving (Show, Eq, Hashable, Binary, NFData)
--   </pre>
--   
--   Within your shake Rules:
--   
--   <pre>
--   projectCache = simpleJsonCache (ProjectList ()) $ do
--     -- load your project list here; returning it as a Value
--   </pre>
simpleJsonCache :: ShakeValue q => q -> Action Value -> Rules (Action Value)

-- | Like <a>simpleJsonCache</a> but allows caching any JSON serializable
--   object.
simpleJsonCache' :: forall q a. (ToJSON a, FromJSON a, ShakeValue q) => q -> Action a -> Rules (Action a)

-- | A wrapper around <a>addOracleCache</a> which given a <tt>q</tt> which
--   is a <a>ShakeValue</a> allows caching and retrieving <a>Value</a>s
--   within Shake. See documentation on <a>addOracleCache</a> or see Slick
--   examples for more info.
--   
--   <pre>
--   -- We need to define a unique datatype as our cache key
--   newtype PostFilePath =
--     PostFilePath String
--   -- We can derive the classes we need (using GeneralizedNewtypeDeriving) 
--   -- so long as the underlying type implements them
--     deriving (Show, Eq, Hashable, Binary, NFData)
--   -- now in our shake rules we can create a cache by providing a loader action
--   
--   do
--   postCache &lt;- jsonCache $ \(PostFilePath path) -&gt;
--     readFile' path &gt;&gt;= markdownToHTML . Text.pack
--   -- Now use postCache inside an Action to load your post with caching!
--   </pre>
jsonCache :: ShakeValue q => (q -> Action Value) -> Rules (q -> Action Value)

-- | Like <a>jsonCache</a> but allows caching/retrieving any JSON
--   serializable objects.
jsonCache' :: forall a q. (ToJSON a, FromJSON a, ShakeValue q) => (q -> Action a) -> Rules (q -> Action a)
instance Data.Hashable.Class.Hashable q => Data.Hashable.Class.Hashable (Slick.Caching.CacheQuery q)
instance Control.DeepSeq.NFData q => Control.DeepSeq.NFData (Slick.Caching.CacheQuery q)
instance Data.Binary.Class.Binary q => Data.Binary.Class.Binary (Slick.Caching.CacheQuery q)
instance GHC.Generics.Generic (Slick.Caching.CacheQuery q)
instance GHC.Classes.Eq q => GHC.Classes.Eq (Slick.Caching.CacheQuery q)
instance GHC.Show.Show q => GHC.Show.Show (Slick.Caching.CacheQuery q)

module Slick.Mustache

-- | Like <a>compileTemplate</a> but tracks changes to template files and
--   partials within Shake.
compileTemplate' :: FilePath -> Action Template

module Slick.Pandoc

-- | Convert markdown text into a <a>Value</a>; The <a>Value</a> has a
--   "content" key containing rendered HTML Metadata is assigned on the
--   respective keys in the <a>Value</a>
markdownToHTML :: Text -> Action Value

-- | Like <a>markdownToHTML</a> but allows returning any JSON serializable
--   object
markdownToHTML' :: (FromJSON a) => Text -> Action a

-- | Given a reader from <a>Readers</a> this creates a loader which given
--   the source document will read its metadata into a <a>Value</a>
--   returning both the <a>Pandoc</a> object and the metadata within an
--   <a>Action</a>
makePandocReader :: PandocReader textType -> textType -> Action (Pandoc, Value)

-- | Like <a>makePandocReader</a> but will deserialize the metadata into
--   any object which implements <a>FromJSON</a>. Failure to deserialize
--   will fail the Shake build.
makePandocReader' :: (FromJSON a) => PandocReader textType -> textType -> Action (Pandoc, a)

-- | Load in a source document using the given <a>PandocReader</a>, then
--   render the <a>Pandoc</a> into text using the given
--   <a>PandocWriter</a>. Returns a <a>Value</a> wherein the rendered text
--   is set to the "content" key and any metadata is set to its respective
--   key in the <a>Value</a>
loadUsing :: PandocReader textType -> PandocWriter -> textType -> Action Value

-- | Like <a>loadUsing</a> but allows also deserializes the <a>Value</a>
--   into any object which implements <a>FromJSON</a>. Failure to
--   deserialize will fail the Shake build.
loadUsing' :: (FromJSON a) => PandocReader textType -> PandocWriter -> textType -> Action a

-- | Attempt to convert between two JSON serializable objects (or
--   <a>Value</a>s). Failure to deserialize fails the Shake build.
convert :: (FromJSON a, ToJSON a, FromJSON b) => a -> Action b

-- | Reasonable options for rendering to HTML
html5Options :: WriterOptions

-- | Reasonable options for reading a markdown file
markdownOptions :: ReaderOptions
type PandocReader textType = textType -> PandocIO Pandoc
type PandocWriter = Pandoc -> PandocIO Text

module Slick

-- | Like <a>compileTemplate</a> but tracks changes to template files and
--   partials within Shake.
compileTemplate' :: FilePath -> Action Template
type PandocReader textType = textType -> PandocIO Pandoc
type PandocWriter = Pandoc -> PandocIO Text

-- | Convert markdown text into a <a>Value</a>; The <a>Value</a> has a
--   "content" key containing rendered HTML Metadata is assigned on the
--   respective keys in the <a>Value</a>
markdownToHTML :: Text -> Action Value

-- | Like <a>markdownToHTML</a> but allows returning any JSON serializable
--   object
markdownToHTML' :: (FromJSON a) => Text -> Action a

-- | Given a reader from <a>Readers</a> this creates a loader which given
--   the source document will read its metadata into a <a>Value</a>
--   returning both the <a>Pandoc</a> object and the metadata within an
--   <a>Action</a>
makePandocReader :: PandocReader textType -> textType -> Action (Pandoc, Value)

-- | Like <a>makePandocReader</a> but will deserialize the metadata into
--   any object which implements <a>FromJSON</a>. Failure to deserialize
--   will fail the Shake build.
makePandocReader' :: (FromJSON a) => PandocReader textType -> textType -> Action (Pandoc, a)

-- | Load in a source document using the given <a>PandocReader</a>, then
--   render the <a>Pandoc</a> into text using the given
--   <a>PandocWriter</a>. Returns a <a>Value</a> wherein the rendered text
--   is set to the "content" key and any metadata is set to its respective
--   key in the <a>Value</a>
loadUsing :: PandocReader textType -> PandocWriter -> textType -> Action Value

-- | Like <a>loadUsing</a> but allows also deserializes the <a>Value</a>
--   into any object which implements <a>FromJSON</a>. Failure to
--   deserialize will fail the Shake build.
loadUsing' :: (FromJSON a) => PandocReader textType -> PandocWriter -> textType -> Action a

-- | Reasonable options for reading a markdown file
markdownOptions :: ReaderOptions

-- | Reasonable options for rendering to HTML
html5Options :: WriterOptions

-- | Attempt to convert between two JSON serializable objects (or
--   <a>Value</a>s). Failure to deserialize fails the Shake build.
convert :: (FromJSON a, ToJSON a, FromJSON b) => a -> Action b

-- | A wrapper around <a>jsonCache</a> which simplifies caching of values
--   which do NOT depend on an input parameter. Unfortunately Shake still
--   requires that the key type implement several typeclasses, however this
--   is easily accomplished using <tt>GeneralizedNewtypeDeriving</tt> and a
--   wrapper around <tt>()</tt>. example usage:
--   
--   <pre>
--   {-# LANGUAGE GeneralizedNewtypeDeriving #-}
--   module Main where
--   newtype ProjectList = ProjectList ()
--     deriving (Show, Eq, Hashable, Binary, NFData)
--   </pre>
--   
--   Within your shake Rules:
--   
--   <pre>
--   projectCache = simpleJsonCache (ProjectList ()) $ do
--     -- load your project list here; returning it as a Value
--   </pre>
simpleJsonCache :: ShakeValue q => q -> Action Value -> Rules (Action Value)

-- | Like <a>simpleJsonCache</a> but allows caching any JSON serializable
--   object.
simpleJsonCache' :: forall q a. (ToJSON a, FromJSON a, ShakeValue q) => q -> Action a -> Rules (Action a)

-- | A wrapper around <a>addOracleCache</a> which given a <tt>q</tt> which
--   is a <a>ShakeValue</a> allows caching and retrieving <a>Value</a>s
--   within Shake. See documentation on <a>addOracleCache</a> or see Slick
--   examples for more info.
--   
--   <pre>
--   -- We need to define a unique datatype as our cache key
--   newtype PostFilePath =
--     PostFilePath String
--   -- We can derive the classes we need (using GeneralizedNewtypeDeriving) 
--   -- so long as the underlying type implements them
--     deriving (Show, Eq, Hashable, Binary, NFData)
--   -- now in our shake rules we can create a cache by providing a loader action
--   
--   do
--   postCache &lt;- jsonCache $ \(PostFilePath path) -&gt;
--     readFile' path &gt;&gt;= markdownToHTML . Text.pack
--   -- Now use postCache inside an Action to load your post with caching!
--   </pre>
jsonCache :: ShakeValue q => (q -> Action Value) -> Rules (q -> Action Value)

-- | Like <a>jsonCache</a> but allows caching/retrieving any JSON
--   serializable objects.
jsonCache' :: forall a q. (ToJSON a, FromJSON a, ShakeValue q) => (q -> Action a) -> Rules (q -> Action a)