README
- ::equalBinding::equal
- ::not_equalBinding::not_equal
- ::to_reprBinding::to_repr
- ::equalDuplex::equal
- ::not_equalDuplex::not_equal
- ::to_reprDuplex::to_repr
- ::equalFace::equal
- ::not_equalFace::not_equal
- ::to_reprFace::to_repr
- ::equalLayout::equal
- ::not_equalLayout::not_equal
- ::to_reprLayout::to_repr
- ::equalPaper::equal
- ::not_equalPaper::not_equal
- ::to_reprPaper::to_repr
- ::equalPlan::equal
- ::not_equalPlan::not_equal
- ::to_reprPlan::to_repr
- ::equalPlanError::equal
- ::not_equalPlanError::not_equal
- ::to_reprPlanError::to_repr
- ::equalRect::equal
- ::not_equalRect::not_equal
- ::to_reprRect::to_repr
- ::equalSheet::equal
- ::not_equalSheet::not_equal
- ::to_reprSheet::to_repr
- ::equalSignature::equal
- ::not_equalSignature::not_equal
- ::to_reprSignature::to_repr
- ::equalSlot::equal
- ::not_equalSlot::not_equal
- ::to_reprSlot::to_repr
V
csv_report
V
impose
V
impose_with
V
json_report
V
layout
V
recover
V
signatures
V
svg_proof
V
validate_config
V
verify

quireloom

Deterministic booklet imposition and fold-order verification in pure MoonBit

booklet

imposition

printing

Download zip

Author

Novanke

Version

0.1.0

License

Apache-2.0

Repository

github.com/Novanke/quireloom

Last updated

12 hours ago

Downloads

#Novanke/quireloom

Binding

source

