Text.LaTeX.Base.Syntax

LaTeX syntax description in the definition of the LaTeX datatype. If you want to add new commands or environments not defined in the library, import this module and use LaTeX data constructors.

LaTeX datatype

data Measure

Measure units defined in LaTeX. Use CustomMeasure to use commands like textwidth. For instance:

rule Nothing (CustomMeasure linewidth) (Pt 2)

This will create a black box (see rule) as wide as the text and two points tall.

Constructors

Pt Double

A point is 1/72.27 inch, that means about 0.0138 inch or 0.3515 mm.

Mm Double

Millimeter.

Cm Double

Centimeter.

In Double

Inch.

Ex Double

The height of an "x" in the current font.

Em Double

The width of an "M" in the current font.

CustomMeasure LaTeX

You can introduce a LaTeX expression as a measure.

Instances

Eq Measure

Methods

(==) :: Measure -> Measure -> Bool

(/=) :: Measure -> Measure -> Bool

Show Measure

Methods

showsPrec :: Int -> Measure -> ShowS

show :: Measure -> String

showList :: [Measure] -> ShowS

Arbitrary Measure

Methods

arbitrary :: Gen Measure

shrink :: Measure -> [Measure]

Render Measure

Methods

render :: Measure -> Text

Texy Measure

Methods

texy :: LaTeXC l => Measure -> l

data MathType

Different types of syntax for mathematical expressions.

Constructors

Parentheses

Square

Dollar

Instances

Eq MathType

Methods

(==) :: MathType -> MathType -> Bool

(/=) :: MathType -> MathType -> Bool

Show MathType

Methods

showsPrec :: Int -> MathType -> ShowS

show :: MathType -> String

showList :: [MathType] -> ShowS

data LaTeX

Type of LaTeX blocks.

Constructors

TeXRaw Text

Raw text.

TeXComm String [TeXArg]

Constructor for commands. First argument is the name of the command. Second, its arguments.

TeXCommS String

Constructor for commands with no arguments. When rendering, no space or {} will be added at the end.

TeXEnv String [TeXArg] LaTeX

Constructor for environments. First argument is the name of the environment. Second, its arguments. Third, its content.

TeXMath MathType LaTeX

Mathematical expressions.

TeXLineBreak (Maybe Measure) Bool

Line break command.

TeXBraces LaTeX

A expression between braces.

TeXComment Text

Comments.

TeXSeq LaTeX LaTeX

Sequencing of LaTeX expressions. Use <> preferably.

TeXEmpty

An empty block. Neutral element of <>.

Instances

Eq LaTeX

Methods

(==) :: LaTeX -> LaTeX -> Bool

(/=) :: LaTeX -> LaTeX -> Bool

Show LaTeX

Methods

showsPrec :: Int -> LaTeX -> ShowS

show :: LaTeX -> String

showList :: [LaTeX] -> ShowS

IsString LaTeX

Method fromString escapes LaTeX reserved characters using protectString.

Methods

fromString :: String -> LaTeX

Monoid LaTeX

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

Methods

mempty :: LaTeX

mappend :: LaTeX -> LaTeX -> LaTeX

mconcat :: [LaTeX] -> LaTeX

Arbitrary LaTeX

Methods

arbitrary :: Gen LaTeX

shrink :: LaTeX -> [LaTeX]

LaTeXC LaTeX

This instance just sets liftListL = id.

Methods

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

Render LaTeX

Methods

render :: LaTeX -> Text

Texy LaTeX

Methods

texy :: LaTeXC l => LaTeX -> l

data TeXArg

An argument for a LaTeX command or environment.

Constructors

FixArg LaTeX

Fixed argument.

OptArg LaTeX

Optional argument.

MOptArg [LaTeX]

Multiple optional argument.

SymArg LaTeX

An argument enclosed between < and >.

MSymArg [LaTeX]

Version of SymArg with multiple options.

ParArg LaTeX

An argument enclosed between ( and ).

MParArg [LaTeX]

Version of ParArg with multiple options.

Instances

Eq TeXArg

Methods

(==) :: TeXArg -> TeXArg -> Bool

(/=) :: TeXArg -> TeXArg -> Bool

Show TeXArg

Methods

showsPrec :: Int -> TeXArg -> ShowS

show :: TeXArg -> String

showList :: [TeXArg] -> ShowS

Arbitrary TeXArg

Methods

arbitrary :: Gen TeXArg

shrink :: TeXArg -> [TeXArg]

Render TeXArg

Methods

render :: TeXArg -> Text

(<>) :: Monoid m => m -> m -> m infixr 6

An infix synonym for mappend.

Since: 4.5.0.0

Escaping reserved characters

protectString :: String -> String

Escape LaTeX reserved characters in a String.

protectText :: Text -> Text

Escape LaTeX reserved characters in a Text.

Syntax analysis

matchCommand :: (String -> Bool) -> LaTeX -> [(String, [TeXArg])]

Traverse a LaTeX syntax tree and returns the commands (see TeXComm and TeXCommS) that matches the condition and their arguments in each call.

lookForCommand

Arguments

:: String

Name of the command.

-> LaTeX

LaTeX syntax tree.

-> [[TeXArg]]

List of arguments passed to the command.

Look into a LaTeX syntax tree to find any call to the command with the given name. It returns a list of arguments with which this command is called.

lookForCommand = (fmap snd .) . matchCommand . (==)

If the returned list is empty, the command was not found. However, if the list contains empty lists, those are callings to the command with no arguments.

For example

lookForCommand "author" l

would look for the argument passed to the \author command in l.

matchEnv :: (String -> Bool) -> LaTeX -> [(String, [TeXArg], LaTeX)]

Traverse a LaTeX syntax tree and returns the environments (see TeXEnv) that matches the condition, their arguments and their content in each call.

lookForEnv :: String -> LaTeX -> [([TeXArg], LaTeX)]

Similar to lookForCommand, but applied to environments. It returns a list with arguments passed and content of the environment in each call.

lookForEnv = (fmap (\(_,as,l) -> (as,l)) .) . matchEnv . (==)

texmap

Arguments

:: (LaTeX -> Bool)

Condition.

-> (LaTeX -> LaTeX)

Function to apply when the condition matches.

-> LaTeX

-> LaTeX

The function texmap looks for subexpressions that match a given condition and applies a function to them.

texmap c f = runIdentity . texmapM c (pure . f)

texmapM

Arguments

:: (Applicative m, Monad m)

=> (LaTeX -> Bool)

Condition.

-> (LaTeX -> m LaTeX)

Function to apply when the condition matches.

-> LaTeX

-> m LaTeX

Version of texmap where the function returns values in a Monad.

Utils

getBody :: LaTeX -> Maybe LaTeX

Extract the content of the document environment, if present.

getPreamble :: LaTeX -> LaTeX

Extract the preamble of a LaTeX document (everything before the document environment). It could be empty.