Text.LaTeX.Base.Class

Definition of the LaTeXC class, used to combine the classic applicative and the latter monadic interfaces of HaTeX 3. The user can define new instances as well, adding flexibility to the way HaTeX is used.

Documentation

class (Monoid l, IsString l) => LaTeXC l where

This is the class of LaTeX code generators. It has Monoid and IsString as superclasses.

Methods

liftListL :: ([LaTeX] -> LaTeX) -> [l] -> l

This method must take a function that combines a list of LaTeX values into a new one, and creates a function that combines l-typed values. The combining function can be seen as a function with 0 or more LaTeX arguments with a LaTeX value as output.

Instances

LaTeXC LaTeX

This instance just sets liftListL = id.

Defined in Text.LaTeX.Base.Class

Methods

liftListL :: ([LaTeX] -> LaTeX) -> [LaTeX] -> LaTeX

(Monad m, a ~ ()) => LaTeXC (LaTeXT m a)

Defined in Text.LaTeX.Base.Writer

Methods

liftListL :: ([LaTeX] -> LaTeX) -> [LaTeXT m a] -> LaTeXT m a

class Semigroup a => Monoid a where

The class of monoids (types with an associative binary operation that has an identity). Instances should satisfy the following laws:

• x <> mempty = x

• mempty <> x = x

• x <> (y <> z) = (x <> y) <> z (Semigroup law)

• mconcat = foldr '(<>)' mempty

The method names refer to the monoid of lists under concatenation, but there are many other instances.

Some types can be viewed as a monoid in more than one way, e.g. both addition and multiplication on numbers. In such cases we often define newtypes and make those instances of Monoid, e.g. Sum and Product.

NOTE: Semigroup is a superclass of Monoid since base-4.11.0.0.

Minimal complete definition

mempty

Methods

mempty :: a

Identity of mappend

mappend :: a -> a -> a

An associative operation

NOTE: This method is redundant and has the default implementation mappend = '(<>)' since base-4.11.0.0.

mconcat :: [a] -> a

Fold a list using the monoid.

For most types, the default definition for mconcat will be used, but the function is included in the class definition so that an optimized version can be provided for specific types.

Instances

Monoid Ordering

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: Ordering

mappend :: Ordering -> Ordering -> Ordering

mconcat :: [Ordering] -> Ordering

Monoid ()

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: ()

mappend :: () -> () -> ()

mconcat :: [()] -> ()

Monoid All

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: All

mappend :: All -> All -> All

mconcat :: [All] -> All

Monoid Any

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: Any

mappend :: Any -> Any -> Any

mconcat :: [Any] -> Any

Monoid ByteString

Defined in Data.ByteString.Lazy.Internal

Methods

mempty :: ByteString

mappend :: ByteString -> ByteString -> ByteString

mconcat :: [ByteString] -> ByteString

Monoid ByteString

Defined in Data.ByteString.Internal

Methods

mempty :: ByteString

mappend :: ByteString -> ByteString -> ByteString

mconcat :: [ByteString] -> ByteString

Monoid IntSet

Defined in Data.IntSet.Internal

Methods

mempty :: IntSet

mappend :: IntSet -> IntSet -> IntSet

mconcat :: [IntSet] -> IntSet

Monoid Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

Monoid LaTeX

Method mappend is strict in both arguments (except in the case when the first argument is TeXEmpty).

Defined in Text.LaTeX.Base.Syntax

Methods

mempty :: LaTeX

mappend :: LaTeX -> LaTeX -> LaTeX

mconcat :: [LaTeX] -> LaTeX

Monoid TeXCheck

Defined in Text.LaTeX.Base.Warnings

Methods

mempty :: TeXCheck

mappend :: TeXCheck -> TeXCheck -> TeXCheck

mconcat :: [TeXCheck] -> TeXCheck

Monoid [a]

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: [a]

mappend :: [a] -> [a] -> [a]

mconcat :: [[a]] -> [a]

Semigroup a => Monoid (Maybe a)

Lift a semigroup into Maybe forming a Monoid according to http://en.wikipedia.org/wiki/Monoid: "Any semigroup S may be turned into a monoid simply by adjoining an element e not in S and defining e*e = e and e*s = s = s*e for all s ∈ S."

