Modulebreakpoint-0.1.4.0Haskell2010

Debug.Breakpoint

17 values

Packagebreakpoint-0.1.4.0
Exports18
LanguageHaskell2010
LicenceMIT
SourceBreakpoint.hs

Plugin

1 declaration

valueplugin :: Plugin

API

7 declarations

valuebreakpoint :: a -> a

Sets a breakpoint in pure code

valuebreakpointM :: Applicative m => m ()

Sets a breakpoint in an arbitrary Applicative. Uses unsafePerformIO which means that laziness and common sub-expression elimination can result in the breakpoint not being hit as expected. For this reason, you should prefer breakpointIO if a MonadIO instance is available.

valuebreakpointIO :: MonadIO m => m ()

Sets a breakpoint in an IO based Monad. You should favor this over breakpointM if the monad can perform IO.

valuequeryVars :: a -> a

When evaluated, displays the names of variables visible from the callsite and starts a prompt where entering a variable will display its value. You may want to use this instead of breakpoint if there are value which should stay unevaluated or you are only interested in certain values. Only the current thread is blocked while the prompt is active. To resume execution, press enter with a blank prompt.

valuequeryVarsM :: Applicative m => m ()

Similar to queryVars but for use in an arbitrary Applicative context. This uses unsafePerformIO which means that laziness and common sub-expression elimination can result in unexpected behavior. For this reason you should prefer queryVarsIO if a MonadIO instance is available.

valuequeryVarsIO :: MonadIO m => m ()

Similar to queryVars but specialized to an IO context. You should favor this over queryVarsM if a MonadIO instance is available.

valueexcludeVars :: [String] -> a -> a

Excludes the given variable names from appearing in the output of any breakpoints occurring in the given expression.

Internals

10 declarations

valuecaptureVars :: Map String String

Constructs a lazy Map from the names of all visible variables at the call site to a string representation of their value. Does not include any variables whose definitions contain it. Be careful not to assign multiple variables to captureVars in the same scope as this will result in an infinite recursion.

methodshowLev :: a -> String

valuefromAscList :: Ord k => [(k, v)] -> Map k v

valueprintAndWait :: String -> Map String String -> a -> a

valueprintAndWaitM :: Applicative m => String -> Map String String -> m ()

valueprintAndWaitIO :: MonadIO m => String -> Map String String -> m ()

valuerunPrompt :: String -> Map String String -> a -> a

valuerunPromptM :: Applicative m => String -> Map String String -> m ()

valuerunPromptIO :: MonadIO m => String -> Map String String -> m ()

valuegetSrcLoc :: String

Pretty prints the source code location of its call site