Safe Haskell	Safe-Inferred
Language	Haskell2010

Clerk

Contents

Coords
Cell references
Cell formatting
Templates
Columns
Sheet builder
Expressions
Cells
Produce xlsx

Description

Clerk library

Synopsis

data Coords = Coords {
- row :: Int
- col :: Int
}
newtype CellRef a = CellRef {
- unCell :: Coords
}
getCol :: CellRef a -> Int
getRow :: CellRef a -> Int
overCol :: (Int -> Int) -> Coords -> Coords
overRow :: (Int -> Int) -> Coords -> Coords
unsafeChangeCellRefType :: forall b a. CellRef a -> CellRef b
type InputIndex = Int
type FormatCell = Coords -> InputIndex -> CellData -> FormattedCell
data CellTemplate input output
type FormattedMap = Map (RowIndex, ColumnIndex) FormattedCell
type FMTransform = FormattedMap -> FormattedMap
type WSTransform = Worksheet -> Worksheet
data Transform
type FCTransform = FormattedCell -> FormattedCell
horizontalAlignment :: CellHorizontalAlignment -> FCTransform
mkColorStyle :: Show a => a -> FormatCell
newtype RowBuilder input output a = RowBuilder {
- unBuilder :: StateT Coords (Writer (Template input output)) a
}
newtype Template input output = Template [CellTemplate input output]
newtype ColumnsProperties = ColumnsProperties {
- unColumnsProperties :: ColumnsProperties
}
columnWidthCell :: forall a input output. Maybe Double -> FormatCell -> (input -> output) -> RowBuilder input output (CellRef a)
columnWidth :: ToCellData output => Double -> FormatCell -> (input -> output) -> RowBuilder input CellData (CellRef a)
columnWidth_ :: ToCellData output => Double -> FormatCell -> (input -> output) -> RowBuilder input CellData ()
column :: ToCellData output => FormatCell -> (input -> output) -> RowBuilder input CellData (CellRef a)
column_ :: ToCellData output => FormatCell -> (input -> output) -> RowBuilder input CellData ()
newtype SheetBuilder a = SheetBuilder {
- unSheetBuilder :: Writer Transform a
}
placeInputs :: ToCellData output => Coords -> [input] -> RowBuilder input output a -> SheetBuilder a
placeInputs_ :: ToCellData output => Coords -> [input] -> RowBuilder input output a -> SheetBuilder ()
placeInput :: ToCellData output => Coords -> input -> RowBuilder input output a -> SheetBuilder a
placeInput_ :: ToCellData output => Coords -> input -> RowBuilder input output a -> SheetBuilder ()
data Expr t
- = Add (Expr t) (Expr t)
- | Sub (Expr t) (Expr t)
- | Mul (Expr t) (Expr t)
- | Div (Expr t) (Expr t)
- | Power (Expr t) (Expr t)
- | Function String [Expr t]
- | Range (Expr t) (Expr t)
- | ExprCell (CellRef t)
class ToExpr v where
- toExpr :: v -> Expr t
type ArithmeticOperator a b c = (Num a, ToExpr (b a), ToExpr (c a)) => b a -> c a -> Expr a
(|+|) :: ArithmeticOperator a b c
(|-|) :: ArithmeticOperator a b c
(|*|) :: ArithmeticOperator a b c
(|/|) :: ArithmeticOperator a b c
(|:|) :: CellRef a -> CellRef b -> Expr c
(|^|) :: ArithmeticOperator a b c
(|$|) :: ToExpr a => String -> [a] -> Expr t
(+>) :: FormatCell -> FCTransform -> FormatCell
data CellData
class ToCellData a where
- toCellData :: a -> CellData
composeXlsx :: [(Text, SheetBuilder ())] -> Xlsx

Coords

data Coords Source #

Coords of a cell

Constructors

Coords
Fields row :: Int col :: Int

Instances

Instances details

Num Coords Source #
Instance details Defined in Clerk Methods (+) :: Coords -> Coords -> Coords # (-) :: Coords -> Coords -> Coords # (*) :: Coords -> Coords -> Coords # negate :: Coords -> Coords # abs :: Coords -> Coords # signum :: Coords -> Coords # fromInteger :: Integer -> Coords #
Show Coords Source #
Instance details Defined in Clerk Methods showsPrec :: Int -> Coords -> ShowS # show :: Coords -> String # showList :: [Coords] -> ShowS #
ToExpr Coords Source #
Instance details Defined in Clerk Methods toExpr :: Coords -> Expr t Source #
MonadState Coords (RowBuilder input output) Source #
Instance details Defined in Clerk Methods get :: RowBuilder input output Coords # put :: Coords -> RowBuilder input output () # state :: (Coords -> (a, Coords)) -> RowBuilder input output a #

