# sile-typesetter/sile architecture

> Architecture diagram of the GitHub repository sile-typesetter/sile, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sile-typesetter/sile
- Repository: https://github.com/sile-typesetter/sile

## Overview

##### Main System Components

a) Input Layer:
- Multiple input formats (SIL, XML, Lua) handled by the inputters/ directory
- CLI interface (core/cli.lua) as the entry point

b) Core Processing Layer:
- Typesetting engine (core/typesetter.lua)
- Font management system (core/fontmanager.lua)
- Language processing (core/languages.lua)
- Settings management (core/settings.lua)

c) Layout Engine:
- Frame system (core/frame.lua)
- Page builder (core/pagebuilder.lua)
- Line breaking system (core/break.lua)

d) Output Layer:
- Multiple output backends (outputters/*)
- PDF generation via libtexpdf
- Cairo backend
- Debug output options

##### Key Relationships to Highlight

- Data flow from input through processing to output
- Plugin architecture showing how packages extend core functionality
- Language system integration with hyphenation and bidirectional text support
- Font system interaction with HarfBuzz and FontConfig

##### External Dependencies

- HarfBuzz for text shaping
- FontConfig for font management
- ICU for Unicode handling
- libtexpdf for PDF generation
- Lua runtime environment

##### Specific Implementation Details

- Core Rust components (src/)
- Lua components (core/, packages/, etc.)
- Native C/C++ components (justenough/)
- Configuration and resource files

##### Package System

How the package system (packages/) extends functionality:
- Core packages
- Math typesetting
- Layout packages
- Language support
- Third-party package integration

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Define styles
    classDef core fill:#f9f,stroke:#333,stroke-width:2px
    classDef input fill:#dfd,stroke:#333,stroke-width:2px
    classDef output fill:#ddf,stroke:#333,stroke-width:2px
    classDef external fill:#ffd,stroke:#333,stroke-width:2px
    classDef font fill:#fdf,stroke:#333,stroke-width:2px
    classDef package fill:#dff,stroke:#333,stroke-width:2px

    %% Input Layer
    subgraph InputLayer
        CLI["CLI Interface"]:::input
        InputFormats{"Input Formats"}:::input
        SIL["SIL Format"]:::input
        XML["XML Format"]:::input
        LUA["Lua Format"]:::input
    end

    %% Core Processing Layer
    subgraph CoreLayer
        TypeEngine["Typesetting Engine"]:::core
        FontMgr["Font Management"]:::core
        LangProc["Language Processing"]:::core
        Settings["Settings Management"]:::core
    end

    %% Layout Engine
    subgraph LayoutEngine
        Frame["Frame System"]:::core
        PageBuilder["Page Builder"]:::core
        LineBreak["Line Breaking"]:::core
    end

    %% Font System
    subgraph FontSystem
        HarfBuzz["HarfBuzz Shaping"]:::font
        Fallback["Font Fallback"]:::font
    end

    %% Output Layer
    subgraph OutputLayer
        PDF["PDF Backend"]:::output
        Cairo["Cairo Backend"]:::output
        Debug["Debug Output"]:::output
        Text["Text Output"]:::output
    end

    %% External Dependencies
    subgraph ExternalDeps
        HarfBuzzLib["HarfBuzz Lib"]:::external
        FontConfig["FontConfig"]:::external
        ICU["ICU"]:::external
        LibTexPDF["LibTexPDF"]:::external
    end

    %% Package System
    subgraph PackageSystem
        BasePackage["Base Package"]:::package
        MathSupport["Math Support"]:::package
        LangSupport["Language Support"]:::package
        LayoutPkgs["Layout Packages"]:::package
    end

    %% Relationships
    CLI --> InputFormats
    InputFormats --> |Parse| SIL & XML & LUA
    SIL & XML & LUA --> TypeEngine
    TypeEngine --> FontMgr
    FontMgr --> HarfBuzz
    FontMgr --> Fallback
    TypeEngine --> LangProc
    TypeEngine --> Settings
    TypeEngine --> Frame
    Frame --> PageBuilder
    PageBuilder --> LineBreak
    TypeEngine --> PDF & Cairo & Debug & Text
    HarfBuzz --> HarfBuzzLib
    FontMgr --> FontConfig
    LangProc --> ICU
    PDF --> LibTexPDF
    PackageSystem --> TypeEngine

    %% Click Events
    click CLI "https://github.com/sile-typesetter/sile/blob/master/core/cli.lua"
    click SIL "https://github.com/sile-typesetter/sile/blob/master/inputters/sil.lua"
    click XML "https://github.com/sile-typesetter/sile/blob/master/inputters/xml.lua"
    click LUA "https://github.com/sile-typesetter/sile/blob/master/inputters/lua.lua"
    click TypeEngine "https://github.com/sile-typesetter/sile/blob/master/core/typesetter.lua"
    click FontMgr "https://github.com/sile-typesetter/sile/blob/master/core/fontmanager.lua"
    click LangProc "https://github.com/sile-typesetter/sile/blob/master/core/languages.lua"
    click Settings "https://github.com/sile-typesetter/sile/blob/master/core/settings.lua"
    click Frame "https://github.com/sile-typesetter/sile/blob/master/core/frame.lua"
    click PageBuilder "https://github.com/sile-typesetter/sile/blob/master/core/pagebuilder.lua"
    click LineBreak "https://github.com/sile-typesetter/sile/blob/master/core/break.lua"
    click PDF "https://github.com/sile-typesetter/sile/blob/master/outputters/libtexpdf.lua"
    click Cairo "https://github.com/sile-typesetter/sile/blob/master/outputters/cairo.lua"
    click Debug "https://github.com/sile-typesetter/sile/blob/master/outputters/debug.lua"
    click Text "https://github.com/sile-typesetter/sile/blob/master/outputters/text.lua"
    click HarfBuzz "https://github.com/sile-typesetter/sile/blob/master/shapers/harfbuzz.lua"
    click Fallback "https://github.com/sile-typesetter/sile/blob/master/shapers/fallback.lua"
    click BasePackage "https://github.com/sile-typesetter/sile/blob/master/packages/base.lua"
    click MathSupport "https://github.com/sile-typesetter/sile/tree/master/packages/math/"
    click LangSupport "https://github.com/sile-typesetter/sile/tree/master/languages/"
    click LayoutPkgs "https://github.com/sile-typesetter/sile/tree/master/packages/grid/"
    click HarfBuzzLib "https://github.com/sile-typesetter/sile/blob/master/justenough/justenoughharfbuzz.c"
    click FontConfig "https://github.com/sile-typesetter/sile/blob/master/justenough/justenoughfontconfig.c"
    click ICU "https://github.com/sile-typesetter/sile/blob/master/justenough/justenoughicu.c"
    click LibTexPDF "https://github.com/sile-typesetter/sile/blob/master/justenough/justenoughlibtexpdf.c"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Input Components"]:::input
        L3["Output Components"]:::output
        L4["External Dependencies"]:::external
        L5["Font Components"]:::font
        L6["Package Components"]:::package
    end
```
