Cabal-2.2.0.1: A framework for packaging Haskell software

Distribution.Compat.Stack

Synopsis

# Documentation

data CallStack Source #

CallStacks are a lightweight method of obtaining a partial call-stack at any point in the program.

A function can request its call-site with the HasCallStack constraint. For example, we can define

putStrLnWithCallStack :: HasCallStack => String -> IO ()


as a variant of putStrLn that will get its call-site and print it, along with the string given as argument. We can access the call-stack inside putStrLnWithCallStack with callStack.

putStrLnWithCallStack :: HasCallStack => String -> IO ()
putStrLnWithCallStack msg = do
putStrLn msg
putStrLn (prettyCallStack callStack)


Thus, if we call putStrLnWithCallStack we will get a formatted call-stack alongside our string.

>>> putStrLnWithCallStack "hello"
hello
CallStack (from HasCallStack):
putStrLnWithCallStack, called at <interactive>:2:1 in interactive:Ghci1


GHC solves HasCallStack constraints in three steps:

1. If there is a CallStack in scope -- i.e. the enclosing function has a HasCallStack constraint -- GHC will append the new call-site to the existing CallStack.
2. If there is no CallStack in scope -- e.g. in the GHCi session above -- and the enclosing definition does not have an explicit type signature, GHC will infer a HasCallStack constraint for the enclosing definition (subject to the monomorphism restriction).
3. If there is no CallStack in scope and the enclosing definition has an explicit type signature, GHC will solve the HasCallStack constraint for the singleton CallStack containing just the current call-site.

CallStacks do not interact with the RTS and do not require compilation with -prof. On the other hand, as they are built up explicitly via the HasCallStack constraints, they will generally not contain as much information as the simulated call-stacks maintained by the RTS.

A CallStack is a [(String, SrcLoc)]. The String is the name of function that was called, the SrcLoc is the call-site. The list is ordered with the most recently called function at the head.

NOTE: The intrepid user may notice that HasCallStack is just an alias for an implicit parameter ?callStack :: CallStack. This is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

Since: base-4.8.1.0

Instances
 Be aware that 'fromList . toList = id' only for unfrozen CallStacks, since toList removes frozenness information.Since: base-4.9.0.0 Instance detailsDefined in GHC.Exts Associated Typestype Item CallStack :: * Source # Methods Since: base-4.9.0.0 Instance detailsDefined in GHC.Show MethodsshowList :: [CallStack] -> ShowS Source # Since: deepseq-1.4.2.0 Instance detailsDefined in Control.DeepSeq Methodsrnf :: CallStack -> () Source # type Item CallStack Instance detailsDefined in GHC.Exts type Item CallStack = (String, SrcLoc)

This function is for when you *really* want to add a call stack to raised IO, but you don't have a Verbosity so you can't use annotateIO. If you have a Verbosity, please use that function instead.

withFrozenCallStack :: HasCallStack => (HasCallStack -> a) -> a Source #

Perform some computation without adding new entries to the CallStack.

Since: base-4.9.0.0

Return the current CallStack.

Does *not* include the call-site of callStack.

Since: base-4.9.0.0

Pretty print a CallStack.

Since: base-4.9.0.0

Give the *parent* of the person who invoked this; so it's most suitable for being called from a utility function. You probably want to call this using withFrozenCallStack; otherwise it's not very useful. We didn't implement this for base-4.8.1 because we cannot rely on freezing to have taken place.