Cell references

{- FOURMOLU_ENABLE -}

newtype CellRef a Source #

A typed reference to a cell.

The user is responsible for setting the necessary cell type.

The type prevents operations between cell references with incompatible types.

>>> str = CellRef (Coords 1 1) :: CellRef String
>>> str |+| str
No instance for (Num String) arising from a use of ‘|+|’

When necessary, the user may change the cell reference type via unsafeChangeCellRefType

>>> int = CellRef (Coords 1 1) :: CellRef Int
>>> double = CellRef (Coords 2 5) :: CellRef Double
>>> unsafeChangeCellRefType int |+| double
A1+E2

Constructors

CellRef
Fields unCell :: Coords

Instances

Instances details

Num (CellRef a) Source #
Instance details Defined in Clerk Methods (+) :: CellRef a -> CellRef a -> CellRef a # (-) :: CellRef a -> CellRef a -> CellRef a # (*) :: CellRef a -> CellRef a -> CellRef a # negate :: CellRef a -> CellRef a # abs :: CellRef a -> CellRef a # signum :: CellRef a -> CellRef a # fromInteger :: Integer -> CellRef a #
ToExpr (CellRef a) Source #
Instance details Defined in Clerk Methods toExpr :: CellRef a -> Expr t Source #

getCol :: CellRef a -> Int Source #

Get a column number from a CellRef

getRow :: CellRef a -> Int Source #

Get a row number from a CellRef

overCol :: (Int -> Int) -> Coords -> Coords Source #

Apply a function over a column of a coordinate

overRow :: (Int -> Int) -> Coords -> Coords Source #

Apply a function over a row of a coordinate

unsafeChangeCellRefType :: forall b a. CellRef a -> CellRef b Source #

Change the type of a cell reference. Use with caution!

The type variables in the forall clause are swapped for the conveniece of type applications

Cell formatting

type InputIndex = Int Source #

Index of an input

type FormatCell = Coords -> InputIndex -> CellData -> FormattedCell Source #

Format a single cell depending on its coordinates, index, and data

data CellTemplate input output Source #

Template of a cell with contents, style, column properties

type FormattedMap = Map (RowIndex, ColumnIndex) FormattedCell Source #

Map of coordinates to cell formatting

type FMTransform = FormattedMap -> FormattedMap Source #

Transform of a map that maps coordinates to cell formatting

type WSTransform = Worksheet -> Worksheet Source #

Transform of a worksheet

data Transform Source #

Combined: a transform of a map of formats and a transform of a worksheet

Instances

Instances details

Monoid Transform Source #
Instance details Defined in Clerk Methods mempty :: Transform # mappend :: Transform -> Transform -> Transform # mconcat :: [Transform] -> Transform #
Semigroup Transform Source #
Instance details Defined in Clerk Methods (<>) :: Transform -> Transform -> Transform # sconcat :: NonEmpty Transform -> Transform # stimes :: Integral b => b -> Transform -> Transform #
Default Transform Source #
Instance details Defined in Clerk Methods def :: Transform #
MonadWriter Transform SheetBuilder Source #
Instance details Defined in Clerk Methods writer :: (a, Transform) -> SheetBuilder a # tell :: Transform -> SheetBuilder () # listen :: SheetBuilder a -> SheetBuilder (a, Transform) # pass :: SheetBuilder (a, Transform -> Transform) -> SheetBuilder a #

type FCTransform = FormattedCell -> FormattedCell Source #

Transform of a formatted cell

horizontalAlignment :: CellHorizontalAlignment -> FCTransform Source #

Get a FCTransform with a given horizontal alignment in a cell

mkColorStyle :: Show a => a -> FormatCell Source #

Make a FormatCell for a single color

show on the input should translate into an ARGB color. See Color

Templates

newtype RowBuilder input output a Source #

Allows to describe how to build a template for a row

Constructors

RowBuilder
Fields unBuilder :: StateT Coords (Writer (Template input output)) a

Instances

Instances details

