MyNixOS website logo
Description

Debug print formatting library.

Print debugging with stack trace for Haskell (formatted for ease of use). See screenshot: http://i.imgur.com/KCXYHNk.png

HaskellPrintDebugger

Prints lines with IDE friendly stack traces in Haskell (now with IDE friendly fatal assertions).


Example:

debugTraceIO "foobar"

foobar in thread "1" :

    at Main.call(Main.hs:41)

See screenshot: http://i.imgur.com/KCXYHNk.png


Dependencies:

  • None (except for "split" package in .cabal). Automatically imports on "cabal install print-debugger".

Instructions:

  1. Add the file "StackTraceDebug.hs" to your Haskell project.
  2. Add "import StackTraceDebug" if you want to call the function
  3. Call "debugTraceIO" with any String argument.
  4. When you are done, remove or comment out all calls to debugTraceIO.
  5. Optionally, set value "debugMode" to "False" in "StackTraceDebug.hs" to mute all calls to "debugTraceIO" and disable all fatal assertions.

Benefits:

  • Does not require to be compiled with "-prof"
  • Easier to locate your print statements (and assertions)- Location of print statement (and assertions) can be highlighted in an IDE
  • Easy to turn print statemments (and assertions) on/off without having to manually uncomment each one.
  • CC0 (Free to use, share, or modify, even commercially)

Requirements:

  • GHC 7.10.1 (or greater)
  • "-XImplicitParams" compiler option
  • "split" package or addition of ", split" to "build-depends" line in ".cabal" file

Configuration:

Sample ".cabal" file:

name: HaskellProject1

version: 1.0

Build-Type: Simple

cabal-version: >= 1.2

executable HaskellProject1

main-is: Main.hs

hs-source-dirs: src

build-depends: base, split

Sample compilation:

    $> ghc StackTraceDebug.hs -Wall -Werror -XImplicitParams


Know bugs:

http://stackoverflow.com/questions/35354153/haskell-cannot-import-ghc-srcloc

^ Doesn't build correctly on Caball Ubuntu 14.04 with old (ubuntu LTS repo) version of GHC.

(but compiles fine on Windows with "ghc StackTraceDebug.hs -Wall -Werror -XImplicitParams")

To report or pinpoint bugs, email [email protected]


More info:

http://hackage.haskell.org/package/print-debugger

https://www.reddit.com/r/haskell/comments/45jfk8/my_first_package_enhanced_poor_mans_debugging/

https://github.com/JohnReedLOL/HaskellPrintDebugger/edit/master/README.md.

Metadata

Version

1.1.9

License

publicDomain

Platforms (75)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-darwin
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-darwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows