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


-- | Layout text as grid or table.
--   
--   `table-layout` is a library for text-based table layout, it provides
--   several functions and types which help in this task from the ground
--   up, although using them is not necessary. It provides the following
--   layout features:
--   
--   <ul>
--   <li>Fixed-size and arbitrarily sized columns and limiting versions of
--   those</li>
--   <li>Positional alignment of content in a column</li>
--   <li>Alignment of content within a column at a character occurence</li>
--   <li>Cut marks show that content has been trimmed</li>
--   <li>Fancy tables with optional headers and user styles</li>
--   <li>Justified text layout over multiple rows</li>
--   </ul>
--   
--   A small tutorial is provided in the <a>README.md</a> file.
@package table-layout
@version 0.8.0.2

module Text.Layout.Table.Position

-- | Specifies a position relative from a beginning.
data Position orientation

-- | Horizontal orientation.
data H

-- | Vertical orientation
data V
left :: Position H
right :: Position H
center :: Position orientation
top :: Position V
bottom :: Position V


-- | This module contains primitive modifiers for lists and <a>String</a>s
--   to be filled or fitted to a specific length.
module Text.Layout.Table.Primitives.Basic

-- | Specifies how the place looks where a <a>String</a> has been cut. Note
--   that the cut mark may be cut itself, to fit into a column.
data CutMark

-- | Specify two different cut marks, one for cuts on the left and one for
--   cuts on the right.
doubleCutMark :: String -> String -> CutMark

-- | Use the cut mark on both sides by reversing it on the other.
singleCutMark :: String -> CutMark

-- | Don't show any cut mark when text is cut.
noCutMark :: CutMark
spaces :: Int -> String
concatLines :: [String] -> String
fillLeft' :: Int -> Int -> String -> String

-- | Fill on the left until the <a>String</a> has the desired length.
fillLeft :: Int -> String -> String

-- | Fill on the right until the <a>String</a> has the desired length.
fillRight :: Int -> String -> String
fillCenter' :: Int -> Int -> String -> String

-- | Fill on both sides equally until the <a>String</a> has the desired
--   length.
fillCenter :: Int -> String -> String

-- | Fits to the given length by either trimming or filling it to the
--   right.
fitRightWith :: CutMark -> Int -> String -> String

-- | Fits to the given length by either trimming or filling it to the
--   right.
fitLeftWith :: CutMark -> Int -> String -> String

-- | Fits to the given length by either trimming or filling it on both
--   sides, but when only 1 character should be trimmed it will trim left.
fitCenterWith :: CutMark -> Int -> String -> String

-- | Applies a <a>CutMark</a> to the left of a <a>String</a>, while
--   preserving the length.
applyMarkLeftWith :: CutMark -> String -> String

-- | Applies a <a>CutMark</a> to the right of a <a>String</a>, while
--   preserving the length.
applyMarkRightWith :: CutMark -> String -> String
fillStart' :: a -> Int -> Int -> [a] -> [a]
fillStart :: a -> Int -> [a] -> [a]
fillEnd :: a -> Int -> [a] -> [a]
fillBoth' :: a -> Int -> Int -> [a] -> [a]
fillBoth :: a -> Int -> [a] -> [a]
instance Data.Default.Class.Default Text.Layout.Table.Primitives.Basic.CutMark

module Text.Layout.Table.Internal

-- | Groups rows together, which should not be visually seperated from each
--   other.
newtype RowGroup
RowGroup :: [[String]] -> RowGroup
[rows] :: RowGroup -> [[String]]

-- | Group the given rows together.
rowsG :: [Row String] -> RowGroup

-- | Make a group of a single row.
rowG :: Row String -> RowGroup

-- | Specifies how a header is rendered.
data HeaderColSpec
HeaderColSpec :: (Position H) -> (Maybe CutMark) -> HeaderColSpec

-- | Smart constructor for <a>HeaderColSpec</a>. By omitting the cut mark
--   it will use the one specified in the <a>ColSpec</a> like the other
--   cells in that column.
headerColumn :: Position H -> Maybe CutMark -> HeaderColSpec

-- | An alias for lists, conceptually for values with a horizontal
--   arrangement.
type Row a = [a]

-- | An alias for lists, conceptually for values with a vertical
--   arrangement.
type Col a = [a]
instance Data.Default.Class.Default Text.Layout.Table.Internal.HeaderColSpec

module Text.Layout.Table.Primitives.LenSpec

-- | Determines how long a column will be.
data LenSpec

-- | Allows columns to use as much space as needed.
expand :: LenSpec

-- | Fixes column length to a specific width.
fixed :: Int -> LenSpec

-- | The column will expand as long as it is smaller as the given width.
expandUntil :: Int -> LenSpec

-- | The column will be at least as wide as the given width.
fixedUntil :: Int -> LenSpec

module Text.Layout.Table.Primitives.Occurence

-- | Specifies an occurence of a letter.
data OccSpec

-- | Construct an occurence specification by using a predicate.
predOccSpec :: (Char -> Bool) -> OccSpec

-- | Use an occurence specification to split a <a>String</a>.
splitAtOcc :: OccSpec -> String -> (String, String)

module Text.Layout.Table.Primitives.AlignSpec

-- | Determines whether a column will align at a specific letter.
data AlignSpec

-- | Don't align text.
noAlign :: AlignSpec

-- | Construct an <a>AlignSpec</a> by giving an occurence specification.
occSpecAlign :: OccSpec -> AlignSpec

-- | Align at the first match of a predicate.
predAlign :: (Char -> Bool) -> AlignSpec

-- | Align text at the first occurence of a given <a>Char</a>.
charAlign :: Char -> AlignSpec

module Text.Layout.Table.Primitives.Column

-- | Specifies the layout of a column.
data ColSpec
lenSpec :: ColSpec -> LenSpec
position :: ColSpec -> Position H
alignSpec :: ColSpec -> AlignSpec
cutMark :: ColSpec -> CutMark

-- | Smart constructor to specify a column.
column :: LenSpec -> Position H -> AlignSpec -> CutMark -> ColSpec
instance Data.Default.Class.Default Text.Layout.Table.Primitives.Column.ColSpec


-- | This module provides a primitive styling facility. To make your own
--   style have a look at
--   <a>https://en.wikipedia.org/wiki/Box-drawing_character</a>.
module Text.Layout.Table.Style

-- | Specifies the different letters to construct the non-content structure
--   of a table.
data TableStyle
TableStyle :: Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> Char -> TableStyle
[headerSepH] :: TableStyle -> Char
[headerSepLC] :: TableStyle -> Char
[headerSepRC] :: TableStyle -> Char
[headerSepC] :: TableStyle -> Char
[headerTopL] :: TableStyle -> Char
[headerTopR] :: TableStyle -> Char
[headerTopC] :: TableStyle -> Char
[headerTopH] :: TableStyle -> Char
[headerV] :: TableStyle -> Char
[groupV] :: TableStyle -> Char
[groupSepH] :: TableStyle -> Char
[groupSepC] :: TableStyle -> Char
[groupSepLC] :: TableStyle -> Char
[groupSepRC] :: TableStyle -> Char
[groupTopC] :: TableStyle -> Char
[groupTopL] :: TableStyle -> Char
[groupTopR] :: TableStyle -> Char
[groupTopH] :: TableStyle -> Char
[groupBottomC] :: TableStyle -> Char
[groupBottomL] :: TableStyle -> Char
[groupBottomR] :: TableStyle -> Char
[groupBottomH] :: TableStyle -> Char

-- | My usual ASCII table style.
asciiRoundS :: TableStyle

-- | Uses lines and plus for joints.
asciiS :: TableStyle

-- | Uses special unicode characters to draw clean thin boxes.
unicodeS :: TableStyle

-- | Same as <a>unicodeS</a> but uses bold headers.
unicodeBoldHeaderS :: TableStyle

-- | Same as <a>unicodeS</a> but uses round edges.
unicodeRoundS :: TableStyle

-- | Uses bold lines.
unicodeBoldS :: TableStyle

-- | Uses bold lines with exception of group seperators, which are striped
--   slim.
unicodeBoldStripedS :: TableStyle

-- | Draw every line with a double frame.
unicodeDoubleFrameS :: TableStyle


-- | This module provides functions for vertical alginment of columns.
module Text.Layout.Table.Vertical

