texmodel 0.2.0__py3-none-any.whl

texmodel/std/latex.py

@@ -0,0 +1,516 @@
+r"""latex: The LaTeX kernel: commands every document has without loading a package.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Anywhere, Command, Environment, Passthrough
+from texmodel.package import Package
+from texmodel.types import Raw, Text
+
+package = Package("latex", prefix="", adopted=True, builtin=True)
+
+
+@package.command
+class SetLength(Command):
+    r"""Set a length: `\setlength{\parindent}{0pt}`."""
+
+    cs = "setlength"
+    length: Raw
+    value: Raw
+
+
+@package.command
+class AddToLength(Command):
+    r"""Add to a length."""
+
+    cs = "addtolength"
+    length: Raw
+    value: Raw
+
+
+@package.command
+class NewLength(Command):
+    r"""Declare a length."""
+
+    cs = "newlength"
+    length: Raw
+
+
+@package.command
+class SetToWidth(Command):
+    r"""Set a length to the width of some text."""
+
+    cs = "settowidth"
+    length: Raw
+    text: Raw
+
+
+@package.command
+class SetToHeight(Command):
+    r"""Set a length to the height of some text."""
+
+    cs = "settoheight"
+    length: Raw
+    text: Raw
+
+
+@package.command
+class SetToDepth(Command):
+    r"""Set a length to the depth of some text."""
+
+    cs = "settodepth"
+    length: Raw
+    text: Raw
+
+
+@package.command
+class NewCounter(Command):
+    r"""Declare a counter."""
+
+    cs = "newcounter"
+    name: Raw
+
+
+@package.command
+class SetCounter(Command):
+    r"""Set a counter."""
+
+    cs = "setcounter"
+    name: Raw
+    value: Raw
+
+
+@package.command
+class StepCounter(Command):
+    r"""Add one to a counter."""
+
+    cs = "stepcounter"
+    name: Raw
+
+
+@package.command
+class Arabic(Command):
+    r"""Write a counter in arabic numerals."""
+
+    cs = "arabic"
+    name: Raw
+
+
+@package.command
+class CounterValue(Command):
+    r"""The value of a counter, for arithmetic."""
+
+    cs = "value"
+    name: Raw
+
+
+@package.command
+class VSpace(Command):
+    r"""Vertical space."""
+
+    cs = "vspace"
+    length: Raw
+
+
+@package.command
+class HSpace(Command):
+    r"""Horizontal space."""
+
+    cs = "hspace"
+    length: Raw
+
+
+@package.command
+class NoIndent(Command):
+    r"""Start a paragraph without indentation."""
+
+    cs = "noindent"
+
+
+@package.command
+class Par(Command):
+    r"""End the paragraph."""
+
+    cs = "par"
+
+
+@package.command
+class ClearPage(Command):
+    r"""End the page and flush floats."""
+
+    cs = "clearpage"
+
+
+@package.command
+class NewPage(Command):
+    r"""End the page."""
+
+    cs = "newpage"
+
+
+@package.command
+class ThisPageStyle(Command):
+    r"""Page style of the current page."""
+
+    cs = "thispagestyle"
+    style: Raw
+
+
+@package.command
+class PageStyle(Command):
+    r"""Page style from here on."""
+
+    cs = "pagestyle"
+    style: Raw
+
+
+@package.command
+class Null(Command):
+    r"""An empty box, so a page has content."""
+
+    cs = "null"
+
+
+@package.command
+class IgnoreSpaces(Command):
+    r"""Skip the spaces that follow."""
+
+    cs = "ignorespaces"
+
+
+@package.command
+class FrenchSpacing(Command):
+    r"""Equal space after every sentence."""
+
+    cs = "frenchspacing"
+
+
+@package.command
+class FontSize(Command):
+    r"""Font size and line skip, in effect after `\selectfont`."""
+
+    cs = "fontsize"
+    size: Raw
+    skip: Raw
+
+
+@package.command
+class SelectFont(Command):
+    r"""Apply the font settings made so far."""
+
+    cs = "selectfont"
+
+
+@package.command
+class Bfseries(Command):
+    r"""Bold, from here to the end of the group."""
+
+    cs = "bfseries"
+
+
+@package.command
+class Centering(Command):
+    r"""Centre the paragraphs of the group."""
+
+    cs = "centering"
+
+
+@package.command
+class Tiny(Command):
+    r"""Size `\tiny`."""
+
+    cs = "tiny"
+
+
+@package.command
+class ScriptSize(Command):
+    r"""Size `\scriptsize`."""
+
+    cs = "scriptsize"
+
+
+@package.command
+class FootnoteSize(Command):
+    r"""Size `\footnotesize`."""
+
+    cs = "footnotesize"
+
+
+@package.command
+class Small(Command):
+    r"""Size `\small`."""
+
+    cs = "small"
+
+
+@package.command
+class NormalSize(Command):
+    r"""Size `\normalsize`."""
+
+    cs = "normalsize"
+
+
+@package.command
+class Large(Command):
+    r"""Size `\large` (lowercase)."""
+
+    cs = "large"
+
+
+@package.command
+class LargeCap(Command):
+    r"""Size `\Large`."""
+
+    cs = "Large"
+
+
+@package.command
+class LargeAllCaps(Command):
+    r"""Size `\LARGE`."""
+
+    cs = "LARGE"
+
+
+@package.command
+class Huge(Command):
+    r"""Size `\huge` (lowercase)."""
+
+    cs = "huge"
+
+
+@package.command
+class HugeCap(Command):
+    r"""Size `\Huge`."""
+
+    cs = "Huge"
+
+
+@package.command
+class TextBold(Command):
+    r"""Bold text."""
+
+    cs = "textbf"
+    text: Text
+
+
+@package.command
+class TextItalic(Command):
+    r"""Italic text."""
+
+    cs = "textit"
+    text: Text
+
+
+@package.command
+class Emph(Command):
+    r"""Emphasised text."""
+
+    cs = "emph"
+    text: Text
+
+
+@package.command
+class MakeUppercase(Command):
+    r"""Upper-case text."""
+
+    cs = "MakeUppercase"
+    text: Text
+
+
+@package.command
+class FpEval(Command):
+    r"""A floating-point expression, evaluated where it expands: `\fpeval{round(3*2.5, 1)}`."""
+
+    cs = "fpeval"
+    expr: Raw
+
+
+@package.command
+class Phantom(Command):
+    r"""Space the size of the text, with nothing in it."""
+
+    cs = "phantom"
+    text: Raw
+
+
+@package.command
+class VPhantom(Command):
+    r"""Vertical space the size of the text."""
+
+    cs = "vphantom"
+    text: Raw
+
+
+@package.command
+class TextBullet(Command):
+    r"""A bullet."""
+
+    cs = "textbullet"
+
+
+@package.command
+class TextQuoteLeft(Command):
+    r"""A left single quote."""
+
+    cs = "textquoteleft"
+
+
+@package.command
+class TextQuoteRight(Command):
+    r"""A right single quote."""
+
+    cs = "textquoteright"
+
+
+@package.command
+class TextQuoteDblLeft(Command):
+    r"""A left double quote."""
+
+    cs = "textquotedblleft"
+
+
+@package.command
+class TextQuoteDblRight(Command):
+    r"""A right double quote."""
+
+    cs = "textquotedblright"
+
+
+@package.command
+class NewSaveBox(Command):
+    r"""Declare a box register."""
+
+    cs = "newsavebox"
+    box: Raw
+
+
+@package.command
+class UseBox(Command):
+    r"""Typeset a saved box."""
+
+    cs = "usebox"
+    box: Raw
+
+
+@package.command
+class AtBeginDocument(Command):
+    r"""Run code at `\begin{document}`."""
+
+    cs = "AtBeginDocument"
+    code: Raw
+
+
+@package.command
+class AtEndDocument(Command):
+    r"""Run code at `\end{document}`."""
+
+    cs = "AtEndDocument"
+    code: Raw
+
+
+@package.command
+class PackageError(Command):
+    r"""Stop with a package's error."""
+
+    cs = "PackageError"
+    package: Raw
+    message: Raw
+    help: Raw
+
+
+@package.command
+class PackageWarning(Command):
+    r"""A package's warning, with the input line."""
+
+    cs = "PackageWarning"
+    package: Raw
+    message: Raw
+
+
+@package.command
+class PackageWarningNoLine(Command):
+    r"""A package's warning, without the input line."""
+
+    cs = "PackageWarningNoLine"
+    package: Raw
+    message: Raw
+
+
+@package.command
+class PackageInfo(Command):
+    r"""A package's note in the log."""
+
+    cs = "PackageInfo"
+    package: Raw
+    message: Raw
+
+
+@package.command
+class PassOptionsToPackage(Command):
+    r"""Options for a package loaded later."""
+
+    cs = "PassOptionsToPackage"
+    options: Raw
+    package: Raw
+
+
+@package.command
+class DeclareOption(Command):
+    r"""Declare a package option and what it does."""
+
+    cs = "DeclareOption"
+    option: Raw
+    code: Raw
+
+
+@package.command
+class IfFileExists(Command):
+    r"""Choose by whether a file can be found."""
+
+    cs = "IfFileExists"
+    file: Raw
+    yes: Raw
+    no: Raw
+
+
+@package.command
+class InputIfFileExists(Command):
+    r"""Read a file if it can be found."""
+
+    cs = "InputIfFileExists"
+    file: Raw
+    yes: Raw
+    no: Raw
+
+
+@package.environment
+class Center(Environment):
+    r"""Centred paragraphs."""
+
+    cs = "center"
+    children = [Anywhere(Passthrough)]
+
+
+@package.environment
+class FlushLeft(Environment):
+    r"""Left-aligned paragraphs."""
+
+    cs = "flushleft"
+    children = [Anywhere(Passthrough)]
+
+
+@package.environment
+class FlushRight(Environment):
+    r"""Right-aligned paragraphs."""
+
+    cs = "flushright"
+    children = [Anywhere(Passthrough)]
+
+
+@package.environment
+class Minipage(Environment):
+    r"""A box of a given width: `\begin{minipage}[t]{5cm}`."""
+
+    cs = "minipage"
+    children = [Anywhere(Passthrough)]
+    width: Raw
+    position: Raw | None = None

