Safe Haskell	None
Language	Haskell2010

Language.Ltml.ToLaTeX.GlobalState

Description

Provides the GlobalState and everything to mutate it.

Synopsis

data GlobalState = GlobalState {
- _counterState :: CounterState
- _flagState :: FlagState
- _formatState :: FormatState
- _enumPosition :: [Int]
- _labelToRef :: Map Label Text
- _labelToFootNote :: Map Label Footnote
- _toc :: DList PreLaTeX
- _appendixHeaders :: DList PreLaTeX
- _preDocument :: PreLaTeX
}
data DocType
- = Main
- | Appendix
nextSupersection :: State GlobalState Int
nextSection :: State GlobalState Int
nextInsertedSection :: State GlobalState Int
nextParagraph :: State GlobalState Int
nextSentence :: State GlobalState Int
nextFootnote :: State GlobalState Int
nextAppendix :: State GlobalState Int
resetCountersHard :: State GlobalState ()
resetCountersSoft :: State GlobalState ()
insertRefLabel :: Maybe Label -> Text -> State GlobalState ()
nextEnumPosition :: State GlobalState [Int]
descendEnumTree :: State GlobalState a -> State GlobalState a
addTOCEntry :: Int -> Int -> KeyFormat -> IdentifierFormat -> PreLaTeX -> State GlobalState PreLaTeX
addAppendixHeaderEntry :: Int -> KeyFormat -> IdentifierFormat -> PreLaTeX -> State GlobalState ()
addHeaderFooter :: HeaderFooterFormat -> HeaderFooterFormat -> Text -> Text -> Text -> State GlobalState ()
counterState :: Lens' GlobalState CounterState
flagState :: Lens' GlobalState FlagState
formatState :: Lens' GlobalState FormatState
supersectionCTR :: Lens' CounterState Int
sectionCTR :: Lens' CounterState Int
insertedSectionCTR :: Lens' CounterState Int
paragraphCTR :: Lens' CounterState Int
sentenceCTR :: Lens' CounterState Int
footnoteCTR :: Lens' CounterState Int
appendixCTR :: Lens' CounterState Int
tocLabelCTR :: Lens' CounterState Int
enumPosition :: Lens' GlobalState [Int]
enumIdentifierFormat :: Lens' FormatState IdentifierFormat
appendixFormat :: Lens' FormatState AppendixElementFormat
docHeadingFormat :: Lens' FormatState MainHeadingFormat
sectionFormat :: Lens' FormatState SectionFormat
onlyOneParagraph :: Lens' FlagState Bool
flaggedParent :: Lens' FlagState Bool
flaggedChildren :: Lens' FlagState Bool
docType :: Lens' FlagState DocType
labelToRef :: Lens' GlobalState (Map Label Text)
labelToFootNote :: Lens' GlobalState (Map Label Footnote)
toc :: Lens' GlobalState (DList PreLaTeX)
appendixHeaders :: Lens' GlobalState (DList PreLaTeX)
preDocument :: Lens' GlobalState PreLaTeX
initialGlobalState :: GlobalState
initialCounterState :: CounterState
initialFlagState :: FlagState

Documentation

data GlobalState Source #

State for generating and keeping track of context

Constructors

GlobalState

Fields

_counterState :: CounterState
Counters to keep track of the position in the document
_flagState :: FlagState
Flags for special cases
_formatState :: FormatState
_enumPosition :: [Int]
Path for current enum position
_labelToRef :: Map Label Text
since the style of the identifier is defined globally for an enumeration or appendix we need to pass it to the kids
_labelToFootNote :: Map Label Footnote
_toc :: DList PreLaTeX
functional list that builds the table of contents
_appendixHeaders :: DList PreLaTeX
_preDocument :: PreLaTeX
pre-document is used to store the header and footer of the document

Instances

Instances details

Show GlobalState Source #
Instance details Defined in Language.Ltml.ToLaTeX.GlobalState Methods showsPrec :: Int -> GlobalState -> ShowS # show :: GlobalState -> String # showList :: [GlobalState] -> ShowS #

data DocType Source #

introduced a datatype instead of using bool to make it easily extensible

Constructors

Main
Appendix

Instances

Instances details

Show DocType Source #
Instance details Defined in Language.Ltml.ToLaTeX.GlobalState Methods showsPrec :: Int -> DocType -> ShowS # show :: DocType -> String # showList :: [DocType] -> ShowS #
Eq DocType Source #
Instance details Defined in Language.Ltml.ToLaTeX.GlobalState Methods (==) :: DocType -> DocType -> Bool # (/=) :: DocType -> DocType -> Bool #

nextSupersection :: State GlobalState Int Source #

nextSection :: State GlobalState Int Source #

nextInsertedSection :: State GlobalState Int Source #

nextParagraph :: State GlobalState Int Source #

nextSentence :: State GlobalState Int Source #

nextFootnote :: State GlobalState Int Source #

nextAppendix :: State GlobalState Int Source #

resetCountersHard :: State GlobalState () Source #

resetCountersSoft :: State GlobalState () Source #

insertRefLabel :: Maybe Label -> Text -> State GlobalState () Source #

nextEnumPosition :: State GlobalState [Int] Source #

Get the path to the current level

descendEnumTree :: State GlobalState a -> State GlobalState a Source #

Go one enum level deeper for the required action

addTOCEntry :: Int -> Int -> KeyFormat -> IdentifierFormat -> PreLaTeX -> State GlobalState PreLaTeX Source #

the state uses a dlist to keep track of the toc. so we render the (mostly) heading, wrap it in a hyperlink, to make the final pdf interactive. returns the corresponding hypertarget.

addAppendixHeaderEntry :: Int -> KeyFormat -> IdentifierFormat -> PreLaTeX -> State GlobalState () Source #

since the toc is emptied for each document, but we need the headings of the appendices in the main document, we collect it with this function as well

addHeaderFooter :: HeaderFooterFormat -> HeaderFooterFormat -> Text -> Text -> Text -> State GlobalState () Source #

function to fill the header and footer with the required content

counterState :: Lens' GlobalState CounterState Source #

flagState :: Lens' GlobalState FlagState Source #

formatState :: Lens' GlobalState FormatState Source #

supersectionCTR :: Lens' CounterState Int Source #

sectionCTR :: Lens' CounterState Int Source #

insertedSectionCTR :: Lens' CounterState Int Source #

paragraphCTR :: Lens' CounterState Int Source #

sentenceCTR :: Lens' CounterState Int Source #