-- | Fill all columns to the same length by aligning at the given
--   positions.
vPad :: a -> [Position V] -> [Col a] -> [Col a]

-- | Fill all columns to the same length by aligning at the given position.
vPadAll :: a -> Position V -> [Col a] -> [Col a]

-- | Merges multiple columns together and merges them to a valid grid
--   without holes. The following example clarifies this:
--   
--   <pre>
--   &gt;&gt;&gt; colsAsRowsAll top [justifyText 10 "This text will not fit on one line.", ["42", "23"]]
--   [["This  text","42"],["will   not","23"],["fit on one",""],["line.",""]]
--   </pre>
--   
--   The result is intended to be used with a grid layout function like
--   <a>layoutToCells</a>.
colsAsRowsAll :: Position V -> [Col [a]] -> [Row [a]]

-- | Works like <a>colsAsRowsAll</a>, but every position can be specified
--   on its own:
--   
--   <pre>
--   &gt;&gt;&gt; colsAsRows [top, center, bottom] [["a1"], ["b1", "b2", "b3"], ["c3"]]
--   [["a1","b1",""],["","b2",""],["","b3","c3"]]
--   </pre>
colsAsRows :: [Position V] -> [Col [a]] -> [Row [a]]


-- | Produce justified text, which is spread over multiple rows. For a
--   simple cut, <tt>chunksOf</tt> from the <tt>split</tt> package is best
--   suited.
module Text.Layout.Table.Justify

-- | Fits as many words on a line, depending on the given width. Every
--   line, but the last one, gets equally filled with spaces between the
--   words, as far as possible.
justify :: Int -> [String] -> [String]

-- | Uses <a>words</a> to split the text into words and justifies it with
--   <a>justify</a>.
--   
--   <pre>
--   &gt;&gt;&gt; justifyText 10 "This text will not fit on one line."
--   ["This  text","will   not","fit on one","line."]
--   </pre>
justifyText :: Int -> String -> [String]

-- | Splits a given number into summands of 2 different values, where the
--   first one is exactly one bigger than the second one. Splitting 40
--   spaces into 9 almost equal parts would result in:
--   
--   <pre>
--   &gt;&gt;&gt; dimorphicSummands 40 9
--   [5,5,5,5,4,4,4,4,4]
--   </pre>
dimorphicSummands :: Int -> Int -> [Int]
dimorphicSummandsBy :: (Int -> a) -> Int -> Int -> [a]

-- | Spread out summands evenly mixed as far as possible.
mixedDimorphicSummandsBy :: (Int -> a) -> Int -> Int -> [a]


-- | This module provides tools to layout text as grid or table. Besides
--   basic things like specifying column positioning, alignment on the same
--   character and length restriction it also provides advanced features
--   like justifying text and fancy tables with styling support.
module Text.Layout.Table

-- | Specifies the layout of a column.
data ColSpec

-- | Smart constructor to specify a column.
column :: LenSpec -> Position H -> AlignSpec -> CutMark -> ColSpec

-- | Numbers are positioned on the right and aligned on the floating point
--   dot.
numCol :: ColSpec

-- | Fixes the column length and positions according to the given
--   <a>Position</a>.
fixedCol :: Int -> Position H -> ColSpec

-- | Fixes the column length and positions on the left.
fixedLeftCol :: Int -> ColSpec

-- | Determines how long a column will be.
data LenSpec

-- | Allows columns to use as much space as needed.
expand :: LenSpec

-- | Fixes column length to a specific width.
fixed :: Int -> LenSpec

-- | The column will expand as long as it is smaller as the given width.
expandUntil :: Int -> LenSpec

-- | The column will be at least as wide as the given width.
fixedUntil :: Int -> LenSpec

-- | Specifies a position relative from a beginning.
data Position orientation

-- | Horizontal orientation.
data H
left :: Position H
right :: Position H
center :: Position orientation

-- | Determines whether a column will align at a specific letter.
data AlignSpec

-- | Don't align text.
noAlign :: AlignSpec

-- | Align text at the first occurence of a given <a>Char</a>.
charAlign :: Char -> AlignSpec

-- | Align at the first match of a predicate.
predAlign :: (Char -> Bool) -> AlignSpec

