-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Clean up the formatting of 'show' output
--   
--   Clean up the formatting of <a>show</a> output
@package shower
@version 0.2


-- | This module defines the representation of data that the parser
--   produces and the pretty-printer consumes.
module Shower.Class

-- | A tagless final encoding for a result builder (<tt>ShowS</tt>,
--   <tt>Doc</tt>, <tt>Html</tt>, etc).
--   
--   Note that <a>showerStringLit</a> and <a>showerCharLit</a> take exact
--   uninterpreted strings to avoid losing information (e.g. <tt>"\n"</tt>
--   vs. <tt>"\10"</tt>).
class Shower a

-- | A record, <tt>{ x = 24, y = 42 }</tt> or <tt>{ "a": null, "b": 13
--   }</tt>.
showerRecord :: Shower a => [ShowerComma (a, ShowerFieldSep, a)] -> a

-- | A list, <tt>[1, 2, 3]</tt>.
showerList :: Shower a => [ShowerComma a] -> a

-- | A tuple, <tt>(1, 2, 3)</tt>.
showerTuple :: Shower a => [ShowerComma a] -> a

-- | A string literal, <tt>"hello, (world)"</tt>.
showerStringLit :: Shower a => String -> a

-- | A character literal, <tt>'('</tt>.
showerCharLit :: Shower a => String -> a

-- | Variable names, numeric literals, and so on.
showerAtom :: Shower a => String -> a

-- | Whitespace-separated elements.
showerSpace :: Shower a => [a] -> a

-- | A field separator used in records, either <tt>'='</tt> for Haskell
--   records or <tt>':'</tt> for JSON.
data ShowerFieldSep

-- | An equality sign, <tt>'='</tt>
ShowerFieldSepEquals :: ShowerFieldSep

-- | A colon, <tt>':'</tt>
ShowerFieldSepColon :: ShowerFieldSep

-- | Either a comma or an element.
--   
--   For example, the tuple section <tt>(,a,,b)</tt> is represented like
--   this:
--   
--   <pre>
--   [ ShowerCommaSep,
--     ShowerCommaElement "a",
--     ShowerCommaSep,
--     ShowerCommaSep,
--     ShowerCommaElement "b" ]
--   </pre>
data ShowerComma a

-- | A comma, <tt>','</tt>
ShowerCommaSep :: ShowerComma a

-- | An element
ShowerCommaElement :: a -> ShowerComma a


-- | A <tt>megaparsec</tt> implementation of a parser for <a>Shower</a>.
module Shower.Parser

-- | Parser for <a>Shower</a> expressions.
pShower :: Shower a => Parsec Void String a


-- | A <tt>pretty</tt> implementation of a pretty-printer for
--   <a>Shower</a>.
module Shower.Printer

-- | A <tt>pretty</tt> document, with a <a>Shower</a> instance.
newtype ShowerDoc
SD :: Doc -> ShowerDoc

-- | Render a <tt>ShowerDoc</tt> with the default style.
showerRender :: ShowerDoc -> String
instance Shower.Class.Shower Shower.Printer.ShowerDoc


-- | Pretty-print <a>Show</a> output and JSON.
module Shower

-- | A drop-in replacement for <tt>show</tt> that has nice layout. NB: does
--   not handle infinite data structures at the moment.
shower :: Show a => a -> String

-- | A drop-in replacement for <tt>print</tt> that has nice layout. Use it
--   in GHCi with <tt>-interactive-print=Shower.printer</tt>:
--   
--   <pre>
--   ghci&gt; :set -interactive-print=Shower.printer
--   ghci&gt; ([1..15], ['a'..'z'])
--   ([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
--    "abcdefghijklmnopqrstuvwxyz")
--   </pre>
--   
--   NB: does not handle infinite data structures at the moment.
printer :: Show a => a -> IO ()

-- | Parse and pretty-print <a>show</a> output or <tt>JSON</tt>.
showerString :: String -> Either String String