Safe Haskell	None
Language	Haskell2010

Debug.DebugTrace

Contents

Debug traces
Viewing the trace
Orphan instances

Description

Module for recording and manipulating debug traces. For most users, the TemplateHaskell helpers in Debug should be sufficient.

Synopsis

data DebugTrace = DebugTrace {
- functions :: [Function]
- variables :: [Text]
- calls :: [CallData]
}
data Function = Function {
- funName :: Text
- funSource :: Text
- funArguments :: [Text]
- funResult :: Text
}
data CallData = CallData {
- callFunctionId :: Int
- callVals :: [(Text, Int)]
- callDepends :: [Int]
- callParents :: [Int]
}
debugPrintTrace :: DebugTrace -> IO ()
debugJSONTrace :: DebugTrace -> ByteString
debugViewTrace :: DebugTrace -> IO ()
debugSaveTrace :: FilePath -> DebugTrace -> IO ()
getTraceVars :: DebugTrace -> [(Function, [(Text, Text)])]

Debug traces

data DebugTrace #

A flat encoding of debugging observations.

Constructors

DebugTrace
Fields functions :: [Function] Flat list of all the functions traced variables :: [Text] Flat list of all the variable values observed calls :: [CallData] Flat list of all the function calls traced

Instances

Eq DebugTrace #
Instance details Defined in Debug.DebugTrace Methods (==) :: DebugTrace -> DebugTrace -> Bool # (/=) :: DebugTrace -> DebugTrace -> Bool #
Show DebugTrace #
Instance details Defined in Debug.DebugTrace Methods showsPrec :: Int -> DebugTrace -> ShowS # show :: DebugTrace -> String # showList :: [DebugTrace] -> ShowS #
Generic DebugTrace #
Instance details Defined in Debug.DebugTrace Associated Types type Rep DebugTrace :: * -> * # Methods from :: DebugTrace -> Rep DebugTrace x # to :: Rep DebugTrace x -> DebugTrace #
ToJSON DebugTrace #
Instance details Defined in Debug.DebugTrace Methods toJSON :: DebugTrace -> Value # toEncoding :: DebugTrace -> Encoding # toJSONList :: [DebugTrace] -> Value # toEncodingList :: [DebugTrace] -> Encoding #
FromJSON DebugTrace #
Instance details Defined in Debug.DebugTrace Methods parseJSON :: Value -> Parser DebugTrace # parseJSONList :: Value -> Parser [DebugTrace] #
NFData DebugTrace #
Instance details Defined in Debug.DebugTrace Methods rnf :: DebugTrace -> () #
type Rep DebugTrace #
Instance details Defined in Debug.DebugTrace type Rep DebugTrace = D1 (MetaData "DebugTrace" "Debug.DebugTrace" "debug-0.1.1-K3UyNTV9oWqLiWJUdJ5HEC" False) (C1 (MetaCons "DebugTrace" PrefixI True) (S1 (MetaSel (Just "functions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Function]) :: (S1 (MetaSel (Just "variables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: S1 (MetaSel (Just "calls") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CallData]))))

data Function #

Metadata about a function, used to drive the HTML view.

Constructors

Function
Fields funName :: Text Function name funSource :: Text Function source, using `n` to break lines funArguments :: [Text] Variables for the arguments to the function funResult :: Text Variable for the result of the function

Instances

