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


-- | error functions that show file location information
--   
--   Error functions that give file location information
--   
--   <pre>
--   $(err "OH NO!")
--   
--   main:Main main.hs:16:1 OH NO!
--   </pre>
--   
--   Notice how it displays package:module file:line:character It exposes
--   the functions err (error), undef (undefined), and trc
--   (Debug.Trace.trace). All of these behave the same as their normal
--   counterpart but also spit out a location.
--   
--   I also included my favorite helper, debug, which is like trace but
--   just show the value.
--   
--   <pre>
--   debug [1,2,3]
--   
--   DEBUG: [1,2,3]
--   [1,2,3]
--   </pre>
--   
--   And The Template Haskell version.
--   
--   <pre>
--   $(dbg) [1,2,3]
--   
--   DEBUG main:Main main.hs:1:3 [1,2,3]
--   [1,2,3]
--   </pre>
--   
--   See module for a listing of all the functions with short descriptions,
--   and the homepage for some more examples
--   https:<i></i>github.com<i>gregwebs</i>ErrorLocation.hs
@package error-location
@version 0.1.5.2

module ErrorLocation

-- | like Prelude.error, but gives the file location
--   
--   <pre>
--   $(err "OH NO!)
--   main:Main main.hs:4:10 OH NO!
--   </pre>
err :: String -> Q Exp

-- | like Prelude.undefined, but gives the file location use trace to
--   output the location. this way we still use undefined instead of
--   calling error
--   
--   <pre>
--   $(undef)
--   main:Main main.hs:4:10 undefined
--   err: Prelude.undefined
--   </pre>
undef :: Q Exp

-- | A version of Debug.Trace.trace that just prints a value. This should
--   be included in Debug.Trace
debug :: Show a => a -> a

-- | monadic debug - like debug, but works as a standalone line in a monad
--   TODO: TH version with error loaction info
debugM :: (Monad m, Show a) => a -> m a

-- | A version of Debug.Trace.trace that just prints a value and a message.
--   This should be included in Debug.Trace
debugMsg :: Show a => String -> a -> a

-- | TH version of Debug.Trace.trace that just prints a value.
dbg :: Q Exp

-- | TH version of Debug.Trace.trace that prints a value and a message
--   prefix).
dbgMsg :: String -> Q Exp

-- | A TH version of Debug.Trace.trace that prints location information
trc :: String -> Q Exp

-- | labelled trace - like strace, with a label prepended
ltrace :: Show a => String -> a -> a

-- | monadic debug - like debug, but works as a standalone line in a monad
--   TODO: TH version with error loaction info
ltraceM :: (Monad m, Show a) => String -> a -> m a

-- | trace (print on stdout at runtime) a showable expression like debug,
--   but does not print <a>DEBUG: </a>
strace :: Show a => a -> a