The present package

[Tags:bsd3, library]

Make presentations for data types.


[Skip to Readme]

Properties

Versions 0.0.0, 1.0, 1.1, 2.0, 2.1, 2.2, 4.0.0, 4.0.1, 4.0.2 (info)
Dependencies base (==4.*), template-haskell [details]
License BSD3
Copyright 2016 Chris Done
Author Chris Done
Maintainer chrisdone@gmail.com
Stability Unknown
Category Development
Home page https://github.com/chrisdone/present
Uploaded Fri Mar 25 22:28:10 UTC 2016 by ChrisDone
Distributions NixOS:4.0.2
Downloads 2259 total (41 in the last 30 days)
Votes
0 []
Status Docs pending
Build status unknown [no reports yet]

Modules

  • Present

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for present

Readme for present-4.0.2

present

Make presentations for data types.

Install

Requires: GHC 7.10.3

Install globally into your GHC's global database (via stack) with:

$ sh install-to-global-db.sh

To remove it later:

$ sh remove-from-global-db.sh

To be added: install via stack install present, but it needs to be added to an LTS/nightly version first.

Customizing GHCi

Add to the following to your ~/.ghci:

:seti -XTemplateHaskell
:def presentDebug \e -> return ("let it = " ++ e ++ "\n$(Present.presentIt)")
:def presentQualified \e -> return ("let it = " ++ e ++ "\nPrelude.putStrLn (Present.toShow True $(Present.presentIt))")
:def present \e -> return ("let it = " ++ e ++ "\nPrelude.putStrLn (Present.toShow False $(Present.presentIt))")
:set -package present

Usage

bash-3.2$ stack exec ghci
GHCi, version 7.10.3: http://www.haskell.org/ghc/  :? for help
package flags have changed, resetting and loading new packages...
λ> :present "hi"
"hi"

λ> :present 123
123

λ> :present (5.2,"hi",1,'a')
(5.2,"hi",1,'a')

λ> data X a = X a Int

λ> :present X 5 1
X 5 1

λ> :present S88.pack "hi"
PS (ForeignPtr GHC.Prim.Addr# (PlainPtr GHC.Prim.MutableByteArray#)) 0 2

λ> :present print
<a_0 -> GHC.Types.IO ()>

λ> :present print ()
IO (<GHC.Prim.State# GHC.Prim.RealWorld -> (GHC.Prim.State# GHC.Prim.RealWorld, a_0)>)

λ> :present undefined
_ :: t_0

λ> :present id
<a_0 -> a_0>

λ> :present [undefined]
[_ :: t_0]

Extension

You can write your own instances like this:

λ> data X = X Int
λ> :present X 5
X 5
λ> instance Present0 X where present0 = ("X",\(X x) -> IntegerPresentation "X" (show x))
λ> :present X 5
5