-- | Align all text at the first dot from the left. This is most useful for
--   floating point numbers.
dotAlign :: AlignSpec

-- | Specifies how the place looks where a <a>String</a> has been cut. Note
--   that the cut mark may be cut itself, to fit into a column.
data CutMark

-- | Don't show any cut mark when text is cut.
noCutMark :: CutMark

-- | Use the cut mark on both sides by reversing it on the other.
singleCutMark :: String -> CutMark

-- | Specify two different cut marks, one for cuts on the left and one for
--   cuts on the right.
doubleCutMark :: String -> String -> CutMark

-- | An alias for lists, conceptually for values with a horizontal
--   arrangement.
type Row a = [a]

-- | Modifies cells according to the column specification.
grid :: [ColSpec] -> [Row String] -> [Row String]

-- | Behaves like <a>grid</a> but produces lines by joining with
--   whitespace.
gridLines :: [ColSpec] -> [Row String] -> [String]

-- | Behaves like <a>gridLines</a> but produces a string by joining with
--   the newline character.
gridString :: [ColSpec] -> [Row String] -> String

-- | Applies functions to given lines in a alternating fashion. This makes
--   it easy to color lines to improve readability in a row.
altLines :: [a -> b] -> [a] -> [b]

-- | Applies functions to cells in a alternating fashion for every line,
--   every other line gets shifted by one. This is useful for
--   distinguishability of single cells in a grid arrangement.
checkeredCells :: (a -> b) -> (a -> b) -> [[a]] -> [[b]]

-- | Groups rows together, which should not be visually seperated from each
--   other.
data RowGroup

-- | Group the given rows together.
rowsG :: [Row String] -> RowGroup

-- | Make a group of a single row.
rowG :: Row String -> RowGroup

-- | Create a <a>RowGroup</a> by aligning the columns vertically. The
--   position is specified for each column.
colsG :: [Position V] -> [Col String] -> RowGroup

-- | Create a <a>RowGroup</a> by aligning the columns vertically. Each
--   column uses the same vertical positioning.
colsAllG :: Position V -> [Col String] -> RowGroup

-- | Specifies how a header is rendered.
data HeaderColSpec

-- | Smart constructor for <a>HeaderColSpec</a>. By omitting the cut mark
--   it will use the one specified in the <a>ColSpec</a> like the other
--   cells in that column.
headerColumn :: Position H -> Maybe CutMark -> HeaderColSpec

-- | Specifies a header.
data Header

-- | Specify a header column for every title.
fullH :: [HeaderColSpec] -> [String] -> Header

-- | Use titles with the default header column specification.
titlesH :: [String] -> Header

-- | Layouts a good-looking table with an optional header. Note that
--   specifying fewer layout specifications than columns or vice versa will
--   result in not showing the redundant ones.
tableLines :: [ColSpec] -> TableStyle -> Header -> [RowGroup] -> [String]

-- | Does the same as <a>tableLines</a>, but concatenates lines.
tableString :: [ColSpec] -> TableStyle -> Header -> [RowGroup] -> String

-- | Fits as many words on a line, depending on the given width. Every
--   line, but the last one, gets equally filled with spaces between the
--   words, as far as possible.
justify :: Int -> [String] -> [String]

-- | Uses <a>words</a> to split the text into words and justifies it with
--   <a>justify</a>.
--   
--   <pre>
--   &gt;&gt;&gt; justifyText 10 "This text will not fit on one line."
--   ["This  text","will   not","fit on one","line."]
--   </pre>
justifyText :: Int -> String -> [String]

-- | An alias for lists, conceptually for values with a vertical
--   arrangement.
type Col a = [a]

-- | Merges multiple columns together and merges them to a valid grid
--   without holes. The following example clarifies this:
--   
--   <pre>
--   &gt;&gt;&gt; colsAsRowsAll top [justifyText 10 "This text will not fit on one line.", ["42", "23"]]
--   [["This  text","42"],["will   not","23"],["fit on one",""],["line.",""]]
--   </pre>
--   
--   The result is intended to be used with a grid layout function like
--   <a>layoutToCells</a>.
colsAsRowsAll :: Position V -> [Col [a]] -> [Row [a]]

