assembly

type Anchor uint8

type ArgumentSource struct{}

type BlankItem struct {
	// Style layers over the job defaults.
	Style BlankStyle
	// CountOrigin locates the "count" value, or the item when the count is implicit.
	CountOrigin Origin
	// Count is the number of consecutive pages, 1 to MaxBlankCount (see CheckBlankCount).
	Count int64
}

type BlankSpec struct {
	Text       TextSpec
	Dim        PageDim
	Background Fill
}

type BlankStyle struct {
	Text       TextStyle
	Size       Field[PageSize]
	Background Field[Fill]
}

type Code string

type Color struct {
	R, G, B uint8
}

type Contribution struct {
	// TextOverrides references the original item declarations, independent of appearance deduplication.
	TextOverrides *TextStyle
	// Path is the absolute, lexically cleaned path of a PDF; empty for a blank.
	Path string
	// Origin is the item that wrote the contribution; explain it with Locate.
	Origin Origin
	// Count is the number of pages of a blank; for a PDF it is 1, one occurrence of the source.
	Count int64
	// Index is the position of the contribution in Flattened.Contributions.
	Index int
	// File indexes Flattened.Files for a PDF and is -1 for a blank.
	File int
	// Style indexes Flattened.Styles for a blank and is -1 for a PDF.
	Style int
	Kind  ItemKind
}

type Error struct {
	// Consumers lists every affected flattened contribution in instruction order.
	Consumers []Origin
	// Err is the underlying cause, matched by [errors.Is] and [errors.As].
	Err error
	// Message states what is wrong and how to repair it.
	Message string
	Code    Code
	Stage   Stage
	// Related locates further contributions with the same problem, in input order, at most MaxRelated.
	Related []Location
	// Location is where the problem was written; for a shared problem, its first contribution.
	Location Location
	// Affected is the number of contributions the problem applies to.
	Affected int64
}

type Errors []*Error

type Field[T comparable] struct {
	Value  T
	Origin Origin
	// contains filtered or unexported fields
}

type Fill struct {
	Color   Color
	Painted bool
}

type FitTarget string

type Flattened struct {
	// Source explains every Origin.
	Source Source
	// TextDefaults references the job defaults; callers must keep job declarations immutable.
	TextDefaults  *TextStyle
	Contributions []Contribution
	Files         []SourceFile
	Fonts         []FontFileUse
	Styles        []LayeredStyle
	// FitTo retains the effective global target declaration.
	FitTo Field[FitTarget]
	// GeneratedPages is the sum of the blank counts.
	GeneratedPages int64
}

type Font struct {
	// File is the declared path of a font file; empty selects the built-in font.
	File string
	// Base is the directory File resolves against: the base of the scope that declared the font. It is
	// fixed where the font is declared, before any layering, so a font keeps its own base wherever it is used.
	Base string
}

type FontDigest [sha256.Size]byte

type FontDigests func(path string) (FontDigest, bool)

type FontFileUse struct {
	// Path is the absolute, lexically cleaned path.
	Path string
	// Declarations are each distinct declaration of this captured file, in input order.
	Declarations []Origin
}

type HorizontalPlacement uint8

type Item struct {
	// Items are the members of an ItemGroup; never empty.
	Items []Item
	// Path is the declared path of an ItemPDF, relative to its group's base unless absolute.
	Path string
	// Blank is set for an ItemBlank.
	Blank *BlankItem
	// Dir is the declared directory of an ItemGroup, relative to the enclosing base unless absolute.
	Dir    Field[string]
	Origin Origin
	Kind   ItemKind
}

type ItemKind uint8

type Job struct {
	// Source explains every Origin in the tree.
	Source Source
	// Items is the ordered sequence; never empty.
	Items []Item
	// Base is the initial base directory: the plan's directory, the --base-dir value, or the working
	// directory. Plan output and the default font resolve against it.
	Base string
	// Output is the declared output path; unset when the job names none. It resolves against Base.
	Output Field[string]
	// FitTo is the optional global portrait target.
	FitTo Field[FitTarget]
	// Dir is the declared directory for the top-level items, relative to Base.
	Dir Field[string]
	// Defaults is the style every blank layers over. Its font resolves against Base.
	Defaults BlankStyle
	// Origin is the root.
	Origin Origin
}

