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


-- | Two-dimensional data tables with rendering functions
--   
--   Tabular provides a Haskell representation of two-dimensional data
--   tables, the kind that you might find in a spreadsheet or or a research
--   report. It also comes with some default rendering functions for
--   turning those tables into ASCII art, HTML or LaTeX.
--   
--   Below is an example of the kind of output this library produces. The
--   tabular package can group rows and columns, each group having one of
--   three separators (no line, single line, double line) between its
--   members.
--   
--   <pre>
--       || memtest 1 | memtest 2 ||  time test  | time test 2
--   ====++===========+===========++=============+============
--   A 1 ||       hog |  terrible ||        slow |      slower
--   A 2 ||       pig |   not bad ||        fast |     slowest
--   ----++-----------+-----------++-------------+------------
--   B 1 ||      good |     awful || intolerable |    bearable
--   B 2 ||    better | no chance ||    crawling |     amazing
--   B 3 ||       meh |   well... ||  worst ever |          ok
--   </pre>
@package tabular
@version 0.1.0.2


-- | Note: the core types and comibnators from this module are from Toxaris
--   in a #haskell conversation on 2008-08-24
module Text.Tabular
data Properties
NoLine :: Properties
SingleLine :: Properties
DoubleLine :: Properties
data Header h
Header :: h -> Header h
Group :: Properties -> [Header h] -> Header h

-- | <pre>
--   example = Table
--     (Group SingleLine
--        [ Group NoLine [Header "A 1", Header "A 2"]
--        , Group NoLine [Header "B 1", Header "B 2", Header "B 3"]
--        ])
--     (Group DoubleLine
--        [ Group SingleLine [Header "memtest 1", Header "memtest 2"]
--        , Group SingleLine [Header "time test 1", Header "time test 2"]
--        ])
--     [ ["hog", "terrible", "slow", "slower"]
--     , ["pig", "not bad",  "fast", "slowest"]
--     , ["good", "awful" ,  "intolerable", "bearable"]
--     , ["better", "no chance", "crawling", "amazing"]
--     , ["meh",  "well...", "worst ever", "ok"]
--     ]
--   </pre>
--   
--   <pre>
--   -- Text.Tabular.AsciiArt.render example id
--   --
--   --     || memtest 1 | memtest 2 ||  time test  | time test 2
--   -- ====++===========+===========++=============+============
--   -- A 1 ||       hog |  terrible ||        slow |      slower
--   -- A 2 ||       pig |   not bad ||        fast |     slowest
--   -- ----++-----------+-----------++-------------+------------
--   -- B 1 ||      good |     awful || intolerable |    bearable
--   -- B 2 ||    better | no chance ||    crawling |     amazing
--   -- B 3 ||       meh |   well... ||  worst ever |          ok
--   </pre>
data Table a
Table :: (Header String) -> (Header String) -> [[a]] -> Table a

-- | Retrieve the strings in a header
headerStrings :: Header String -> [String]

-- | <a>zipHeader</a> <tt>e</tt> <tt>ss</tt> <tt>h</tt> returns the same
--   structure as <tt>h</tt> except with all the text replaced by the
--   contents of <tt>ss</tt>.
--   
--   If <tt>ss</tt> has too many cells, the excess is ignored. If it has
--   too few cells, the missing ones (at the end) and replaced with the
--   empty contents <tt>e</tt>
zipHeader :: h -> [h] -> Header a -> Header (h, a)
flattenHeader :: Header h -> [Either Properties h]

-- | The idea is to deal with the fact that Properties (e.g. borders) are
--   not standalone cells but attributes of a cell. A border is just a CSS
--   decoration of a TD element.
--   
--   squish <tt>decorator f h</tt> applies <tt>f</tt> to every item in the
--   list represented by <tt>h</tt> (see <a>flattenHeader</a>),
--   additionally applying <tt>decorator</tt> if the item is followed by
--   some kind of boundary
--   
--   So <tt> o o o | o o o | o o </tt> gets converted into <tt> O O X O O X
--   O O </tt>
squish :: (Properties -> b -> b) -> (h -> b) -> Header h -> [b]

-- | Convenience type for just one row (or column). To be used with
--   combinators as follows:
--   
--   <pre>
--   example2 =
--     empty ^..^ col "memtest 1" [] ^|^ col "memtest 2"   []
--           ^||^ col "time test "[] ^|^ col "time test 2" []
--     +.+ row "A 1" ["hog", "terrible", "slow", "slower"]
--     +.+ row "A 2" ["pig", "not bad", "fast", "slowest"]
--     +----+
--         row "B 1" ["good", "awful", "intolerable", "bearable"]
--     +.+ row "B 2" ["better", "no chance", "crawling", "amazing"]
--     +.+ row "B 3" ["meh",  "well...", "worst ever", "ok"]
--   </pre>
data SemiTable a
SemiTable :: (Header String) -> [a] -> SemiTable a
empty :: Table a
col :: String -> [a] -> SemiTable a

-- | Column header
colH :: String -> SemiTable a
row :: String -> [a] -> SemiTable a
rowH :: String -> SemiTable a
beside :: Properties -> Table a -> SemiTable a -> Table a
below :: Properties -> Table a -> SemiTable a -> Table a
instance Functor Header

module Text.Tabular.AsciiArt

-- | for simplicity, we assume that each cell is rendered on a single line
render :: (a -> String) -> Table a -> String

-- | We stop rendering on the shortest list!
renderColumns :: [Int] -> Header String -> String
renderHLine :: [Int] -> Header String -> Properties -> [String]
renderHLine' :: [Int] -> Char -> Header String -> String
padLeft :: Int -> String -> String

module Text.Tabular.Html

-- | for simplicity, we assume that each cell is rendered on a single line
render :: (a -> String) -> Table a -> Html
vAttr :: Properties -> [HtmlAttr]
hAttr :: Properties -> [HtmlAttr]

-- | Convenience function to add a CSS string to your HTML document
css :: String -> Html

-- | You need to incorporate some CSS into your file with the classes
--   <tt>thinbottom</tt>, <tt>thinright</tt>, <tt>thickbottom</tt> and
--   <tt>thickright</tt>. See <a>css</a>
defaultCss :: String

module Text.Tabular.Latex
render :: (a -> String) -> Table a -> String
renderUsing :: [String] -> (a -> String) -> Table a -> String
hline :: String
addTableNl :: String -> String
label :: String -> String
hAttr :: Properties -> String
vAttr :: Properties -> String