Copyright	(c) 2015 Christopher Chalmers
License	BSD-style (see LICENSE)
Maintainer	c.chalmers@me.com
Safe Haskell	Safe
Language	Haskell2010

System.Texrunner.Parse

Contents

Box
Errors

Description

Functions for parsing Tex output and logs. This log is parser is experimental and largely untested. Please make an issue for any logs that aren't parsed properly.

Synopsis

data Box n = Box {
- boxHeight :: n
- boxDepth :: n
- boxWidth :: n
}
parseBox :: Fractional n => Parser (Box n)
data TexLog = TexLog {
- texInfo :: TexInfo
- numPages :: Maybe Int
- texErrors :: [TexError]
}
data TexInfo = TexInfo {
- texCommand :: Maybe ByteString
- texVersion :: Maybe ByteString
- texDistribution :: Maybe ByteString
}
data TexError = TexError {
- errorLine :: Maybe Int
- error' :: TexError'
}
data TexError'
- = UndefinedControlSequence ByteString
- | MissingNumber
- | Missing Char
- | IllegalUnit
- | PackageError String String
- | LatexError ByteString
- | BadBox ByteString
- | EmergencyStop
- | ParagraphEnded
- | TooMany ByteString
- | DimensionTooLarge
- | TooManyErrors
- | NumberTooBig
- | ExtraBrace
- | FatalError ByteString
- | UnknownError ByteString
someError :: Parser TexError
badBox :: Parser TexError
parseUnit :: Fractional n => Parser n
parseLog :: ByteString -> TexLog
prettyPrintLog :: TexLog -> ByteString

Box

data Box n Source #

Data type for holding dimensions of a hbox. It is likely the internal representation will change to allow nested boxes in the future.

Constructors

Box
Fields boxHeight :: n boxDepth :: n boxWidth :: n

Instances

Show n => Show (Box n) Source #
Instance details Defined in System.Texrunner.Parse Methods showsPrec :: Int -> Box n -> ShowS # show :: Box n -> String # showList :: [Box n] -> ShowS #

parseBox :: Fractional n => Parser (Box n) Source #

Errors

data TexLog Source #

Constructors

TexLog
Fields texInfo :: TexInfo numPages :: Maybe Int texErrors :: [TexError]

Instances

Show TexLog Source #
Instance details Defined in System.Texrunner.Parse Methods showsPrec :: Int -> TexLog -> ShowS # show :: TexLog -> String # showList :: [TexLog] -> ShowS #
Semigroup TexLog Source #
Instance details Defined in System.Texrunner.Parse Methods (<>) :: TexLog -> TexLog -> TexLog # sconcat :: NonEmpty TexLog -> TexLog # stimes :: Integral b => b -> TexLog -> TexLog #
Monoid TexLog Source #
Instance details Defined in System.Texrunner.Parse Methods mempty :: TexLog # mappend :: TexLog -> TexLog -> TexLog # mconcat :: [TexLog] -> TexLog #

data TexInfo Source #

Constructors

TexInfo
Fields texCommand :: Maybe ByteString texVersion :: Maybe ByteString texDistribution :: Maybe ByteString

Instances

Show TexInfo Source #
Instance details Defined in System.Texrunner.Parse Methods showsPrec :: Int -> TexInfo -> ShowS # show :: TexInfo -> String # showList :: [TexInfo] -> ShowS #

data TexError Source #

An error from tex with possible line number.

Constructors

TexError
Fields errorLine :: Maybe Int error' :: TexError'

Instances

Eq TexError Source #
Instance details Defined in System.Texrunner.Parse Methods (==) :: TexError -> TexError -> Bool # (/=) :: TexError -> TexError -> Bool #
Show TexError Source #
Instance details Defined in System.Texrunner.Parse Methods showsPrec :: Int -> TexError -> ShowS # show :: TexError -> String # showList :: [TexError] -> ShowS #

data TexError' Source #

A subset of possible error Tex can throw.

Instances

Eq TexError' Source #
Instance details Defined in System.Texrunner.Parse Methods (==) :: TexError' -> TexError' -> Bool # (/=) :: TexError' -> TexError' -> Bool #
Read TexError' Source #
Instance details Defined in System.Texrunner.Parse Methods readsPrec :: Int -> ReadS TexError' # readList :: ReadS [TexError'] # readPrec :: ReadPrec TexError' # readListPrec :: ReadPrec [TexError'] #
Show TexError' Source #
Instance details Defined in System.Texrunner.Parse Methods showsPrec :: Int -> TexError' -> ShowS # show :: TexError' -> String # showList :: [TexError'] -> ShowS #

someError :: Parser TexError Source #

Parse any line begining with "! ". Any unknown errors are returned as UnknownError.

badBox :: Parser TexError Source #

parseUnit :: Fractional n => Parser n Source #

parseLog :: ByteString -> TexLog Source #

prettyPrintLog :: TexLog -> ByteString Source #

UndefinedControlSequence ByteString
MissingNumber
Missing Char
IllegalUnit
PackageError String String
LatexError ByteString
BadBox ByteString
EmergencyStop
ParagraphEnded
TooMany ByteString
DimensionTooLarge
TooManyErrors
NumberTooBig
ExtraBrace
FatalError ByteString
UnknownError ByteString