MonadState Coords (RowBuilder input output) Source #
Instance details Defined in Clerk Methods get :: RowBuilder input output Coords # put :: Coords -> RowBuilder input output () # state :: (Coords -> (a, Coords)) -> RowBuilder input output a #
Applicative (RowBuilder input output) Source #
Instance details Defined in Clerk Methods pure :: a -> RowBuilder input output a # (<>) :: RowBuilder input output (a -> b) -> RowBuilder input output a -> RowBuilder input output b # liftA2 :: (a -> b -> c) -> RowBuilder input output a -> RowBuilder input output b -> RowBuilder input output c # (>) :: RowBuilder input output a -> RowBuilder input output b -> RowBuilder input output b # (<*) :: RowBuilder input output a -> RowBuilder input output b -> RowBuilder input output a #
Functor (RowBuilder input output) Source #
Instance details Defined in Clerk Methods fmap :: (a -> b) -> RowBuilder input output a -> RowBuilder input output b # (<$) :: a -> RowBuilder input output b -> RowBuilder input output a #
Monad (RowBuilder input output) Source #
Instance details Defined in Clerk Methods (>>=) :: RowBuilder input output a -> (a -> RowBuilder input output b) -> RowBuilder input output b # (>>) :: RowBuilder input output a -> RowBuilder input output b -> RowBuilder input output b # return :: a -> RowBuilder input output a #
MonadWriter (Template input output) (RowBuilder input output) Source #
Instance details Defined in Clerk Methods writer :: (a, Template input output) -> RowBuilder input output a # tell :: Template input output -> RowBuilder input output () # listen :: RowBuilder input output a -> RowBuilder input output (a, Template input output) # pass :: RowBuilder input output (a, Template input output -> Template input output) -> RowBuilder input output a #

newtype Template input output Source #

Template for multiple cells

Constructors

Template [CellTemplate input output]

Instances

Instances details

Monoid (Template input output) Source #
Instance details Defined in Clerk Methods mempty :: Template input output # mappend :: Template input output -> Template input output -> Template input output # mconcat :: [Template input output] -> Template input output #
Semigroup (Template input output) Source #
Instance details Defined in Clerk Methods (<>) :: Template input output -> Template input output -> Template input output # sconcat :: NonEmpty (Template input output) -> Template input output # stimes :: Integral b => b -> Template input output -> Template input output #
MonadWriter (Template input output) (RowBuilder input output) Source #
Instance details Defined in Clerk Methods writer :: (a, Template input output) -> RowBuilder input output a # tell :: Template input output -> RowBuilder input output () # listen :: RowBuilder input output a -> RowBuilder input output (a, Template input output) # pass :: RowBuilder input output (a, Template input output -> Template input output) -> RowBuilder input output a #

Columns

newtype ColumnsProperties Source #

Properties of a column

Constructors

ColumnsProperties
Fields unColumnsProperties :: ColumnsProperties

Instances

Instances details

Default ColumnsProperties Source #
Instance details Defined in Clerk Methods def :: ColumnsProperties #

columnWidthCell :: forall a input output. Maybe Double -> FormatCell -> (input -> output) -> RowBuilder input output (CellRef a) Source #

A column with a possibly given width and cell format. Returns a cell reference

columnWidth :: ToCellData output => Double -> FormatCell -> (input -> output) -> RowBuilder input CellData (CellRef a) Source #

A column with a given width and cell format. Returns a cell reference

columnWidth_ :: ToCellData output => Double -> FormatCell -> (input -> output) -> RowBuilder input CellData () Source #

A column with a given width and cell format

column :: ToCellData output => FormatCell -> (input -> output) -> RowBuilder input CellData (CellRef a) Source #

A column with a given cell format. Returns a cell reference

column_ :: ToCellData output => FormatCell -> (input -> output) -> RowBuilder input CellData () Source #

A column with a given cell format

Sheet builder

newtype SheetBuilder a Source #

A builder to compose the results of RowBuilders

Constructors

SheetBuilder
Fields unSheetBuilder :: Writer Transform a

Instances

Instances details

Applicative SheetBuilder Source #
Instance details Defined in Clerk Methods pure :: a -> SheetBuilder a # (<>) :: SheetBuilder (a -> b) -> SheetBuilder a -> SheetBuilder b # liftA2 :: (a -> b -> c) -> SheetBuilder a -> SheetBuilder b -> SheetBuilder c # (>) :: SheetBuilder a -> SheetBuilder b -> SheetBuilder b # (<*) :: SheetBuilder a -> SheetBuilder b -> SheetBuilder a #
Functor SheetBuilder Source #
Instance details Defined in Clerk Methods fmap :: (a -> b) -> SheetBuilder a -> SheetBuilder b # (<$) :: a -> SheetBuilder b -> SheetBuilder a #
Monad SheetBuilder Source #
Instance details Defined in Clerk Methods (>>=) :: SheetBuilder a -> (a -> SheetBuilder b) -> SheetBuilder b # (>>) :: SheetBuilder a -> SheetBuilder b -> SheetBuilder b # return :: a -> SheetBuilder a #
MonadWriter Transform SheetBuilder Source #
Instance details Defined in Clerk Methods writer :: (a, Transform) -> SheetBuilder a # tell :: Transform -> SheetBuilder () # listen :: SheetBuilder a -> SheetBuilder (a, Transform) # pass :: SheetBuilder (a, Transform -> Transform) -> SheetBuilder a #