texmodel/std/microtype.py

@@ -0,0 +1,27 @@
+r"""microtype: Micro-typography.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Command
+from texmodel.package import Package
+from texmodel.types import Raw
+
+package = Package("microtype", prefix="", adopted=True)
+
+
+@package.command
+class MicrotypeSetup(Command):
+    r"""Change microtype's options after loading."""
+
+    cs = "microtypesetup"
+    options: Raw
+
+
+@package.command
+class SetProtrusion(Command):
+    r"""Protrusion of characters: `\SetProtrusion[name=x]{encoding=*}{A={50,50}}`."""
+
+    cs = "SetProtrusion"
+    set: Raw
+    list: Raw
+    options: Raw | None = None

texmodel/std/pdfrender.py

@@ -0,0 +1,17 @@
+r"""pdfrender: PDF text rendering modes.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Command
+from texmodel.package import Package
+from texmodel.types import Raw
+
+package = Package("pdfrender", prefix="", adopted=True)
+
+
+@package.command
+class PdfRender(Command):
+    r"""Set text rendering for the group: `\pdfrender{TextRenderingMode=2,LineWidth=0.4pt}`."""
+
+    cs = "pdfrender"
+    options: Raw

texmodel/std/tcolorbox.py

@@ -0,0 +1,43 @@
+r"""tcolorbox: Coloured boxes.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Anywhere, Command, Environment, Passthrough
+from texmodel.package import Package
+from texmodel.types import Raw
+
+package = Package("tcolorbox", prefix="", adopted=True)
+
+
+@package.environment
+class Tcolorbox(Environment):
+    r"""A coloured box: `\begin{tcolorbox}[colback=white]`."""
+
+    cs = "tcolorbox"
+    children = [Anywhere(Passthrough)]
+    options: Raw | None = None
+
+
+@package.command
+class TcbUseLibrary(Command):
+    r"""Load tcolorbox libraries: `\tcbuselibrary{skins}`."""
+
+    cs = "tcbuselibrary"
+    libraries: Raw
+
+
+@package.command
+class TcbSet(Command):
+    r"""Set tcolorbox keys."""
+
+    cs = "tcbset"
+    options: Raw
+
+
+@package.command
+class Tcbox(Command):
+    r"""A coloured box around some text, sized to it."""
+
+    cs = "tcbox"
+    text: Raw
+    options: Raw | None = None

