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


-- | Painfully simple URL writing combinators
--   
@package urlpath
@version 0.0.2

module UrlPath.Types

-- | A GET parameter encoded in a Url.
data GETParam
GETParam :: !Text -> !Text -> GETParam

-- | Key for a get parameter.
key :: GETParam -> !Text

-- | Value for the key.
val :: GETParam -> !Text

-- | Render a GET parameter pair.
renderGETParam :: GETParam -> Text

-- | A Url string - a target page and GET parameters.
data UrlString
UrlString :: !Text -> [GETParam] -> UrlString

-- | Relative base file - eg) <tt>"foo.php"</tt> in
--   <tt>"foo.php?bar=baz"</tt>.
target :: UrlString -> !Text

-- | GET Parameters.
params :: UrlString -> [GETParam]

-- | Render a Url String <i>simply</i> - this is equivalent to
--   <tt>expandRelative</tt>.
renderUrlString :: UrlString -> Text

-- | Lifts a target path with some GET parameter chunks into a
--   <tt>UrlString</tt>.
(<?>) :: Text -> (Text, Text) -> UrlString

-- | Adds more GET parameters to a <tt>UrlString</tt>.
(<&>) :: UrlString -> (Text, Text) -> UrlString

-- | Render the Url String as relative
expandRelative :: UrlString -> Text

-- | Render the Url String as grounded
expandGrounded :: UrlString -> Text

-- | Render the Url String as absolute - getting the root from a
--   MonadReader.
expandAbsolute :: MonadReader Text m => UrlString -> m Text

-- | Render the Url String as absolute, but with your own configuration
--   type.
--   
--   <pre>
--   data SiteConfig = SiteConfig { host :: T.Text
--                                , cdnHost :: T.Text
--                                }
--     deriving (Show, Eq)
--             
--   foo :: HtmlT (Reader SiteConfig) ()
--   foo = do
--     url &lt;- lift $ expandAbsoluteWith ("foo.php" &lt;?&gt; ("bar","baz")) host
--     script_ [src_ url] ""
--   
--   bar :: LT.Text 
--   bar = (runReader (runTextT foo)) $
--     SiteConfig "example.com" "cdn.example.com"
--   </pre>
expandAbsoluteWith :: MonadReader a m => UrlString -> (a -> Text) -> m Text

-- | Rendering mode transformer. This isn't an instance of
--   <tt>UrlReader</tt> - to use, simple <tt>lift</tt> as many levels as
--   you need:
--   
--   <pre>
--   foo :: Monad m =&gt; HtmlT (RelativeUrlT m) ()
--   foo = do
--     url &lt;- lift $ renderUrl $ "foo.php" &lt;?&gt; ("bar","baz")
--     script_ [src_ url] ""
--   </pre>
--   
--   When rendering <tt>foo</tt>, simply use the Transformer's <tt>run</tt>
--   function to convert it to a reader:
--   
--   <pre>
--   bar :: Monad m =&gt; m LT.Text
--   bar = (runRelativeUrlT (renderTextT foo)) "example.com"
--   </pre>
--   
--   It is generally simpler (but more restrictive) to use the
--   non-transformer variety.
newtype RelativeUrlT m a
RelativeUrlT :: (Text -> m a) -> RelativeUrlT m a
runRelativeUrlT :: RelativeUrlT m a -> Text -> m a

-- | Concrete Monad for automatically coercing HtmlT's to use a mode of Url
--   rendering (relative, grounded, or absolute).
--   
--   <pre>
--   foo :: HtmlT RelativeUrl ()
--   foo = do
--     url &lt;- lift $ renderUrl $ "foo.php" &lt;?&gt; ("bar","baz")
--     script_ [src_ url] ""
--   </pre>
--   
--   when rendering these simple monads for automatic conversion via
--   coercion, use the <tt>runUrlReader</tt> member function of the
--   <tt>UrlReader</tt> typeclass:
--   
--   <pre>
--   bar :: LT.Text
--   bar = (runUrlReader (renderTextT foo)) "example.com"
--   </pre>
--   
--   To change the mode of rendering, simple change the coerced type of
--   <tt>foo</tt>.
newtype RelativeUrl a
RelativeUrl :: (Text -> a) -> RelativeUrl a
runRelativeUrl :: RelativeUrl a -> Text -> a
newtype GroundedUrlT m a
GroundedUrlT :: (Text -> m a) -> GroundedUrlT m a
runGroundedUrlT :: GroundedUrlT m a -> Text -> m a
newtype GroundedUrl a
GroundedUrl :: (Text -> a) -> GroundedUrl a
runGroundedUrl :: GroundedUrl a -> Text -> a
newtype AbsoluteUrlT m a
AbsoluteUrlT :: (Text -> m a) -> AbsoluteUrlT m a
runAbsoluteUrlT :: AbsoluteUrlT m a -> Text -> m a
newtype AbsoluteUrl a
AbsoluteUrl :: (Text -> a) -> AbsoluteUrl a
runAbsoluteUrl :: AbsoluteUrl a -> Text -> a
instance Show GETParam
instance Eq GETParam
instance Show UrlString
instance Eq UrlString
instance MonadReader Text AbsoluteUrl
instance Monad AbsoluteUrl
instance Applicative AbsoluteUrl
instance Functor AbsoluteUrl
instance Monad m => MonadReader Text (AbsoluteUrlT m)
instance MonadTrans AbsoluteUrlT
instance Monad m => Monad (AbsoluteUrlT m)
instance Applicative f => Applicative (AbsoluteUrlT f)
instance Functor f => Functor (AbsoluteUrlT f)
instance MonadReader Text GroundedUrl
instance Monad GroundedUrl
instance Applicative GroundedUrl
instance Functor GroundedUrl
instance Monad m => MonadReader Text (GroundedUrlT m)
instance MonadTrans GroundedUrlT
instance Monad m => Monad (GroundedUrlT m)
instance Applicative f => Applicative (GroundedUrlT f)
instance Functor f => Functor (GroundedUrlT f)
instance MonadReader Text RelativeUrl
instance Monad RelativeUrl
instance Applicative RelativeUrl
instance Functor RelativeUrl
instance Monad m => MonadReader Text (RelativeUrlT m)
instance MonadTrans RelativeUrlT
instance Monad m => Monad (RelativeUrlT m)
instance Applicative f => Applicative (RelativeUrlT f)
instance Functor f => Functor (RelativeUrlT f)

module UrlPath

-- | Convenience typeclass for a uniform interface into pure
--   <tt>Reader</tt>-like monads.
class MonadReader Text m => UrlReader (m :: * -> *)
runUrlReader :: UrlReader m => m a -> Text -> a

-- | <tt>Url</tt> takes an input type <tt>a</tt>, and returns a modality
--   <tt>f</tt> around <tt>T.Text</tt>.
class Monad m => Url a m
renderUrl :: Url a m => a -> m Text
instance Monad m => Url UrlString (AbsoluteUrlT m)
instance Monad m => Url UrlString (GroundedUrlT m)
instance Monad m => Url UrlString (RelativeUrlT m)
instance Url UrlString AbsoluteUrl
instance Url UrlString GroundedUrl
instance Url UrlString RelativeUrl
instance Url Text Identity
instance UrlReader GroundedUrl
instance UrlReader RelativeUrl
instance UrlReader AbsoluteUrl
instance UrlReader Identity
instance MonadReader Text Identity