-- | Works like <a>colsAsRowsAll</a>, but every position can be specified
--   on its own:
--   
--   <pre>
--   &gt;&gt;&gt; colsAsRows [top, center, bottom] [["a1"], ["b1", "b2", "b3"], ["c3"]]
--   [["a1","b1",""],["","b2",""],["","b3","c3"]]
--   </pre>
colsAsRows :: [Position V] -> [Col [a]] -> [Row [a]]
top :: Position V
bottom :: Position V

-- | Vertical orientation
data V

-- | Assume the given length is greater or equal than the length of the
--   <a>String</a> passed. Pads the given <a>String</a> accordingly using
--   the position specification.
--   
--   <pre>
--   &gt;&gt;&gt; pad left 10 "foo"
--   "foo       "
--   </pre>
pad :: Position o -> Int -> String -> String

-- | If the given text is too long, the <a>String</a> will be shortened
--   according to the position specification. Adds cut marks to indicate
--   that the column has been trimmed in length, otherwise it behaves like
--   <a>pad</a>.
--   
--   <pre>
--   &gt;&gt;&gt; trimOrPad left (singleCutMark "..") 10 "A longer text."
--   "A longer.."
--   </pre>
trimOrPad :: Position o -> CutMark -> Int -> String -> String

-- | Align a <a>String</a> by first locating the position to align with and
--   then padding on both sides. If no such position is found, it will
--   align it such that it gets aligned before that position.
--   
--   <pre>
--   &gt;&gt;&gt; let { os = predOccSpec (== '.') ; ai = deriveAlignInfo os "iiii.fff" } in align os ai &lt;$&gt; ["1.5", "30", ".25"]
--   ["   1.5  ","  30    ","    .25 "]
--   </pre>
--   
--   This function assumes that the given <a>String</a> fits the
--   <a>AlignInfo</a>. Thus:
--   
--   <pre>
--   ai &lt;&gt; deriveAlignInfo s = ai
--   </pre>
align :: OccSpec -> AlignInfo -> String -> String

-- | Aligns a <a>String</a> using a fixed width, fitting it to the width by
--   either filling or cutting while respecting the alignment.
alignFixed :: Position o -> CutMark -> Int -> OccSpec -> AlignInfo -> String -> String

-- | Specifies how a column should be modified. Values of this type are
--   derived in a traversal over the input columns by using
--   <a>deriveColModInfos</a>. Finally, <a>columnModifier</a> will
--   interpret them and apply the appropriate modification function to the
--   cells of the column.
data ColModInfo

-- | Get the exact width of a <a>ColModInfo</a> after applying it with
--   <a>columnModifier</a>.
widthCMI :: ColModInfo -> Int

-- | Remove alignment from a <a>ColModInfo</a>. This is used to change
--   alignment of headers while using the combined width information.
unalignedCMI :: ColModInfo -> ColModInfo

-- | Ensures that the modification provides a minimum width but only if it
--   is not limited.
ensureWidthCMI :: Int -> Position H -> ColModInfo -> ColModInfo

-- | Ensures that the given <a>String</a> will fit into the modified
--   columns.
ensureWidthOfCMI :: String -> Position H -> ColModInfo -> ColModInfo

-- | Generates a function which modifies a given <a>String</a> according to
--   <a>Position</a>, <a>CutMark</a> and <a>ColModInfo</a>.
columnModifier :: Position H -> CutMark -> ColModInfo -> (String -> String)

-- | Specifies the length before and after an alignment position (including
--   the alignment character).
data AlignInfo

-- | The column width when using the <a>AlignInfo</a>.
widthAI :: AlignInfo -> Int

-- | Derive the <a>ColModInfo</a> by using layout specifications and the
--   actual cells of a column.
deriveColModInfos :: [(LenSpec, AlignSpec)] -> [Row String] -> [ColModInfo]

-- | Generate the <a>AlignInfo</a> of a cell by using the <a>OccSpec</a>.
deriveAlignInfo :: OccSpec -> String -> AlignInfo

-- | Specifies an occurence of a letter.
data OccSpec
instance Data.Default.Class.Default Text.Layout.Table.Header
instance GHC.Base.Semigroup Text.Layout.Table.AlignInfo
instance GHC.Base.Monoid Text.Layout.Table.AlignInfo