placeInputs :: ToCellData output => Coords -> [input] -> RowBuilder input output a -> SheetBuilder a Source #

Starting at given coordinates, place rows of data made from a list of inputs according to a row builder. Return the result of the row builder.

placeInputs_ :: ToCellData output => Coords -> [input] -> RowBuilder input output a -> SheetBuilder () Source #

Starting at given coordinates, place rows of data made from a list of inputs according to a row builder.

placeInput :: ToCellData output => Coords -> input -> RowBuilder input output a -> SheetBuilder a Source #

Starting at given coordinates, place a row of data made from a single input according to a row builder. Return the result of the row builder.

placeInput_ :: ToCellData output => Coords -> input -> RowBuilder input output a -> SheetBuilder () Source #

Starting at given coordinates, place a row of data made from a single input according to a row builder.

Expressions

data Expr t Source #

Expression syntax

Constructors

Add (Expr t) (Expr t)
Sub (Expr t) (Expr t)
Mul (Expr t) (Expr t)
Div (Expr t) (Expr t)
Power (Expr t) (Expr t)
Function String [Expr t]
Range (Expr t) (Expr t)
ExprCell (CellRef t)

Instances

Instances details

Show (Expr t) Source #
Instance details Defined in Clerk Methods showsPrec :: Int -> Expr t -> ShowS # show :: Expr t -> String # showList :: [Expr t] -> ShowS #
ToCellData (Expr a) Source #
Instance details Defined in Clerk Methods toCellData :: Expr a -> CellData Source #
ToExpr (Expr a) Source #
Instance details Defined in Clerk Methods toExpr :: Expr a -> Expr t Source #

class ToExpr v where Source #

Something that can be turned into an expression

Methods

toExpr :: v -> Expr t Source #

Instances

Instances details

ToExpr Coords Source #
Instance details Defined in Clerk Methods toExpr :: Coords -> Expr t Source #
ToExpr (CellRef a) Source #
Instance details Defined in Clerk Methods toExpr :: CellRef a -> Expr t Source #
ToExpr (Expr a) Source #
Instance details Defined in Clerk Methods toExpr :: Expr a -> Expr t Source #

type ArithmeticOperator a b c = (Num a, ToExpr (b a), ToExpr (c a)) => b a -> c a -> Expr a Source #

A type for arithmetic operators

(|+|) :: ArithmeticOperator a b c infixl 6 Source #

Assemble an addition expression

(|-|) :: ArithmeticOperator a b c infixl 6 Source #

Assemble a subtraction expression

(|*|) :: ArithmeticOperator a b c infixl 6 Source #

Assemble a multiplication expression

(|/|) :: ArithmeticOperator a b c infixl 7 Source #

Assemble a division expression

(|:|) :: CellRef a -> CellRef b -> Expr c infixr 5 Source #

Assemble a range expression

(|^|) :: ArithmeticOperator a b c infixr 8 Source #

Assemble a multiplication expression

(|$|) :: ToExpr a => String -> [a] -> Expr t infixr 0 Source #

Assemble a function expression

(+>) :: FormatCell -> FCTransform -> FormatCell infixl 5 Source #

Apply FCTransform to a FormatCell to get a new FormatCell

Cells

data CellData Source #

A union of what can be inside a cell

Instances

Instances details

ToCellData CellData Source #
Instance details Defined in Clerk Methods toCellData :: CellData -> CellData Source #

class ToCellData a where Source #

Something that can be turned into CellData

Methods

toCellData :: a -> CellData Source #

Instances

Instances details

ToCellData CellData Source #
Instance details Defined in Clerk Methods toCellData :: CellData -> CellData Source #
ToCellData String Source #
Instance details Defined in Clerk Methods toCellData :: String -> CellData Source #
ToCellData Bool Source #
Instance details Defined in Clerk Methods toCellData :: Bool -> CellData Source #
ToCellData Double Source #
Instance details Defined in Clerk Methods toCellData :: Double -> CellData Source #
ToCellData Int Source #
Instance details Defined in Clerk Methods toCellData :: Int -> CellData Source #
ToCellData (Expr a) Source #
Instance details Defined in Clerk Methods toCellData :: Expr a -> CellData Source #

Produce xlsx

composeXlsx :: [(Text, SheetBuilder ())] -> Xlsx Source #

Compose an xlsx from a list of sheet names and builders