pub(all) enum Binding {
  Left
  Right
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Binding::equal

source

fn Binding::equal(Binding, Binding) -> Bool

Binding::not_equal

source

fn Binding::not_equal(x : Binding, y : Binding) -> Bool

Binding::to_repr

source

fn Binding::to_repr(Binding) -> @moonbitlang/core/debug.Repr
Repr

Duplex

source

pub(all) enum Duplex {
  LongEdge
  ShortEdge
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Duplex::equal

source

fn Duplex::equal(Duplex, Duplex) -> Bool

Duplex::not_equal

source

fn Duplex::not_equal(x : Duplex, y : Duplex) -> Bool

Duplex::to_repr

source

fn Duplex::to_repr(Duplex) -> @moonbitlang/core/debug.Repr
Repr

Face

source

pub(all) struct Face {
  left : Slot
  right : Slot
  rotation : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Face::equal

source

fn Face::equal(Face, Face) -> Bool

Face::not_equal

source

fn Face::not_equal(x : Face, y : Face) -> Bool

Face::to_repr

source

fn Face::to_repr(Face) -> @moonbitlang/core/debug.Repr
Repr

Layout

source

pub(all) struct Layout {
  left : Rect
  right : Rect
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Layout::equal

source

fn Layout::equal(Layout, Layout) -> Bool

Layout::not_equal

source

fn Layout::not_equal(x : Layout, y : Layout) -> Bool

Layout::to_repr

source

fn Layout::to_repr(Layout) -> @moonbitlang/core/debug.Repr
Repr

Paper

source

pub(all) struct Paper {
  width : Int
  height : Int
  margin : Int
  gutter : Int
  creep : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

All distances are integer millimetres. Creep means an explicit inward shift.

Paper::equal

source

fn Paper::equal(Paper, Paper) -> Bool

Paper::not_equal

source

fn Paper::not_equal(x : Paper, y : Paper) -> Bool

Paper::to_repr

source

fn Paper::to_repr(Paper) -> @moonbitlang/core/debug.Repr
Repr

Plan

source

pub(all) struct Plan {
  page_count : Int
  signature_pages : Int
  binding : Binding
  duplex : Duplex
  sheets : Array[Sheet]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Plan::equal

source

fn Plan::equal(Plan, Plan) -> Bool

Plan::not_equal

source

fn Plan::not_equal(x : Plan, y : Plan) -> Bool

Plan::to_repr

source

fn Plan::to_repr(Plan) -> @moonbitlang/core/debug.Repr
Repr

PlanError

source

pub(all) enum PlanError {
  PageCount
  SignatureSize
  Geometry
  CorruptPlan(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

PlanError::equal

source

fn PlanError::equal(PlanError, PlanError) -> Bool

PlanError::not_equal

source

fn PlanError::not_equal(x : PlanError, y : PlanError) -> Bool

PlanError::to_repr

source

fn PlanError::to_repr(PlanError) -> @moonbitlang/core/debug.Repr
Repr

Rect

source

pub(all) struct Rect {
  x : Int
  y : Int
  width : Int
  height : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Rect::equal

source

fn Rect::equal(Rect, Rect) -> Bool

Rect::not_equal

source

fn Rect::not_equal(x : Rect, y : Rect) -> Bool

Rect::to_repr

source

fn Rect::to_repr(Rect) -> @moonbitlang/core/debug.Repr
Repr

Sheet

source

pub(all) struct Sheet {
  signature : Int
  depth : Int
  front : Face
  back : Face
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Sheet::equal

source

fn Sheet::equal(Sheet, Sheet) -> Bool

Sheet::not_equal

source

fn Sheet::not_equal(x : Sheet, y : Sheet) -> Bool

Sheet::to_repr

source

fn Sheet::to_repr(Sheet) -> @moonbitlang/core/debug.Repr
Repr

Signature

source

pub(all) struct Signature {
  index : Int
  start : Int
  pages : Int
  real_pages : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Signature::equal

source

fn Signature::equal(Signature, Signature) -> Bool

Signature::not_equal

source

fn Signature::not_equal(x : Signature, y : Signature) -> Bool

Signature::to_repr

source

fn Signature::to_repr(Signature) -> @moonbitlang/core/debug.Repr
Repr

Slot

source

pub(all) enum Slot {
  Page(Int)
  Blank
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Slot::equal

source

fn Slot::equal(Slot, Slot) -> Bool

Slot::not_equal

source

fn Slot::not_equal(x : Slot, y : Slot) -> Bool

Slot::to_repr

source

fn Slot::to_repr(Slot) -> @moonbitlang/core/debug.Repr
Repr

csv_report

source

fn csv_report(plan : Plan) -> Result[String, PlanError]

Each row is one face, with empty fields for deliberate blanks.

impose

source

fn impose(pages : Int, maximum : Int) -> Result[Plan, PlanError]

Sheet order is signature order, then outside to inside.

impose_with

source

fn impose_with(pages : Int, maximum : Int, binding : Binding, duplex : Duplex) -> Result[Plan, PlanError]

A short-edge back is the complete canonical back rotated by 180 degrees.

json_report

source

fn json_report(plan : Plan) -> Result[String, PlanError]

Only fixed field names and checked integers enter JSON, so no raw text escapes.

layout

source

fn layout(paper : Paper, depth : Int) -> Result[Layout, PlanError]

Reject clipping, overlapping panels and unsafe integer arithmetic.

recover

source

fn recover(plan : Plan) -> Result[Array[Slot], PlanError]

Undo print orientation, then traverse folded leaves from outside to inside. This verifier consumes a supplied plan; it does not regenerate an imposition.

signatures

source

fn signatures(pages : Int, maximum : Int) -> Result[Array[Signature], PlanError]

Split a book into sequential gatherings, padding only the final one to four.

svg_proof

source

fn svg_proof(plan : Plan, paper : Paper, sheet_index : Int, back : Bool) -> Result[String, PlanError]

A proof contains page labels and a fold line, not source PDF artwork.

validate_config

source

fn validate_config(pages : Int, signature_pages : Int) -> Result[Unit, PlanError]

Bounded inputs keep page arithmetic exact on every backend.

verify

source

fn verify(plan : Plan) -> Result[Unit, PlanError]

Require exact reading order, including every final blank.

Source Files

Site source Report issue Packages Build queue Skills Statistics

quireloom

#Novanke/quireloom

#Binding

#Binding::equal

#Binding::not_equal

#Binding::to_repr

#Duplex

#Duplex::equal

#Duplex::not_equal

#Duplex::to_repr

#Face

#Face::equal

#Face::not_equal

#Face::to_repr

#Layout

#Layout::equal

#Layout::not_equal

#Layout::to_repr

#Paper

#Paper::equal

#Paper::not_equal

#Paper::to_repr

#Plan

#Plan::equal

#Plan::not_equal

#Plan::to_repr

#PlanError

#PlanError::equal

#PlanError::not_equal

#PlanError::to_repr

#Rect

#Rect::equal

#Rect::not_equal

#Rect::to_repr

#Sheet

#Sheet::equal

#Sheet::not_equal

#Sheet::to_repr

#Signature

#Signature::equal

#Signature::not_equal

#Signature::to_repr

#Slot

#Slot::equal

#Slot::not_equal

#Slot::to_repr

#csv_report

#impose

#impose_with

#json_report

#layout

#recover

#signatures

#svg_proof

#validate_config

#verify

Source Files

Binding

Binding::equal

Binding::not_equal

Binding::to_repr

Duplex

Duplex::equal

Duplex::not_equal

Duplex::to_repr

Face

Face::equal

Face::not_equal

Face::to_repr

Layout

Layout::equal

Layout::not_equal

Layout::to_repr

Paper

Paper::equal

Paper::not_equal

Paper::to_repr

Plan

Plan::equal

Plan::not_equal

Plan::to_repr

PlanError

PlanError::equal

PlanError::not_equal

PlanError::to_repr

Rect

Rect::equal

Rect::not_equal

Rect::to_repr

Sheet

Sheet::equal

Sheet::not_equal

Sheet::to_repr

Signature

Signature::equal

Signature::not_equal

Signature::to_repr

Slot

Slot::equal

Slot::not_equal

Slot::to_repr

csv_report

impose

impose_with

json_report

layout

recover

signatures

svg_proof

validate_config

verify