Since 4.11.0: constraint on inner a value generalised from Monoid to Semigroup.

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: Maybe a

mappend :: Maybe a -> Maybe a -> Maybe a

mconcat :: [Maybe a] -> Maybe a

Monoid a => Monoid (IO a)

Since: base-4.9.0.0

Defined in GHC.Base

Methods

mempty :: IO a

mappend :: IO a -> IO a -> IO a

mconcat :: [IO a] -> IO a

Monoid p => Monoid (Par1 p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: Par1 p

mappend :: Par1 p -> Par1 p -> Par1 p

mconcat :: [Par1 p] -> Par1 p

(Ord a, Bounded a) => Monoid (Min a)

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

mempty :: Min a

mappend :: Min a -> Min a -> Min a

mconcat :: [Min a] -> Min a

(Ord a, Bounded a) => Monoid (Max a)

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

mempty :: Max a

mappend :: Max a -> Max a -> Max a

mconcat :: [Max a] -> Max a

Monoid m => Monoid (WrappedMonoid m)

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

mempty :: WrappedMonoid m

mappend :: WrappedMonoid m -> WrappedMonoid m -> WrappedMonoid m

mconcat :: [WrappedMonoid m] -> WrappedMonoid m

Semigroup a => Monoid (Option a)

Since: base-4.9.0.0

Defined in Data.Semigroup

Methods

mempty :: Option a

mappend :: Option a -> Option a -> Option a

mconcat :: [Option a] -> Option a

Monoid a => Monoid (Identity a)

Since: base-4.9.0.0

Defined in Data.Functor.Identity

Methods

mempty :: Identity a

mappend :: Identity a -> Identity a -> Identity a

mconcat :: [Identity a] -> Identity a

Monoid (First a)

Since: base-2.1

Defined in Data.Monoid

Methods

mempty :: First a

mappend :: First a -> First a -> First a

mconcat :: [First a] -> First a

Monoid (Last a)

Since: base-2.1

Defined in Data.Monoid

Methods

mempty :: Last a

mappend :: Last a -> Last a -> Last a

mconcat :: [Last a] -> Last a

Monoid a => Monoid (Dual a)

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: Dual a

mappend :: Dual a -> Dual a -> Dual a

mconcat :: [Dual a] -> Dual a

Monoid (Endo a)

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: Endo a

mappend :: Endo a -> Endo a -> Endo a

mconcat :: [Endo a] -> Endo a

Num a => Monoid (Sum a)

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: Sum a

mappend :: Sum a -> Sum a -> Sum a

mconcat :: [Sum a] -> Sum a

Num a => Monoid (Product a)

Since: base-2.1

Defined in Data.Semigroup.Internal

Methods

mempty :: Product a

mappend :: Product a -> Product a -> Product a

mconcat :: [Product a] -> Product a

Monoid (IntMap a)

Defined in Data.IntMap.Internal

Methods

mempty :: IntMap a

mappend :: IntMap a -> IntMap a -> IntMap a

mconcat :: [IntMap a] -> IntMap a

Monoid (Seq a)

Defined in Data.Sequence.Internal

Methods

mempty :: Seq a

mappend :: Seq a -> Seq a -> Seq a

mconcat :: [Seq a] -> Seq a

Ord a => Monoid (Set a)

Defined in Data.Set.Internal

Methods

mempty :: Set a

mappend :: Set a -> Set a -> Set a

mconcat :: [Set a] -> Set a

Monoid (Vector a)

Defined in Data.Vector

Methods

mempty :: Vector a

mappend :: Vector a -> Vector a -> Vector a

mconcat :: [Vector a] -> Vector a

Monoid a => Monoid (Matrix a)

Defined in Data.Matrix

Methods

mempty :: Matrix a

mappend :: Matrix a -> Matrix a -> Matrix a

mconcat :: [Matrix a] -> Matrix a

Monoid (Doc a)

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

mempty :: Doc a

mappend :: Doc a -> Doc a -> Doc a

mconcat :: [Doc a] -> Doc a

Monoid (Array a)

Defined in Data.Primitive.Array

Methods

mempty :: Array a

mappend :: Array a -> Array a -> Array a

mconcat :: [Array a] -> Array a

(Hashable a, Eq a) => Monoid (HashSet a)

Defined in Data.HashSet.Base

Methods

mempty :: HashSet a

mappend :: HashSet a -> HashSet a -> HashSet a

mconcat :: [HashSet a] -> HashSet a

Monoid (Doc e)

Defined in Text.PrettyPrint.Free.Internal

Methods

mempty :: Doc e

mappend :: Doc e -> Doc e -> Doc e

mconcat :: [Doc e] -> Doc e

Monoid (MergeSet a)

Defined in Data.Set.Internal

Methods

mempty :: MergeSet a

mappend :: MergeSet a -> MergeSet a -> MergeSet a

mconcat :: [MergeSet a] -> MergeSet a

Monoid b => Monoid (a -> b)

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: a -> b

mappend :: (a -> b) -> (a -> b) -> a -> b

mconcat :: [a -> b] -> a -> b

Monoid (U1 p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: U1 p

mappend :: U1 p -> U1 p -> U1 p

mconcat :: [U1 p] -> U1 p

(Monoid a, Monoid b) => Monoid (a, b)

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: (a, b)

mappend :: (a, b) -> (a, b) -> (a, b)

mconcat :: [(a, b)] -> (a, b)

Monoid (Proxy s)

Since: base-4.7.0.0

Defined in Data.Proxy

Methods

mempty :: Proxy s

mappend :: Proxy s -> Proxy s -> Proxy s

mconcat :: [Proxy s] -> Proxy s

Ord k => Monoid (Map k v)

Defined in Data.Map.Internal

Methods

mempty :: Map k v

mappend :: Map k v -> Map k v -> Map k v

mconcat :: [Map k v] -> Map k v

(Eq k, Hashable k) => Monoid (HashMap k v)

Defined in Data.HashMap.Base

Methods

mempty :: HashMap k v

mappend :: HashMap k v -> HashMap k v -> HashMap k v

mconcat :: [HashMap k v] -> HashMap k v

(Monad m, Monoid a) => Monoid (LaTeXT m a)

Defined in Text.LaTeX.Base.Writer

Methods

mempty :: LaTeXT m a

mappend :: LaTeXT m a -> LaTeXT m a -> LaTeXT m a

mconcat :: [LaTeXT m a] -> LaTeXT m a

Monoid (f p) => Monoid (Rec1 f p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: Rec1 f p

mappend :: Rec1 f p -> Rec1 f p -> Rec1 f p

mconcat :: [Rec1 f p] -> Rec1 f p

(Monoid a, Monoid b, Monoid c) => Monoid (a, b, c)

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: (a, b, c)

mappend :: (a, b, c) -> (a, b, c) -> (a, b, c)

mconcat :: [(a, b, c)] -> (a, b, c)

Monoid a => Monoid (Const a b)

Since: base-4.9.0.0

Defined in Data.Functor.Const

Methods

mempty :: Const a b

mappend :: Const a b -> Const a b -> Const a b

mconcat :: [Const a b] -> Const a b

(Applicative f, Monoid a) => Monoid (Ap f a)

Since: base-4.12.0.0

Defined in Data.Monoid

Methods

mempty :: Ap f a

mappend :: Ap f a -> Ap f a -> Ap f a

mconcat :: [Ap f a] -> Ap f a

Alternative f => Monoid (Alt f a)

Since: base-4.8.0.0

Defined in Data.Semigroup.Internal

Methods

mempty :: Alt f a

mappend :: Alt f a -> Alt f a -> Alt f a

mconcat :: [Alt f a] -> Alt f a

(Semigroup a, Monoid a) => Monoid (Tagged s a)

Defined in Data.Tagged

Methods

mempty :: Tagged s a

mappend :: Tagged s a -> Tagged s a -> Tagged s a

mconcat :: [Tagged s a] -> Tagged s a

Monoid c => Monoid (K1 i c p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: K1 i c p

mappend :: K1 i c p -> K1 i c p -> K1 i c p

mconcat :: [K1 i c p] -> K1 i c p

(Monoid (f p), Monoid (g p)) => Monoid ((f :*: g) p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: (f :*: g) p

mappend :: (f :*: g) p -> (f :*: g) p -> (f :*: g) p

mconcat :: [(f :*: g) p] -> (f :*: g) p

(Monoid a, Monoid b, Monoid c, Monoid d) => Monoid (a, b, c, d)

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: (a, b, c, d)

mappend :: (a, b, c, d) -> (a, b, c, d) -> (a, b, c, d)

mconcat :: [(a, b, c, d)] -> (a, b, c, d)

(Monoid a, Semigroup (ParsecT s u m a)) => Monoid (ParsecT s u m a)

The Monoid instance for ParsecT is used for the same purposes as the Semigroup instance.

Since: parsec-3.1.12

Defined in Text.Parsec.Prim

Methods

mempty :: ParsecT s u m a

mappend :: ParsecT s u m a -> ParsecT s u m a -> ParsecT s u m a

mconcat :: [ParsecT s u m a] -> ParsecT s u m a

Monoid (f p) => Monoid (M1 i c f p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: M1 i c f p

mappend :: M1 i c f p -> M1 i c f p -> M1 i c f p

mconcat :: [M1 i c f p] -> M1 i c f p

Monoid (f (g p)) => Monoid ((f :.: g) p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: (f :.: g) p

mappend :: (f :.: g) p -> (f :.: g) p -> (f :.: g) p

mconcat :: [(f :.: g) p] -> (f :.: g) p

(Monoid a, Monoid b, Monoid c, Monoid d, Monoid e) => Monoid (a, b, c, d, e)

Since: base-2.1

Defined in GHC.Base

Methods

mempty :: (a, b, c, d, e)

mappend :: (a, b, c, d, e) -> (a, b, c, d, e) -> (a, b, c, d, e)

mconcat :: [(a, b, c, d, e)] -> (a, b, c, d, e)

Combinators

From LaTeX

fromLaTeX :: LaTeXC l => LaTeX -> l

Map a LaTeX value to its equivalent in any LaTeXC instance.

Lifting

Lifting functions from LaTeX functions to functions over any instance of LaTeXC. In general, the implementation is as follows:

liftLN f x1 ... xN = liftListL (\[x1,...,xN] -> f x1 ... xN) [x1,...,xN]

liftL :: LaTeXC l => (LaTeX -> LaTeX) -> l -> l

Lift a inner function of LaTeX values into any LaTeXC instance.

liftL2 :: LaTeXC l => (LaTeX -> LaTeX -> LaTeX) -> l -> l -> l

Variant of liftL with a two arguments function.

liftL3 :: LaTeXC l => (LaTeX -> LaTeX -> LaTeX -> LaTeX) -> l -> l -> l -> l

Variant of liftL with a three arguments function.

Others

comm0 :: LaTeXC l => String -> l

A simple (without arguments) and handy command generator using the name of the command.

comm0 str = fromLaTeX $ TeXComm str []

comm1 :: LaTeXC l => String -> l -> l

A one parameter command generator using the name of the command. The parameter will be rendered as a fixed argument.

comm1 str = liftL $ \l -> TeXComm str [FixArg l]

comm2 :: LaTeXC l => String -> l -> l -> l

A two parameter command generator using the name of the command. The parameters will be rendered as fixed arguments.

comm2 str = liftL2 $ \l1 l2 -> TeXComm str [FixArg l1, FixArg l2]

comm3 :: LaTeXC l => String -> l -> l -> l -> l

A three parameter command generator using the name of the command. The parameters will be rendered as fixed arguments.

comm3 str = liftL2 $ \l1 l2 l3 -> TeXComm str [FixArg l1, FixArg l2, FixArg l3]

commS :: LaTeXC l => String -> l

Like comm0 but using TeXCommS, i.e. no "{}" will be inserted to protect the command's end.

commS = fromLaTeX . TeXCommS

braces :: LaTeXC l => l -> l

A lifted version of the TeXBraces constructor.

braces = liftL TeXBraces

squareBraces :: LaTeXC l => l -> l

raw :: LaTeXC l => Text -> l

Insert a raw piece of Text. This functions doesn't escape LaTeX reserved characters, it insert the text just as it is received.

Warning: This function is unsafe, in the sense that it does not check that the input text is a valid LaTeX block. Make sure any braces, commands or environments are properly closed.