pandoc_latex_newpage._main

Complexity

Total Complexity

10

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Importance

Changes

0

3 Functions

Rating	Name	Duplication	Size	Complexity
A	main()	0	15	1
A	prepare()	0	18	5
A	newpage()	0	22	4

#!/usr/bin/env python

"""
Pandoc filter for converting horizontal rule to new page in LaTeX.
"""
from __future__ import annotations

from panflute import (
    Doc,
    Element,
    HorizontalRule,
    MetaBool,
    MetaMap,
    RawBlock,
    run_filter,
)


def newpage(elem: Element, doc: Doc) -> RawBlock | None:
    r"""
    Replace HorizontalRule by a \clearpage or a \cleardoublepage.

    Arguments
    ---------
    elem
        A pandoc element
    doc
        pandoc document

    Returns
    -------
    RawBlock | None
        A RawBlock or None.
    """
    # Is it in the right format and is it an HorizontalRule?
    if doc.format == "latex" and isinstance(elem, HorizontalRule):
        if doc.double:
            return RawBlock("\\cleardoublepage", "tex")
        return RawBlock("\\clearpage", "tex")
    return None


def prepare(doc: Doc) -> None:
    """
    Prepare document.

    Arguments
    ---------
    doc
        pandoc document
    """
    doc.double = True

    if (
        "pandoc-latex-newpage" in doc.metadata.content
        and isinstance(doc.metadata.content["pandoc-latex-newpage"], MetaMap)
        and "double" in doc.metadata.content["pandoc-latex-newpage"]
        and isinstance(doc.metadata.content["pandoc-latex-newpage"]["double"], MetaBool)
    ):
        doc.double = doc.metadata.content["pandoc-latex-newpage"]["double"].boolean


def main(doc: Doc | None = None) -> Doc:
    """
    Convert the pandoc document.

    Arguments
    ---------
    doc
        pandoc document

    Returns
    -------
    Doc
        The modified document.
    """
    return run_filter(newpage, prepare=prepare, doc=doc)


if __name__ == "__main__":
    main()