Hedgehog.Internal.Source

Documentation

newtype LineNo

Constructors

LineNo

Fields

• unLineNo :: Int

Instances

Enum LineNo

Defined in Hedgehog.Internal.Source

Methods

succ :: LineNo -> LineNo

pred :: LineNo -> LineNo

toEnum :: Int -> LineNo

fromEnum :: LineNo -> Int

enumFrom :: LineNo -> [LineNo]

enumFromThen :: LineNo -> LineNo -> [LineNo]

enumFromTo :: LineNo -> LineNo -> [LineNo]

enumFromThenTo :: LineNo -> LineNo -> LineNo -> [LineNo]

Eq LineNo

Defined in Hedgehog.Internal.Source

Methods

(==) :: LineNo -> LineNo -> Bool

(/=) :: LineNo -> LineNo -> Bool

Integral LineNo

Defined in Hedgehog.Internal.Source

Methods

quot :: LineNo -> LineNo -> LineNo

rem :: LineNo -> LineNo -> LineNo

div :: LineNo -> LineNo -> LineNo

mod :: LineNo -> LineNo -> LineNo

quotRem :: LineNo -> LineNo -> (LineNo, LineNo)

divMod :: LineNo -> LineNo -> (LineNo, LineNo)

toInteger :: LineNo -> Integer

Num LineNo

Defined in Hedgehog.Internal.Source

Methods

(+) :: LineNo -> LineNo -> LineNo

(-) :: LineNo -> LineNo -> LineNo

(*) :: LineNo -> LineNo -> LineNo

negate :: LineNo -> LineNo

abs :: LineNo -> LineNo

signum :: LineNo -> LineNo

fromInteger :: Integer -> LineNo

Ord LineNo

Defined in Hedgehog.Internal.Source

Methods

compare :: LineNo -> LineNo -> Ordering

(<) :: LineNo -> LineNo -> Bool

(<=) :: LineNo -> LineNo -> Bool

(>) :: LineNo -> LineNo -> Bool

(>=) :: LineNo -> LineNo -> Bool

max :: LineNo -> LineNo -> LineNo

min :: LineNo -> LineNo -> LineNo

Real LineNo

Defined in Hedgehog.Internal.Source

Methods

toRational :: LineNo -> Rational

Show LineNo

Defined in Hedgehog.Internal.Source

Methods

showsPrec :: Int -> LineNo -> ShowS

show :: LineNo -> String

showList :: [LineNo] -> ShowS

newtype ColumnNo

Constructors

ColumnNo

Fields

• unColumnNo :: Int

Instances

Enum ColumnNo

Defined in Hedgehog.Internal.Source

Methods

succ :: ColumnNo -> ColumnNo

pred :: ColumnNo -> ColumnNo

toEnum :: Int -> ColumnNo

fromEnum :: ColumnNo -> Int

enumFrom :: ColumnNo -> [ColumnNo]

enumFromThen :: ColumnNo -> ColumnNo -> [ColumnNo]

enumFromTo :: ColumnNo -> ColumnNo -> [ColumnNo]

enumFromThenTo :: ColumnNo -> ColumnNo -> ColumnNo -> [ColumnNo]

Eq ColumnNo

Defined in Hedgehog.Internal.Source

Methods

(==) :: ColumnNo -> ColumnNo -> Bool

(/=) :: ColumnNo -> ColumnNo -> Bool

Integral ColumnNo

Defined in Hedgehog.Internal.Source

Methods

quot :: ColumnNo -> ColumnNo -> ColumnNo

rem :: ColumnNo -> ColumnNo -> ColumnNo

div :: ColumnNo -> ColumnNo -> ColumnNo

mod :: ColumnNo -> ColumnNo -> ColumnNo

quotRem :: ColumnNo -> ColumnNo -> (ColumnNo, ColumnNo)

divMod :: ColumnNo -> ColumnNo -> (ColumnNo, ColumnNo)

toInteger :: ColumnNo -> Integer

Num ColumnNo

Defined in Hedgehog.Internal.Source

Methods

(+) :: ColumnNo -> ColumnNo -> ColumnNo

(-) :: ColumnNo -> ColumnNo -> ColumnNo

(*) :: ColumnNo -> ColumnNo -> ColumnNo

negate :: ColumnNo -> ColumnNo

abs :: ColumnNo -> ColumnNo

signum :: ColumnNo -> ColumnNo

fromInteger :: Integer -> ColumnNo

Ord ColumnNo

Defined in Hedgehog.Internal.Source

Methods

compare :: ColumnNo -> ColumnNo -> Ordering

(<) :: ColumnNo -> ColumnNo -> Bool

(<=) :: ColumnNo -> ColumnNo -> Bool

(>) :: ColumnNo -> ColumnNo -> Bool

(>=) :: ColumnNo -> ColumnNo -> Bool

max :: ColumnNo -> ColumnNo -> ColumnNo

min :: ColumnNo -> ColumnNo -> ColumnNo

Real ColumnNo

Defined in Hedgehog.Internal.Source

Methods

toRational :: ColumnNo -> Rational

Show ColumnNo

Defined in Hedgehog.Internal.Source

Methods

showsPrec :: Int -> ColumnNo -> ShowS

show :: ColumnNo -> String

showList :: [ColumnNo] -> ShowS

data Span

Constructors

Span

Fields

• spanFile :: !FilePath
• spanStartLine :: !LineNo
• spanStartColumn :: !ColumnNo
• spanEndLine :: !LineNo
• spanEndColumn :: !ColumnNo

Instances

Eq Span

Defined in Hedgehog.Internal.Source

Methods

(==) :: Span -> Span -> Bool

(/=) :: Span -> Span -> Bool

Ord Span

Defined in Hedgehog.Internal.Source

Methods

compare :: Span -> Span -> Ordering

(<) :: Span -> Span -> Bool

(<=) :: Span -> Span -> Bool

(>) :: Span -> Span -> Bool

(>=) :: Span -> Span -> Bool

max :: Span -> Span -> Span

min :: Span -> Span -> Span

Show Span

Defined in Hedgehog.Internal.Source

Methods

showsPrec :: Int -> Span -> ShowS

show :: Span -> String

showList :: [Span] -> ShowS

getCaller :: CallStack -> Maybe Span

Re-exports from GHC.Stack

data CallStack

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

IsList CallStack

Be aware that 'fromList . toList = id' only for unfrozen CallStacks, since toList removes frozenness information.

Since: base-4.9.0.0

Defined in GHC.Exts

Associated Types

type Item CallStack :: Type

Methods

fromList :: [Item CallStack] -> CallStack

fromListN :: Int -> [Item CallStack] -> CallStack

toList :: CallStack -> [Item CallStack]

Show CallStack

Since: base-4.9.0.0

Defined in GHC.Show

Methods

showsPrec :: Int -> CallStack -> ShowS

show :: CallStack -> String

showList :: [CallStack] -> ShowS

type Item CallStack

Defined in GHC.Exts

type Item CallStack = (String, SrcLoc)

type HasCallStack = ?callStack :: CallStack

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack 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.9.0.0

callStack :: HasCallStack -> CallStack

Return the current CallStack.

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

Since: base-4.9.0.0

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

Perform some computation without adding new entries to the CallStack.

Since: base-4.9.0.0