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


-- | Quasiquoters for printf
--   
--   Quasiquoters for string and text printf
@package th-printf
@version 0.8

module Language.Haskell.Printf.Lib

-- | Takes a format string as input and produces a tuple <tt>(args,
--   outputExpr)</tt>.
--   
--   This function processes character escapes as they would appear in
--   Haskell source code. It will emit warnings (or throw an error, as
--   appropriate) when given an invalid format string.
--   
--   Use if you wish to leverage <tt>th-printf</tt> in conjunction with,
--   for example, an existing logging library.
toSplices :: String -> OutputType -> Q ([Pat], Exp)
data OutputType
OutputString :: OutputType
OutputText :: OutputType
instance GHC.Enum.Bounded Language.Haskell.Printf.Lib.OutputType
instance GHC.Enum.Enum Language.Haskell.Printf.Lib.OutputType
instance GHC.Generics.Generic Language.Haskell.Printf.Lib.OutputType
instance GHC.Classes.Ord Language.Haskell.Printf.Lib.OutputType
instance GHC.Classes.Eq Language.Haskell.Printf.Lib.OutputType
instance GHC.Show.Show Language.Haskell.Printf.Lib.OutputType


-- | <a>Text.Printf</a> is a useful module, but due to the typeclass hacks
--   it uses, it can be hard to tell if the format string you wrote is
--   well-formed or not. This package provides a mechanism to create
--   formatting functions at compile time.
--   
--   Note that, to maintain consistency with other printf implementations,
--   negative ints that are printed as unsigned will "underflow".
--   (Text.Printf does this too.)
--   
--   <pre>
--   &gt;&gt;&gt; [s|%u|] (-1 :: Int32)
--   WAS "4294967295"
--   NOW Not in scope: type constructor or class `Int32'
--   </pre>
--   
--   Thus, any time you want to print a number using the unsigned, octal,
--   or hex specifiers, your input must be an instance of <a>Bounded</a>.
module Language.Haskell.Printf

-- | <pre>
--   [<a>s</a>|Hello, %s! (%d people greeted)|] :: ... -&gt; <a>String</a>
--   </pre>
--   
--   This formatter follows the guidelines listed <a>here</a>, except for
--   <tt>%n</tt> (store number of printed characters) for obvious reasons.
--   
--   <pre>
--   %c     :: <a>Char</a>
--   %s     :: <a>String</a>
--   %q     :: <a>Text</a> -- lazy text
--   %Q     :: <a>Text</a> -- strict text
--   
--   -- datatypes with Show instances
--   %?     :: <a>Show</a> a =&gt; a
--   
--   -- signed integer types
--   %d, %i :: <a>Integral</a> i =&gt; i
--   
--   -- unsigned integer types
--   %u     :: (<a>Bounded</a> i, <a>Integral</a> i) =&gt; i
--   %o     :: (<a>Bounded</a> i, <a>Integral</a> i) =&gt; i
--   %x, %X :: (<a>Bounded</a> i, <a>Integral</a> i) =&gt; i
--   
--   -- floats
--   %a, %A :: <a>RealFloat</a> f =&gt; f
--   %e, %E :: <a>RealFloat</a> f =&gt; f
--   %f, %F :: <a>RealFloat</a> f =&gt; f
--   %g, %G :: <a>RealFloat</a> f =&gt; f
--   
--   %p     :: <a>Ptr</a> a
--   </pre>
s :: QuasiQuoter

-- | Behaves identically to <a>s</a>, but produces lazy <a>Text</a>.
t :: QuasiQuoter

-- | Like <a>s</a>, but prints the resulting string to <tt>stdout</tt>.
--   
--   <pre>
--   [p|Hello, %s! (%d people greeted)|] :: <a>MonadIO</a> m =&gt; ... -&gt; m ()
--   </pre>
p :: QuasiQuoter

-- | Like <a>p</a>, but takes as its first argument the <a>Handle</a> to
--   print to.
--   
--   <pre>
--   [hp|Hello, %s! (%d people greeted)|] :: <a>MonadIO</a> m =&gt; <a>Handle</a> -&gt; ... -&gt; m ()
--   </pre>
hp :: QuasiQuoter