type LayeredStyle struct {
	Style BlankStyle
	// FirstUse is the first blank that has this appearance.
	FirstUse Origin
}

type Layout struct {
	Source Source
	Flat   *Flattened
	// Placements parallels Flat.Contributions.
	Placements []Placement
	Specs      []ResolvedSpec
	Runs       []Run
	Totals     Totals
}

type Length float64

type Location struct {
	Source  string
	Pointer string
	Offset  int64
	Line    int
	Column  int
}

type Operand struct {
	// Path is the PDF path, taken literally; unused for a blank.
	Path string
	// Position is the zero-based position of the argument in argv, excluding the executable name.
	Position int
	// Blank marks the --blank directive: one generated page that inherits its size.
	Blank bool
}

type Origin struct {
	// Offset is the absolute byte offset of the value in the original document, including any
	// leading byte order mark. It is zero for command-line sources.
	Offset int64
	// Ref is the item (or the root) that contains the value.
	Ref Ref
}

type Overflow uint8

type PageDim struct {
	Width, Height Length
}

type PageGeometry struct {
	Width, Height float64
}

type PageRange struct {
	Start, End, Count int64
}

type PageSize struct {
	Dim     PageDim
	Inherit bool
}

type PathClass uint8

type PathStyle uint8

type Placement struct {
	// Range is the output pages the contribution covers.
	Range PageRange
	// Spec indexes Layout.Specs for a blank and is -1 for a PDF.
	Spec int
	// SizeFrom is the contribution whose page supplied an inherited size; -1 unless SizeSource is
	// not SizeExplicit.
	SizeFrom int
	// Size says how a blank got its size.
	Size SizeSource
}

type Ref uint32

type ResolvedSpec struct {
	// Origins locates the first contributions that use the spec, in input order, at most MaxRelated+1.
	Origins  []Origin
	Spec     BlankSpec
	Declared TextStyle
	// Uses is the number of contributions that use the spec.
	Uses       int64
	FontDigest FontDigest
}

type Run struct {
	// Index is the Layout.Specs index of a generated run, or the Flattened.Files index of a source run.
	Index int
	// FirstPage is the first source page of a source run (always 1, whole files); 0 for a generated run.
	FirstPage int64
	// Count is the number of source pages, or the repeat count of a generated page.
	Count int64
	Kind  RunKind
}

type RunKind uint8

type SizeSource uint8

type Source interface {
	// Name is the file name, "<stdin>", "<inline>", or "argv".
	Name() string
	// Pointer returns the JSON pointer of the node (such as "/items/42/items/3"), with member appended
	// for a field of that node (such as "/count"), or "argv:N" for a command-line operand.
	Pointer(ref Ref, member string) string
	// Position returns the 1-based line and byte column of an offset, or 0, 0 when the source has none.
	Position(offset int64) (int, int)
}

type SourceFile struct {
	Path string
	// FirstUse is the first contribution that names the file.
	FirstUse Origin
	// Uses is the number of occurrences; repeated sources are never merged in the sequence.
	Uses int
}

type SourceGeometry struct {
	First, Last PageGeometry
	Pages       int64
}

type SpecKey struct {
	Spec       BlankSpec
	FontDigest FontDigest
}

type Stage string

type TextAlign uint8

type TextSpec struct {
	Value    string
	Font     Font
	Size     Length
	X, Y     Length
	Width    Length
	Leading  float64
	Color    Color
	Anchor   Anchor
	Align    TextAlign
	Overflow Overflow
}

type TextStyle struct {
	Font     Field[Font]
	Value    Field[string]
	Size     Field[Length]
	Color    Field[Color]
	Anchor   Field[Anchor]
	X        Field[Length]
	Y        Field[Length]
	Width    Field[Length]
	Align    Field[TextAlign]
	Leading  Field[float64]
	Overflow Field[Overflow]
}

type Totals struct {
	Source, Generated, Total int64
}

type VerticalPlacement uint8