texmodel/std/tikz.py

@@ -0,0 +1,36 @@
+r"""tikz: TikZ. Only what fits the model:
+its path commands (`\draw`, `\node`, `\fill`, `\clip`) have their own syntax
+and are written as `Passthrough` or `Raw`.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Anywhere, Command, Environment, Passthrough
+from texmodel.package import Package
+from texmodel.types import Raw
+
+package = Package("tikz", prefix="", adopted=True)
+
+
+@package.environment
+class Tikzpicture(Environment):
+    r"""A TikZ picture; its content is TikZ source."""
+
+    cs = "tikzpicture"
+    children = [Anywhere(Passthrough)]
+    options: Raw | None = None
+
+
+@package.command
+class UseTikzLibrary(Command):
+    r"""Load TikZ libraries: `\usetikzlibrary{calc,positioning}`."""
+
+    cs = "usetikzlibrary"
+    libraries: Raw
+
+
+@package.command
+class TikzSet(Command):
+    r"""Set TikZ keys or styles."""
+
+    cs = "tikzset"
+    options: Raw

texmodel/std/xcolor.py

@@ -0,0 +1,47 @@
+r"""xcolor: Colours.
+
+A header (the package is adopted): it declares the interface, `texmodel` writes calls and never the package."""
+
+from texmodel.components import Command
+from texmodel.package import Package
+from texmodel.types import Raw, Text
+
+package = Package("xcolor", prefix="", adopted=True)
+
+
+@package.command
+class DefineColor(Command):
+    r"""Name a colour: `\definecolor{ink}{HTML}{223344}`."""
+
+    cs = "definecolor"
+    name: Raw
+    model: Raw
+    spec: Raw
+
+
+@package.command
+class ColorLet(Command):
+    r"""Name a colour by mixing others."""
+
+    cs = "colorlet"
+    name: Raw
+    spec: Raw
+
+
+@package.command
+class Color(Command):
+    r"""Switch the text colour: `\color{ink}` or `\color[rgb]{1,0,0}`."""
+
+    cs = "color"
+    name: Raw
+    model: Raw | None = None
+
+
+@package.command
+class TextColor(Command):
+    r"""Coloured text: `\textcolor{ink}{words}`."""
+
+    cs = "textcolor"
+    name: Raw
+    text: Text
+    model: Raw | None = None