Eq Function #
Instance details Defined in Debug.DebugTrace Methods (==) :: Function -> Function -> Bool # (/=) :: Function -> Function -> Bool #
Ord Function #
Instance details Defined in Debug.DebugTrace Methods compare :: Function -> Function -> Ordering # (<) :: Function -> Function -> Bool # (<=) :: Function -> Function -> Bool # (>) :: Function -> Function -> Bool # (>=) :: Function -> Function -> Bool # max :: Function -> Function -> Function # min :: Function -> Function -> Function #
Show Function #
Instance details Defined in Debug.DebugTrace Methods showsPrec :: Int -> Function -> ShowS # show :: Function -> String # showList :: [Function] -> ShowS #
Generic Function #
Instance details Defined in Debug.DebugTrace Associated Types type Rep Function :: * -> * # Methods from :: Function -> Rep Function x # to :: Rep Function x -> Function #
Hashable Function #
Instance details Defined in Debug.DebugTrace Methods hashWithSalt :: Int -> Function -> Int # hash :: Function -> Int #
ToJSON Function #
Instance details Defined in Debug.DebugTrace Methods toJSON :: Function -> Value # toEncoding :: Function -> Encoding # toJSONList :: [Function] -> Value # toEncodingList :: [Function] -> Encoding #
FromJSON Function #
Instance details Defined in Debug.DebugTrace Methods parseJSON :: Value -> Parser Function # parseJSONList :: Value -> Parser [Function] #
NFData Function #
Instance details Defined in Debug.DebugTrace Methods rnf :: Function -> () #
type Rep Function #
Instance details Defined in Debug.DebugTrace type Rep Function = D1 (MetaData "Function" "Debug.DebugTrace" "debug-0.1.1-K3UyNTV9oWqLiWJUdJ5HEC" False) (C1 (MetaCons "Function" PrefixI True) ((S1 (MetaSel (Just "funName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "funSource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :: (S1 (MetaSel (Just "funArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :*: S1 (MetaSel (Just "funResult") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data CallData #

A flat encoding of an observed call.

Constructors

CallData
Fields callFunctionId :: Int An index into the `functions` table callVals :: [(Text, Int)] The value name tupled with an index into the `variables` table callDepends :: [Int] Indexes into the `calls` table callParents :: [Int] Indexes into the `calls` table

Instances

Eq CallData #
Instance details Defined in Debug.DebugTrace Methods (==) :: CallData -> CallData -> Bool # (/=) :: CallData -> CallData -> Bool #
Show CallData #
Instance details Defined in Debug.DebugTrace Methods showsPrec :: Int -> CallData -> ShowS # show :: CallData -> String # showList :: [CallData] -> ShowS #
Generic CallData #
Instance details Defined in Debug.DebugTrace Associated Types type Rep CallData :: * -> * # Methods from :: CallData -> Rep CallData x # to :: Rep CallData x -> CallData #
ToJSON CallData #
Instance details Defined in Debug.DebugTrace Methods toJSON :: CallData -> Value # toEncoding :: CallData -> Encoding # toJSONList :: [CallData] -> Value # toEncodingList :: [CallData] -> Encoding #
FromJSON CallData #
Instance details Defined in Debug.DebugTrace Methods parseJSON :: Value -> Parser CallData # parseJSONList :: Value -> Parser [CallData] #
NFData CallData #
Instance details Defined in Debug.DebugTrace Methods rnf :: CallData -> () #
type Rep CallData #
Instance details Defined in Debug.DebugTrace type Rep CallData = D1 (MetaData "CallData" "Debug.DebugTrace" "debug-0.1.1-K3UyNTV9oWqLiWJUdJ5HEC" False) (C1 (MetaCons "CallData" PrefixI True) ((S1 (MetaSel (Just "callFunctionId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "callVals") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Text, Int)])) :: (S1 (MetaSel (Just "callDepends") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]) :*: S1 (MetaSel (Just "callParents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]))))

Viewing the trace

debugPrintTrace :: DebugTrace -> IO () #

Print information about the observed function calls to stdout, in a human-readable format.

debugJSONTrace :: DebugTrace -> ByteString #

Obtain information about observed functions in JSON format. The JSON format is not considered a stable part of the interface, more presented as a back door to allow exploration of alternative views.

debugViewTrace :: DebugTrace -> IO () #

Open a web browser showing information about observed functions.

debugSaveTrace :: FilePath -> DebugTrace -> IO () #

Save information about observed functions to the specified file, in HTML format.

getTraceVars :: DebugTrace -> [(Function, [(Text, Text)])] #

Along with the function metatdata, get a list of the variable names and string values from the trace

Orphan instances

Show a #	An orphan instance of `Show` that maps anything without a `Show` instance to `?`. Suitable for use only when debugging.
Instance details Methods showsPrec :: Int -> a -> ShowS # show :: a -> String # showList :: [a] -> ShowS #