mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-20 02:37:12 +03:00
extract debug helpers into a module
This commit is contained in:
Simon Michael
parent
6f574d1af4
commit
69636f70fb
@ -1,4 +1,3 @@
|
||||
{-# LANGUAGE CPP #-}
|
||||
{-|
|
||||
|
||||
Standard imports and utilities which are useful everywhere, or needed low
|
||||
@ -14,24 +13,21 @@ module Hledger.Utils (---- provide these frequently used modules - or not, for c
|
||||
-- module Data.Time.Clock,
|
||||
-- module Data.Time.LocalTime,
|
||||
-- module Data.Tree,
|
||||
-- module Debug.Trace,
|
||||
-- module Text.RegexPR,
|
||||
-- module Test.HUnit,
|
||||
-- module Text.Printf,
|
||||
---- all of this one:
|
||||
module Hledger.Utils,
|
||||
module Hledger.Utils.Debug,
|
||||
module Hledger.Utils.Regex,
|
||||
Debug.Trace.trace,
|
||||
-- Debug.Trace.trace,
|
||||
-- module Data.PPrint,
|
||||
-- module Hledger.Utils.UTF8IOCompat
|
||||
SystemString,fromSystemString,toSystemString,error',userError',
|
||||
#if __GLASGOW_HASKELL__ >= 704
|
||||
ppShow
|
||||
#endif
|
||||
-- the rest need to be done in each module I think
|
||||
)
|
||||
where
|
||||
import Control.Monad (liftM, when)
|
||||
import Control.Monad (liftM)
|
||||
import Control.Monad.Error (MonadIO)
|
||||
import Control.Monad.IO.Class (liftIO)
|
||||
import Data.Char
|
||||
@ -42,32 +38,20 @@ import qualified Data.Map as M
|
||||
import Data.Time.Clock
|
||||
import Data.Time.LocalTime
|
||||
import Data.Tree
|
||||
import Debug.Trace
|
||||
import Safe (readDef)
|
||||
import System.Directory (getHomeDirectory)
|
||||
import System.Environment (getArgs)
|
||||
import System.Exit
|
||||
import System.FilePath((</>), isRelative)
|
||||
import System.IO
|
||||
import System.IO.Unsafe (unsafePerformIO)
|
||||
import Test.HUnit
|
||||
import Text.ParserCombinators.Parsec
|
||||
import Text.Printf
|
||||
-- import qualified Data.Map as Map
|
||||
|
||||
import Hledger.Utils.Debug
|
||||
import Hledger.Utils.Regex
|
||||
-- import Prelude hiding (readFile,writeFile,appendFile,getContents,putStr,putStrLn)
|
||||
-- import Hledger.Utils.UTF8IOCompat (readFile,writeFile,appendFile,getContents,putStr,putStrLn)
|
||||
import Hledger.Utils.UTF8IOCompat (SystemString,fromSystemString,toSystemString,error',userError')
|
||||
|
||||
#if __GLASGOW_HASKELL__ >= 704
|
||||
import Text.Show.Pretty (ppShow)
|
||||
#else
|
||||
-- the required pretty-show version requires GHC >= 7.4
|
||||
ppShow :: Show a => a -> String
|
||||
ppShow = show
|
||||
#endif
|
||||
|
||||
-- strings
|
||||
|
||||
lowercase = map toLower
|
||||
@ -345,181 +329,6 @@ treeFromPaths :: (Ord a) => [[a]] -> FastTree a
|
||||
treeFromPaths = foldl' mergeTrees emptyTree . map treeFromPath
|
||||
|
||||
|
||||
-- debugging
|
||||
|
||||
-- more:
|
||||
-- http://hackage.haskell.org/packages/archive/TraceUtils/0.1.0.2/doc/html/Debug-TraceUtils.html
|
||||
-- http://hackage.haskell.org/packages/archive/trace-call/0.1/doc/html/Debug-TraceCall.html
|
||||
-- http://hackage.haskell.org/packages/archive/htrace/0.1/doc/html/Debug-HTrace.html
|
||||
-- http://hackage.haskell.org/packages/archive/traced/2009.7.20/doc/html/Debug-Traced.html
|
||||
|
||||
-- | Trace (print on stdout at runtime) a showable value.
|
||||
-- (for easily tracing in the middle of a complex expression)
|
||||
strace :: Show a => a -> a
|
||||
strace a = trace (show a) a
|
||||
|
||||
-- | Labelled trace - like strace, with a label prepended.
|
||||
ltrace :: Show a => String -> a -> a
|
||||
ltrace l a = trace (l ++ ": " ++ show a) a
|
||||
|
||||
-- | Monadic trace - like strace, but works as a standalone line in a monad.
|
||||
mtrace :: (Monad m, Show a) => a -> m a
|
||||
mtrace a = strace a `seq` return a
|
||||
|
||||
-- | Custom trace - like strace, with a custom show function.
|
||||
traceWith :: (a -> String) -> a -> a
|
||||
traceWith f e = trace (f e) e
|
||||
|
||||
-- | Parsec trace - show the current parsec position and next input,
|
||||
-- and the provided label if it's non-null.
|
||||
ptrace :: String -> GenParser Char st ()
|
||||
ptrace msg = do
|
||||
pos <- getPosition
|
||||
next <- take peeklength `fmap` getInput
|
||||
let (l,c) = (sourceLine pos, sourceColumn pos)
|
||||
s = printf "at line %2d col %2d: %s" l c (show next) :: String
|
||||
s' = printf ("%-"++show (peeklength+30)++"s") s ++ " " ++ msg
|
||||
trace s' $ return ()
|
||||
where
|
||||
peeklength = 30
|
||||
|
||||
-- | Global debug level, which controls the verbosity of debug output
|
||||
-- on the console. The default is 0 meaning no debug output. The
|
||||
-- @--debug@ command line flag sets it to 1, or @--debug=N@ sets it to
|
||||
-- a higher value (note: not @--debug N@ for some reason). This uses
|
||||
-- unsafePerformIO and can be accessed from anywhere and before normal
|
||||
-- command-line processing. After command-line processing, it is also
|
||||
-- available as the @debug_@ field of 'Hledger.Cli.Options.CliOpts'.
|
||||
-- {-# OPTIONS_GHC -fno-cse #-}
|
||||
-- {-# NOINLINE debugLevel #-}
|
||||
debugLevel :: Int
|
||||
debugLevel = case snd $ break (=="--debug") args of
|
||||
"--debug":[] -> 1
|
||||
"--debug":n:_ -> readDef 1 n
|
||||
_ ->
|
||||
case take 1 $ filter ("--debug" `isPrefixOf`) args of
|
||||
['-':'-':'d':'e':'b':'u':'g':'=':v] -> readDef 1 v
|
||||
_ -> 0
|
||||
|
||||
where
|
||||
args = unsafePerformIO getArgs
|
||||
|
||||
-- | Print a message and a showable value to the console if the global
|
||||
-- debug level is non-zero. Uses unsafePerformIO.
|
||||
dbg :: Show a => String -> a -> a
|
||||
dbg = dbg1
|
||||
|
||||
-- always prints
|
||||
dbg0 :: Show a => String -> a -> a
|
||||
dbg0 = dbgAt 0
|
||||
|
||||
dbg1 :: Show a => String -> a -> a
|
||||
dbg1 = dbgAt 1
|
||||
|
||||
dbg2 :: Show a => String -> a -> a
|
||||
dbg2 = dbgAt 2
|
||||
|
||||
dbg3 :: Show a => String -> a -> a
|
||||
dbg3 = dbgAt 3
|
||||
|
||||
dbg4 :: Show a => String -> a -> a
|
||||
dbg4 = dbgAt 4
|
||||
|
||||
dbg5 :: Show a => String -> a -> a
|
||||
dbg5 = dbgAt 5
|
||||
|
||||
dbg6 :: Show a => String -> a -> a
|
||||
dbg6 = dbgAt 6
|
||||
|
||||
dbg7 :: Show a => String -> a -> a
|
||||
dbg7 = dbgAt 7
|
||||
|
||||
dbg8 :: Show a => String -> a -> a
|
||||
dbg8 = dbgAt 8
|
||||
|
||||
dbg9 :: Show a => String -> a -> a
|
||||
dbg9 = dbgAt 9
|
||||
|
||||
-- | Print a message and a showable value to the console if the global
|
||||
-- debug level is at or above the specified level. Uses unsafePerformIO.
|
||||
dbgAt :: Show a => Int -> String -> a -> a
|
||||
dbgAt lvl = dbgppshow lvl
|
||||
|
||||
-- Could not deduce (a ~ ())
|
||||
-- from the context (Show a)
|
||||
-- bound by the type signature for
|
||||
-- dbgM :: Show a => String -> a -> IO ()
|
||||
-- at hledger/Hledger/Cli/Main.hs:200:13-42
|
||||
-- ‘a’ is a rigid type variable bound by
|
||||
-- the type signature for dbgM :: Show a => String -> a -> IO ()
|
||||
-- at hledger/Hledger/Cli/Main.hs:200:13
|
||||
-- Expected type: String -> a -> IO ()
|
||||
-- Actual type: String -> a -> IO a
|
||||
-- dbgAtM :: (Monad m, Show a) => Int -> String -> a -> m a
|
||||
-- dbgAtM lvl lbl x = dbgAt lvl lbl x `seq` return x
|
||||
-- XXX temporary:
|
||||
dbgAtM :: Show a => Int -> String -> a -> IO ()
|
||||
dbgAtM = dbgAtIO
|
||||
|
||||
dbgAtIO :: Show a => Int -> String -> a -> IO ()
|
||||
dbgAtIO lvl lbl x = dbgAt lvl lbl x `seq` return ()
|
||||
|
||||
-- | print this string to the console before evaluating the expression,
|
||||
-- if the global debug level is non-zero. Uses unsafePerformIO.
|
||||
dbgtrace :: String -> a -> a
|
||||
dbgtrace
|
||||
| debugLevel > 0 = trace
|
||||
| otherwise = flip const
|
||||
|
||||
-- | Print a showable value to the console, with a message, if the
|
||||
-- debug level is at or above the specified level (uses
|
||||
-- unsafePerformIO).
|
||||
-- Values are displayed with show, all on one line, which is hard to read.
|
||||
dbgshow :: Show a => Int -> String -> a -> a
|
||||
dbgshow level
|
||||
| debugLevel >= level = ltrace
|
||||
| otherwise = flip const
|
||||
|
||||
-- | Print a showable value to the console, with a message, if the
|
||||
-- debug level is at or above the specified level (uses
|
||||
-- unsafePerformIO).
|
||||
-- Values are displayed with ppShow, each field/constructor on its own line.
|
||||
dbgppshow :: Show a => Int -> String -> a -> a
|
||||
dbgppshow level
|
||||
| debugLevel < level = flip const
|
||||
| otherwise = \s a -> let p = ppShow a
|
||||
ls = lines p
|
||||
nlorspace | length ls > 1 = "\n"
|
||||
| otherwise = " " ++ take (10 - length s) (repeat ' ')
|
||||
ls' | length ls > 1 = map (" "++) ls
|
||||
| otherwise = ls
|
||||
in trace (s++":"++nlorspace++intercalate "\n" ls') a
|
||||
|
||||
-- -- | Print a showable value to the console, with a message, if the
|
||||
-- -- debug level is at or above the specified level (uses
|
||||
-- -- unsafePerformIO).
|
||||
-- -- Values are displayed with pprint. Field names are not shown, but the
|
||||
-- -- output is compact with smart line wrapping, long data elided,
|
||||
-- -- and slow calculations timed out.
|
||||
-- dbgpprint :: Data a => Int -> String -> a -> a
|
||||
-- dbgpprint level msg a
|
||||
-- | debugLevel >= level = unsafePerformIO $ do
|
||||
-- pprint a >>= putStrLn . ((msg++": \n") ++) . show
|
||||
-- return a
|
||||
-- | otherwise = a
|
||||
|
||||
|
||||
-- | Like dbg, then exit the program. Uses unsafePerformIO.
|
||||
dbgExit :: Show a => String -> a -> a
|
||||
dbgExit msg = const (unsafePerformIO exitFailure) . dbg msg
|
||||
|
||||
-- | Print a message and parsec debug info (parse position and next
|
||||
-- input) to the console when the debug level is at or above
|
||||
-- this level. Uses unsafePerformIO.
|
||||
-- pdbgAt :: GenParser m => Float -> String -> m ()
|
||||
pdbg level msg = when (level <= debugLevel) $ ptrace msg
|
||||
|
||||
|
||||
-- parsing
|
||||
|
||||
-- | Backtracking choice, use this when alternatives share a prefix.
|
||||
|
||||
204
hledger-lib/Hledger/Utils/Debug.hs
Normal file
204
hledger-lib/Hledger/Utils/Debug.hs
Normal file
@ -0,0 +1,204 @@
|
||||
{-# LANGUAGE CPP #-}
|
||||
-- | Debugging helpers
|
||||
|
||||
-- more:
|
||||
-- http://hackage.haskell.org/packages/archive/TraceUtils/0.1.0.2/doc/html/Debug-TraceUtils.html
|
||||
-- http://hackage.haskell.org/packages/archive/trace-call/0.1/doc/html/Debug-TraceCall.html
|
||||
-- http://hackage.haskell.org/packages/archive/htrace/0.1/doc/html/Debug-HTrace.html
|
||||
-- http://hackage.haskell.org/packages/archive/traced/2009.7.20/doc/html/Debug-Traced.html
|
||||
|
||||
module Hledger.Utils.Debug (
|
||||
module Hledger.Utils.Debug
|
||||
,module Debug.Trace
|
||||
#if __GLASGOW_HASKELL__ >= 704
|
||||
,ppShow
|
||||
#endif
|
||||
)
|
||||
where
|
||||
|
||||
import Control.Monad (when)
|
||||
import Data.List
|
||||
import Debug.Trace
|
||||
import Safe (readDef)
|
||||
import System.Environment (getArgs)
|
||||
import System.Exit
|
||||
import System.IO.Unsafe (unsafePerformIO)
|
||||
import Text.ParserCombinators.Parsec
|
||||
import Text.Printf
|
||||
|
||||
#if __GLASGOW_HASKELL__ >= 704
|
||||
import Text.Show.Pretty (ppShow)
|
||||
#else
|
||||
-- the required pretty-show version requires GHC >= 7.4
|
||||
ppShow :: Show a => a -> String
|
||||
ppShow = show
|
||||
#endif
|
||||
|
||||
|
||||
-- | Trace (print on stdout at runtime) a showable value.
|
||||
-- (for easily tracing in the middle of a complex expression)
|
||||
strace :: Show a => a -> a
|
||||
strace a = trace (show a) a
|
||||
|
||||
-- | Labelled trace - like strace, with a label prepended.
|
||||
ltrace :: Show a => String -> a -> a
|
||||
ltrace l a = trace (l ++ ": " ++ show a) a
|
||||
|
||||
-- | Monadic trace - like strace, but works as a standalone line in a monad.
|
||||
mtrace :: (Monad m, Show a) => a -> m a
|
||||
mtrace a = strace a `seq` return a
|
||||
|
||||
-- | Custom trace - like strace, with a custom show function.
|
||||
traceWith :: (a -> String) -> a -> a
|
||||
traceWith f e = trace (f e) e
|
||||
|
||||
-- | Parsec trace - show the current parsec position and next input,
|
||||
-- and the provided label if it's non-null.
|
||||
ptrace :: String -> GenParser Char st ()
|
||||
ptrace msg = do
|
||||
pos <- getPosition
|
||||
next <- take peeklength `fmap` getInput
|
||||
let (l,c) = (sourceLine pos, sourceColumn pos)
|
||||
s = printf "at line %2d col %2d: %s" l c (show next) :: String
|
||||
s' = printf ("%-"++show (peeklength+30)++"s") s ++ " " ++ msg
|
||||
trace s' $ return ()
|
||||
where
|
||||
peeklength = 30
|
||||
|
||||
-- | Global debug level, which controls the verbosity of debug output
|
||||
-- on the console. The default is 0 meaning no debug output. The
|
||||
-- @--debug@ command line flag sets it to 1, or @--debug=N@ sets it to
|
||||
-- a higher value (note: not @--debug N@ for some reason). This uses
|
||||
-- unsafePerformIO and can be accessed from anywhere and before normal
|
||||
-- command-line processing. After command-line processing, it is also
|
||||
-- available as the @debug_@ field of 'Hledger.Cli.Options.CliOpts'.
|
||||
-- {-# OPTIONS_GHC -fno-cse #-}
|
||||
-- {-# NOINLINE debugLevel #-}
|
||||
debugLevel :: Int
|
||||
debugLevel = case snd $ break (=="--debug") args of
|
||||
"--debug":[] -> 1
|
||||
"--debug":n:_ -> readDef 1 n
|
||||
_ ->
|
||||
case take 1 $ filter ("--debug" `isPrefixOf`) args of
|
||||
['-':'-':'d':'e':'b':'u':'g':'=':v] -> readDef 1 v
|
||||
_ -> 0
|
||||
|
||||
where
|
||||
args = unsafePerformIO getArgs
|
||||
|
||||
-- | Print a message and a showable value to the console if the global
|
||||
-- debug level is non-zero. Uses unsafePerformIO.
|
||||
dbg :: Show a => String -> a -> a
|
||||
dbg = dbg1
|
||||
|
||||
-- always prints
|
||||
dbg0 :: Show a => String -> a -> a
|
||||
dbg0 = dbgAt 0
|
||||
|
||||
dbg1 :: Show a => String -> a -> a
|
||||
dbg1 = dbgAt 1
|
||||
|
||||
dbg2 :: Show a => String -> a -> a
|
||||
dbg2 = dbgAt 2
|
||||
|
||||
dbg3 :: Show a => String -> a -> a
|
||||
dbg3 = dbgAt 3
|
||||
|
||||
dbg4 :: Show a => String -> a -> a
|
||||
dbg4 = dbgAt 4
|
||||
|
||||
dbg5 :: Show a => String -> a -> a
|
||||
dbg5 = dbgAt 5
|
||||
|
||||
dbg6 :: Show a => String -> a -> a
|
||||
dbg6 = dbgAt 6
|
||||
|
||||
dbg7 :: Show a => String -> a -> a
|
||||
dbg7 = dbgAt 7
|
||||
|
||||
dbg8 :: Show a => String -> a -> a
|
||||
dbg8 = dbgAt 8
|
||||
|
||||
dbg9 :: Show a => String -> a -> a
|
||||
dbg9 = dbgAt 9
|
||||
|
||||
-- | Print a message and a showable value to the console if the global
|
||||
-- debug level is at or above the specified level. Uses unsafePerformIO.
|
||||
dbgAt :: Show a => Int -> String -> a -> a
|
||||
dbgAt lvl = dbgppshow lvl
|
||||
|
||||
-- Could not deduce (a ~ ())
|
||||
-- from the context (Show a)
|
||||
-- bound by the type signature for
|
||||
-- dbgM :: Show a => String -> a -> IO ()
|
||||
-- at hledger/Hledger/Cli/Main.hs:200:13-42
|
||||
-- ‘a’ is a rigid type variable bound by
|
||||
-- the type signature for dbgM :: Show a => String -> a -> IO ()
|
||||
-- at hledger/Hledger/Cli/Main.hs:200:13
|
||||
-- Expected type: String -> a -> IO ()
|
||||
-- Actual type: String -> a -> IO a
|
||||
-- dbgAtM :: (Monad m, Show a) => Int -> String -> a -> m a
|
||||
-- dbgAtM lvl lbl x = dbgAt lvl lbl x `seq` return x
|
||||
-- XXX temporary:
|
||||
dbgAtM :: Show a => Int -> String -> a -> IO ()
|
||||
dbgAtM = dbgAtIO
|
||||
|
||||
dbgAtIO :: Show a => Int -> String -> a -> IO ()
|
||||
dbgAtIO lvl lbl x = dbgAt lvl lbl x `seq` return ()
|
||||
|
||||
-- | print this string to the console before evaluating the expression,
|
||||
-- if the global debug level is non-zero. Uses unsafePerformIO.
|
||||
dbgtrace :: String -> a -> a
|
||||
dbgtrace
|
||||
| debugLevel > 0 = trace
|
||||
| otherwise = flip const
|
||||
|
||||
-- | Print a showable value to the console, with a message, if the
|
||||
-- debug level is at or above the specified level (uses
|
||||
-- unsafePerformIO).
|
||||
-- Values are displayed with show, all on one line, which is hard to read.
|
||||
dbgshow :: Show a => Int -> String -> a -> a
|
||||
dbgshow level
|
||||
| debugLevel >= level = ltrace
|
||||
| otherwise = flip const
|
||||
|
||||
-- | Print a showable value to the console, with a message, if the
|
||||
-- debug level is at or above the specified level (uses
|
||||
-- unsafePerformIO).
|
||||
-- Values are displayed with ppShow, each field/constructor on its own line.
|
||||
dbgppshow :: Show a => Int -> String -> a -> a
|
||||
dbgppshow level
|
||||
| debugLevel < level = flip const
|
||||
| otherwise = \s a -> let p = ppShow a
|
||||
ls = lines p
|
||||
nlorspace | length ls > 1 = "\n"
|
||||
| otherwise = " " ++ take (10 - length s) (repeat ' ')
|
||||
ls' | length ls > 1 = map (" "++) ls
|
||||
| otherwise = ls
|
||||
in trace (s++":"++nlorspace++intercalate "\n" ls') a
|
||||
|
||||
-- -- | Print a showable value to the console, with a message, if the
|
||||
-- -- debug level is at or above the specified level (uses
|
||||
-- -- unsafePerformIO).
|
||||
-- -- Values are displayed with pprint. Field names are not shown, but the
|
||||
-- -- output is compact with smart line wrapping, long data elided,
|
||||
-- -- and slow calculations timed out.
|
||||
-- dbgpprint :: Data a => Int -> String -> a -> a
|
||||
-- dbgpprint level msg a
|
||||
-- | debugLevel >= level = unsafePerformIO $ do
|
||||
-- pprint a >>= putStrLn . ((msg++": \n") ++) . show
|
||||
-- return a
|
||||
-- | otherwise = a
|
||||
|
||||
|
||||
-- | Like dbg, then exit the program. Uses unsafePerformIO.
|
||||
dbgExit :: Show a => String -> a -> a
|
||||
dbgExit msg = const (unsafePerformIO exitFailure) . dbg msg
|
||||
|
||||
-- | Print a message and parsec debug info (parse position and next
|
||||
-- input) to the console when the debug level is at or above
|
||||
-- this level. Uses unsafePerformIO.
|
||||
-- pdbgAt :: GenParser m => Float -> String -> m ()
|
||||
pdbg level msg = when (level <= debugLevel) $ ptrace msg
|
||||
|
||||
|
||||
@ -77,6 +77,7 @@ library
|
||||
Hledger.Reports.PostingsReport
|
||||
Hledger.Reports.TransactionsReports
|
||||
Hledger.Utils
|
||||
Hledger.Utils.Debug
|
||||
Hledger.Utils.Regex
|
||||
Hledger.Utils.UTF8IOCompat
|
||||
build-depends:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user