Skip to main content

Module format

Module format 

Source
Expand description

Format files: dumping the engine state after an IniTeX run (\dump) and loading it at the start of a normal run.

The format is retex’s own binary layout, not LuaTeX’s. It is a sequence of sections (engine, then host-specific sections such as Lua bytecode), each a length-prefixed blob, behind a header that identifies the retex build. Integers are LEB128 varints (zigzag for signed values). Only non-default entries of the large tables are stored, so loading is fast.

Structs§

Reader
A byte reader matching Writer.
Writer
A byte writer with varint helpers.

Enums§

FormatError
Errors while loading a format.

Constants§

FORMAT_VERSION
The format layout version; bump on any incompatible change.
MAGIC
The magic bytes at the start of every format file.

Functions§

assemble
Builds a complete format file from sections.
disassemble
Splits a format file into its sections.